org.ametys.core.user.directory

Interface ModifiableUserDirectory

All Superinterfaces:

UserDirectory

All Known Implementing Classes:

JdbcUserDirectory

public interface ModifiableUserDirectory
extends UserDirectory

Abstraction for getting users list and verify the presence of a particular user and finally modifying this list.

Method Summary

Modifier and Type	Method and Description
void	add(Map<String,String> userInformation) Add a new user to the list.
Collection<? extends Parameter<ParameterHelper.ParameterType>>	getModel() Get the user's edition model as a Collection of parameters.
void	remove(String login) Remove an user from the list.
void	update(Map<String,String> userInformation) Modify informations about an user of the list.
Map<String,Errors>	validate(Map<String,String> userInformation) Validate user information.

Methods inherited from interface org.ametys.core.user.directory.UserDirectory

checkCredentials, getId, getLabel, getParameterValues, getPopulationId, getUser, getUserDirectoryModelId, getUsers, getUsers, init, setPopulationId

Method Detail

add

void add(Map<String,String> userInformation)
  throws InvalidModificationException

Add a new user to the list.

Parameters:

userInformation - Informations about the user, see implementation. Cannot be null.

Throws:

InvalidModificationException - if the login exists yet or if at least one of the parameter is invalid.

update

void update(Map<String,String> userInformation)
     throws InvalidModificationException

Modify informations about an user of the list.

Parameters:

userInformation - New informations about the user, see implementation. Cannot be null.

Throws:

InvalidModificationException - if the login does not match in the list or if at least one of the parameter is invalid.

remove

void remove(String login)
     throws InvalidModificationException

Remove an user from the list.

Parameters:

login - The user's login. Cannot be null.

Throws:

InvalidModificationException - if the user cannot be removed

validate

Map<String,Errors> validate(Map<String,String> userInformation)

Validate user information.

Parameters:

userInformation - Informations about the user, see implementation. Cannot be null.

Returns:

validation errors.

getModel

Collection<? extends Parameter<ParameterHelper.ParameterType>> getModel()

Get the user's edition model as a Collection of parameters.

Returns:

the user's edition model as a Collection of parameters.