ExternalUsersProvider (sonar-plugin-api 8.9)

java.lang.Object
- org.sonar.api.security.ExternalUsersProvider

```
public abstract class ExternalUsersProvider
extends java.lang.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

Nested Classes
Modifier and Type Class Description

static class ExternalUsersProvider.Context

Constructor Summary

Constructors
Constructor Description

ExternalUsersProvider()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`UserDetails`	`doGetUserDetails(java.lang.String username)`	Deprecated. replaced by `doGetUserDetails(org.sonar.api.security.ExternalUsersProvider.Context)` since v.
`UserDetails`	`doGetUserDetails(ExternalUsersProvider.Context context)`	Override this method in order load user information.

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
                                    java.lang.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:
    
    java.lang.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:
    
    java.lang.RuntimeException - in case of unexpected error such as connection failure
    
    Since:
    
    3.1