org.sonar.api.security
Class ExternalUsersProvider

java.lang.Object
  extended by org.sonar.api.security.ExternalUsersProvider

public abstract class ExternalUsersProvider
extends Object

Note that prefix "do" for names of methods is reserved for future enhancements, thus should not be used in subclasses.

Since:
2.14
See Also:
SecurityRealm

Nested Class Summary
static class ExternalUsersProvider.Context
           
 
Constructor Summary
ExternalUsersProvider()
           
 
Method Summary
 UserDetails doGetUserDetails(ExternalUsersProvider.Context context)
          Override this method in order load user information.
 UserDetails doGetUserDetails(String username)
          Deprecated. replaced by doGetUserDetails(org.sonar.api.security.ExternalUsersProvider.Context) since v. 3.1
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ExternalUsersProvider

public ExternalUsersProvider()
Method Detail

doGetUserDetails

@Deprecated
public UserDetails doGetUserDetails(@Nullable
                                               String username)
Deprecated. replaced by doGetUserDetails(org.sonar.api.security.ExternalUsersProvider.Context) since v. 3.1

This method is overridden by old versions of plugins such as LDAP 1.1. It should not be overridden anymore.

Parameters:
username - the username
Returns:
details for specified user, or null if such user doesn't exist
Throws:
RuntimeException - in case of unexpected error such as connection failure

doGetUserDetails

public UserDetails doGetUserDetails(ExternalUsersProvider.Context context)
Override this method in order load user information.

Returns:
the user, or null if user doesn't exist
Throws:
RuntimeException - in case of unexpected error such as connection failure
Since:
3.1


Copyright © 2009-2014 SonarSource. All Rights Reserved.