org.ametys.plugins.core.user

Class UserDAO

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.core.user.UserDAO

All Implemented Interfaces:

Component, Contextualizable, LogEnabled, Serviceable

public class UserDAO
extends AbstractLogEnabled
implements Component, Contextualizable, Serviceable

DAO for manipulating User

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserDAO.ImpersonateCredentialProvider A fake credential provider used by the impersonate process

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	_context The Avalon context
protected CurrentUserProvider	_currentUserProvider The current user provider.
protected RightManager	_rightManager The right manager
protected ServiceManager	_smanager The service manager
protected UserHelper	_userHelper The user helper
protected UserManager	_userManager The user manager
protected UserPopulationDAO	_userPopulationDAO The user population DAO
static String	ROLE The avalon role

Constructor Summary

Constructors

Constructor and Description
UserDAO()

Method Summary

Modifier and Type	Method and Description
private void	_deleteUser(String login, String populationId)
protected UserIdentity	_getCurrentUser() Provides the login of the current user.
private Map<String,Object>	_getEditionModel(UserDirectory userDirectory)
Map<String,Object>	addUser(String populationId, String userDirectoryId, Map<String,String> untypedValues) Creates a User
void	contextualize(Context context)
void	deleteUsers(List<Map<String,String>> users) Deletes users
Map<String,Object>	editUser(String populationId, Map<String,String> untypedValues) Edits a User
Map<String,Object>	getEditionModelForDirectory(String populationId, String userDirectoryId) Get the users edition model
Map<String,Object>	getEditionModelForUSer(String login, String populationId) Get the users edition model
Map<String,Object>	getUser(String login, String populationId) Get user's information
Map<String,String>	impersonate(String login, String populationId) Impersonate the selected user
Map<String,Object>	isModifiable(String login, String populationId) Checks if the user is modifiable
Map<String,Object>	isRemovable(String login, String populationId) Checks if the user is removable
void	service(ServiceManager smanager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROLE

public static final String ROLE

The avalon role

_smanager

protected ServiceManager _smanager

The service manager

_userManager

protected UserManager _userManager

The user manager

_userPopulationDAO

protected UserPopulationDAO _userPopulationDAO

The user population DAO

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider.

_context

protected Context _context

The Avalon context

_userHelper

protected UserHelper _userHelper

The user helper

_rightManager

protected RightManager _rightManager

The right manager

Constructor Detail

UserDAO

public UserDAO()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getUser

public Map<String,Object> getUser(String login,
                                  String populationId)

Get user's information

Parameters:

login - The user's login

populationId - The id of the population

Returns:

The user's information

isModifiable

public Map<String,Object> isModifiable(String login,
                                       String populationId)

Checks if the user is modifiable

Parameters:

login - The users's login

populationId - The id of the population of the user

Returns:

A map with the "isModifiable" at true if the user is modifiable

isRemovable

public Map<String,Object> isRemovable(String login,
                                      String populationId)

Checks if the user is removable

Parameters:

login - The users's login

populationId - The id of the population of the user

Returns:

A map with the "isRemovable" at true if the user is removable

addUser

public Map<String,Object> addUser(String populationId,
                                  String userDirectoryId,
                                  Map<String,String> untypedValues)
                           throws InvalidModificationException

Creates a User

Parameters:

populationId - The id of the user population

userDirectoryId - The id of the user directory

untypedValues - The untyped user's parameters

Returns:

The created user as JSON object

Throws:

InvalidModificationException - If modification is not possible

editUser

public Map<String,Object> editUser(String populationId,
                                   Map<String,String> untypedValues)
                            throws InvalidModificationException

Edits a User

Parameters:

populationId - The id of the population of the user to edit

untypedValues - The untyped user's parameters

Returns:

The update user as JSON object

Throws:

InvalidModificationException - If modification is not possible

deleteUsers

public void deleteUsers(List<Map<String,String>> users)
                 throws InvalidModificationException

Deletes users

Parameters:

users - The users to delete

Throws:

InvalidModificationException - If modification is not possible

_deleteUser

private void _deleteUser(String login,
                         String populationId)
                  throws InvalidModificationException

Throws:

InvalidModificationException

getEditionModelForUSer

public Map<String,Object> getEditionModelForUSer(String login,
                                                 String populationId)
                                          throws InvalidModificationException,
                                                 ProcessingException

Get the users edition model

Parameters:

login - The user's login to edit

populationId - The id of the population of the user to edit

Returns:

The edition model as an object

Throws:

InvalidModificationException - If modification is not possible

ProcessingException - If there is another exception

getEditionModelForDirectory

public Map<String,Object> getEditionModelForDirectory(String populationId,
                                                      String userDirectoryId)
                                               throws InvalidModificationException,
                                                      ProcessingException

Get the users edition model

Parameters:

populationId - The id of the population where to add a user

userDirectoryId - The id of the user directory where to add a user

Returns:

The edition model as an object

Throws:

InvalidModificationException - If modification is not possible

ProcessingException - If there is another exception

_getEditionModel

private Map<String,Object> _getEditionModel(UserDirectory userDirectory)
                                     throws InvalidModificationException,
                                            ProcessingException

Throws:

InvalidModificationException

ProcessingException

impersonate

public Map<String,String> impersonate(String login,
                                      String populationId)
                               throws AccessDeniedException

Impersonate the selected user

Parameters:

login - the login of the user to impersonate

populationId - The id of the population

Returns:

a map of information on the user

Throws:

AccessDeniedException - If the currently connected user has no right to do so

_getCurrentUser

protected UserIdentity _getCurrentUser()

Provides the login of the current user.

Returns:

the login which cannot be null.