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
75
76
77
78
79
80
81
|
/*
* SonarQube
* Copyright (C) 2009-2019 SonarSource SA
* mailto:info 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 org.sonar.api.ExtensionPoint;
import org.sonar.api.server.ServerSide;
/**
* @since 2.14
*/
@ServerSide
@ExtensionPoint
public abstract class SecurityRealm {
/**
* @return unique name of this realm, e.g. "ldap"
*/
public String getName() {
return getClass().getSimpleName();
}
/**
* Invoked during server startup and can be used to initialize internal state.
*/
public void init() {
}
/**
* @return {@link LoginPasswordAuthenticator} associated with this realm, never null
* @deprecated replaced by doGetAuthenticator in version 3.1
*/
@Deprecated
public LoginPasswordAuthenticator getLoginPasswordAuthenticator() {
return null;
}
/**
* @since 3.1
*/
public Authenticator doGetAuthenticator() {
// this method is not overridden when deprecated getLoginPasswordAuthenticator
// is used
return new Authenticator() {
@Override
public boolean doAuthenticate(Context context) {
return getLoginPasswordAuthenticator().authenticate(context.getUsername(), context.getPassword());
}
};
}
/**
* @return {@link ExternalUsersProvider} associated with this realm, null if not supported
*/
public ExternalUsersProvider getUsersProvider() {
return null;
}
/**
* @return {@link ExternalGroupsProvider} associated with this realm, null if not supported
*/
public ExternalGroupsProvider getGroupsProvider() {
return null;
}
}
|
