1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
/*
* SonarQube :: Plugin API
* Copyright (C) 2009-2016 SonarSource SA
* mailto:contact AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.security;
import javax.annotation.Nullable;
import javax.servlet.http.HttpServletRequest;
/**
* Note that prefix "do" for names of methods is reserved for future enhancements, thus should not be used in subclasses.
*
* @see SecurityRealm
* @since 2.14
*/
public abstract class ExternalUsersProvider {
/**
* This method is overridden by old versions of plugins such as LDAP 1.1. It should not be overridden anymore.
*
* @param username the username
* @return details for specified user, or null if such user doesn't exist
* @throws RuntimeException in case of unexpected error such as connection failure
* @deprecated replaced by {@link #doGetUserDetails(org.sonar.api.security.ExternalUsersProvider.Context)} since v. 3.1
*/
@Deprecated
public UserDetails doGetUserDetails(@Nullable String username) {
return null;
}
/**
* Override this method in order load user information.
*
* @return the user, or null if user doesn't exist
* @throws RuntimeException in case of unexpected error such as connection failure
* @since 3.1
*/
public UserDetails doGetUserDetails(Context context) {
return doGetUserDetails(context.getUsername());
}
public static final class Context {
private String username;
private HttpServletRequest request;
public Context(@Nullable String username, HttpServletRequest request) {
this.username = username;
this.request = request;
}
public String getUsername() {
return username;
}
public HttpServletRequest getRequest() {
return request;
}
}
}
|
