public interface UserDirectory
Modifier and Type | Method and Description |
---|---|
boolean |
checkCredentials(String login,
String password)
Authenticate a user with its credentials
|
String |
getId()
A unique identifier
|
String |
getLabel()
Get the label of the CredentialProvider
|
Map<String,Object> |
getParameterValues()
Get the values of parameters (from user directory model)
|
String |
getPopulationId()
Get the id of the population this user directory belongs to.
|
User |
getUser(String login)
Get a particular user by his login.
|
String |
getUserDirectoryModelId()
Get the id of the
UserDirectoryModel extension point |
Collection<User> |
getUsers()
Get the list of all users of one directory.
|
List<User> |
getUsers(int count,
int offset,
Map<String,Object> parameters)
Get a list of users from a directory given the parameters
|
void |
init(String id,
String udModelId,
Map<String,Object> paramValues,
String label)
Initialize the user's directory with given parameters' values.
|
void |
setPopulationId(String populationId)
Set the value of the id of the population this user directory belong to.
|
Collection<User> getUsers()
User
s, empty if a problem occurs.List<User> getUsers(int count, int offset, Map<String,Object> parameters)
count
- The limit of users to retrieveoffset
- The number of result to ignore before starting to collect users.parameters
- A map of additional parameters, see implementation.User
User getUser(String login)
login
- Login of the user to get. Cannot be null.User
instance or null if the user login does not exist.String getUserDirectoryModelId()
UserDirectoryModel
extension pointMap<String,Object> getParameterValues()
void init(String id, String udModelId, Map<String,Object> paramValues, String label) throws Exception
id
- The non-null and non-empty unique identifierudModelId
- The id of user directory extension pointparamValues
- The parameters' valueslabel
- The optional labelException
- If an error occurredvoid setPopulationId(String populationId)
populationId
- The id of the population the user directory belongs to.String getPopulationId()
boolean checkCredentials(String login, String password)
login
- The login to check. Cannot be null.password
- The password to check.