org.ametys.core.user.population

Class UserPopulationDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.user.population.UserPopulationDAO

All Implemented Interfaces:

LogEnabled, Disposable, Initializable, Component, Serviceable

public class UserPopulationDAO
extends AbstractLogEnabled
implements Component, Serviceable, Initializable, Disposable

DAO for accessing UserPopulation

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__ADMIN_TABLENAME The sql table for admin users
private static String	__ID_REGEX The regular expression for an id of a user population
private static File	__USER_POPULATIONS_FILE The path of the XML file containing the user populations
private UserPopulation	_adminUserPopulation The population admin
private CredentialProviderFactory	_credentialProviderFactory The credential providers factory
private CurrentUserProvider	_currentUserProvider
private I18nUtils	_i18nutils
private Set<String>	_ignoredPopulations The list of population ids which are declared in the user population file but were not instanciated since their configuration led to an error
private long	_lastFileReading The date (as a long) of the last time the Populations file was read (last update)
private Set<String>	_misconfiguredUserPopulations The misconfigured user populations
private ObservationManager	_observationManager
private PopulationConsumerExtensionPoint	_populationConsumerEP The extension point for population consumers
private UserDirectoryFactory	_userDirectoryFactory The user directories factory
private Map<String,UserPopulation>	_userPopulations The whole user populations of the application
static String	ADMIN_POPULATION_ID The id of the "admin" population
static String	ROLE Avalon Role
static UserIdentity	SYSTEM_USER_IDENTITY The id of the "user system" population
static String	SYSTEM_USER_LOGIN The id of the "user system" login

Constructor Summary

Constructors

Constructor and Description
UserPopulationDAO()

Method Summary

Modifier and Type	Method and Description
private List<CredentialProvider>	_configureCredentialProviders(Configuration configuration, String upId)
private void	_configurePopulation(Configuration configuration)
private List<UserDirectory>	_configureUserDirectories(Configuration configuration, String upId)
private void	_createPopulationsFile(File file)
private void	_fillUserPopulation(UserPopulation up, I18nizableText label, List<Map<String,String>> userDirectories, List<Map<String,String>> credentialProviders)
private Map<String,Object>	_getCPParametersFromConfiguration(Configuration conf, String modelId, String populationId) Get the typed parameters of a credential provider used by a population
private Map<String,Object>	_getTypedCPParameters(Map<String,String> parameters, String modelId)
private Map<String,Object>	_getTypedUDParameters(Map<String,String> parameters, String modelId)
private Map<String,Object>	_getUDParametersFromConfiguration(Configuration conf, String modelId, String populationId) Get the typed parameters of a user directory used by a population
private boolean	_isCorrectId(String id)
private void	_keepExistingCredentialProviderPassword(UserPopulation up, String modelId, Map<String,Object> typedParamValues, String id)
private void	_keepExistingUserDirectoryPassword(UserPopulation up, String modelId, Map<String,Object> typedParamValues, String id)
private void	_readPopulations(boolean forceRead) If needed, reads the config file representing the populations and then reinitializes and updates the internal representation of the populations.
private void	_saxUserPopulation(UserPopulation userPopulation, TransformerHandler handler)
private void	_toSAX(TransformerHandler handler)
private boolean	_writePopulations() Erases the config file representing the populations and rebuild it from the internal representation of the populations.
Map<String,Object>	add(String id, String label, List<Map<String,String>> userDirectories, List<Map<String,String>> credentialProviders) Adds a new population
Map<String,Object>	canRemove(String populationId) Determines if a population can be removed
void	dispose()
Map<String,Object>	edit(String id, String label, List<Map<String,String>> userDirectories, List<Map<String,String>> credentialProviders) Edits the given population.
Map<String,Object>	enable(String populationId, boolean enabled) Enables/Disables the given population
UserPopulation	getAdminPopulation() Gets the "admin" population
InputStream	getConfigurationFile() Return the stream of the configuration file
Map<String,Object>	getEditionConfiguration() Gets the configuration for creating/editing a user population.
List<UserPopulation>	getEnabledUserPopulations(boolean withAdmin) Gets all the enabled populations of this application
Set<String>	getIgnoredPopulations() Returns the id of population which have a fatal invalid configuration.
Set<String>	getMisconfiguredPopulations() Returns the id of population which have at least one user directory or one credential provider misconfigured These populations can be used by application.
Map<String,Object>	getPopulationParameterValues(String id) Gets the values of the parameters of the given population
UserPopulation	getUserPopulation(String id) Gets a population with its id.
Map<String,Object>	getUserPopulationAsJson(UserPopulation userPopulation) Gets a population to JSON format
List<UserPopulation>	getUserPopulations(boolean includeAdminPopulation) Gets all the populations of this application
List<Object>	getUserPopulationsAsJson(boolean withAdmin) Gets all the populations to JSON format
List<String>	getUserPopulationsIds() Gets the list of the ids of all the population of the application
void	initialize()
Map<String,Object>	isEnabled(String populationId) Returns the enabled state of the given population
boolean	isValid(String populationId) Determines if a population has a valid configuration
Map<String,Object>	remove(String id) Removes the given population.
Map<String,Object>	remove(String id, boolean forceDeletion) Removes the given population.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

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

Avalon Role

ADMIN_POPULATION_ID

public static final String ADMIN_POPULATION_ID

The id of the "admin" population

See Also:

Constant Field Values

SYSTEM_USER_LOGIN

public static final String SYSTEM_USER_LOGIN

The id of the "user system" login

See Also:

Constant Field Values

SYSTEM_USER_IDENTITY

public static final UserIdentity SYSTEM_USER_IDENTITY

The id of the "user system" population

__ADMIN_TABLENAME

private static final String __ADMIN_TABLENAME

The sql table for admin users

See Also:

Constant Field Values

__USER_POPULATIONS_FILE

private static final File __USER_POPULATIONS_FILE

The path of the XML file containing the user populations

__ID_REGEX

private static final String __ID_REGEX

The regular expression for an id of a user population

See Also:

Constant Field Values

_lastFileReading

private long _lastFileReading

The date (as a long) of the last time the Populations file was read (last update)

_userPopulations

private Map<String,UserPopulation> _userPopulations

The whole user populations of the application

_misconfiguredUserPopulations

private Set<String> _misconfiguredUserPopulations

The misconfigured user populations

_ignoredPopulations

private Set<String> _ignoredPopulations

The list of population ids which are declared in the user population file but were not instanciated since their configuration led to an error

_adminUserPopulation

private UserPopulation _adminUserPopulation

The population admin

_userDirectoryFactory

private UserDirectoryFactory _userDirectoryFactory

The user directories factory

_credentialProviderFactory

private CredentialProviderFactory _credentialProviderFactory

The credential providers factory

_populationConsumerEP

private PopulationConsumerExtensionPoint _populationConsumerEP

The extension point for population consumers

_observationManager

private ObservationManager _observationManager

_currentUserProvider

private CurrentUserProvider _currentUserProvider

_i18nutils

private I18nUtils _i18nutils

Constructor Detail

UserPopulationDAO

public UserPopulationDAO()

Method Detail

initialize

public void initialize()

Specified by:

initialize in interface Initializable

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getUserPopulationsAsJson

public List<Object> getUserPopulationsAsJson(boolean withAdmin)

Gets all the populations to JSON format

Parameters:

withAdmin - True to include the "admin" population

Returns:

A list of object representing the UserPopulations

getUserPopulationAsJson

public Map<String,Object> getUserPopulationAsJson(UserPopulation userPopulation)

Gets a population to JSON format

Parameters:

userPopulation - The user population to get

Returns:

An object representing a UserPopulation

getUserPopulations

public List<UserPopulation> getUserPopulations(boolean includeAdminPopulation)

Gets all the populations of this application

Parameters:

includeAdminPopulation - True to include the "admin" population

Returns:

A list of UserPopulation

getEnabledUserPopulations

public List<UserPopulation> getEnabledUserPopulations(boolean withAdmin)

Gets all the enabled populations of this application

Parameters:

withAdmin - True to include the "admin" population

Returns:

A list of enabled UserPopulation

getUserPopulation

public UserPopulation getUserPopulation(String id)

Gets a population with its id.

Parameters:

id - The id of the population

Returns:

The UserPopulation, or null if not found

getUserPopulationsIds

public List<String> getUserPopulationsIds()

Gets the list of the ids of all the population of the application

Returns:

The list of the ids of all the populations

getIgnoredPopulations

public Set<String> getIgnoredPopulations()

Returns the id of population which have a fatal invalid configuration. These populations can NOT be used by application.

Returns:

The ignored populations

getMisconfiguredPopulations

public Set<String> getMisconfiguredPopulations()

Returns the id of population which have at least one user directory or one credential provider misconfigured These populations can be used by application.

Returns:

The misconfigured populations.

getConfigurationFile

public InputStream getConfigurationFile()

Return the stream of the configuration file

Returns:

The input stream to be closed.

getEditionConfiguration

public Map<String,Object> getEditionConfiguration()
                                           throws Exception

Gets the configuration for creating/editing a user population.

Returns:

A map containing information about what is needed to create/edit a user population

Throws:

Exception - If an error occurs.

getPopulationParameterValues

public Map<String,Object> getPopulationParameterValues(String id)

Gets the values of the parameters of the given population

Parameters:

id - The id of the population

Returns:

The values of the parameters

getAdminPopulation

public UserPopulation getAdminPopulation()

Gets the "admin" population

Returns:

The "admin" population

add

public Map<String,Object> add(String id,
                              String label,
                              List<Map<String,String>> userDirectories,
                              List<Map<String,String>> credentialProviders)

Adds a new population

Parameters:

id - The unique id of the population

label - The label of the population

userDirectories - A list of user directory parameters

credentialProviders - A list of credential provider parameters

Returns:

A map containing the id of the created population, or the kind of error that occured

_isCorrectId

private boolean _isCorrectId(String id)

edit

public Map<String,Object> edit(String id,
                               String label,
                               List<Map<String,String>> userDirectories,
                               List<Map<String,String>> credentialProviders)

Edits the given population.

Parameters:

id - The id of the population to edit

label - The label of the population

userDirectories - A list of user directory parameters

credentialProviders - A list of credential provider parameters

Returns:

A map containing the id of the edited population, or the kind of error that occured

_fillUserPopulation

private void _fillUserPopulation(UserPopulation up,
                                 I18nizableText label,
                                 List<Map<String,String>> userDirectories,
                                 List<Map<String,String>> credentialProviders)

_keepExistingUserDirectoryPassword

private void _keepExistingUserDirectoryPassword(UserPopulation up,
                                                String modelId,
                                                Map<String,Object> typedParamValues,
                                                String id)

_keepExistingCredentialProviderPassword

private void _keepExistingCredentialProviderPassword(UserPopulation up,
                                                     String modelId,
                                                     Map<String,Object> typedParamValues,
                                                     String id)

_getTypedUDParameters

private Map<String,Object> _getTypedUDParameters(Map<String,String> parameters,
                                                 String modelId)

_getTypedCPParameters

private Map<String,Object> _getTypedCPParameters(Map<String,String> parameters,
                                                 String modelId)

remove

public Map<String,Object> remove(String id)

Removes the given population.

Parameters:

id - The id of the population to remove

Returns:

A map containing the id of the removed population

remove

public Map<String,Object> remove(String id,
                                 boolean forceDeletion)

Removes the given population.

Parameters:

id - The id of the population to remove

forceDeletion - Delete the population even if it is still in use

Returns:

A map containing the id of the removed population

enable

public Map<String,Object> enable(String populationId,
                                 boolean enabled)

Enables/Disables the given population

Parameters:

populationId - The id of the population to enable/disable

enabled - True to enable the population, false to disable it.

Returns:

A map containing the id of the enabled/disabled population, or with an error.

isValid

public boolean isValid(String populationId)

Determines if a population has a valid configuration

Parameters:

populationId - The id of the population to retrieve state

Returns:

A map, with the response as a boolean, or an error.

isEnabled

public Map<String,Object> isEnabled(String populationId)

Returns the enabled state of the given population

Parameters:

populationId - The id of the population to retrieve state

Returns:

A map, with the response as a booolean, or an error.

canRemove

public Map<String,Object> canRemove(String populationId)

Determines if a population can be removed

Parameters:

populationId - The id of the population

Returns:

A map, with the response as a boolean, or an error.

_readPopulations

private void _readPopulations(boolean forceRead)

If needed, reads the config file representing the populations and then reinitializes and updates the internal representation of the populations.

Parameters:

forceRead - True to avoid the use of the cache and force the reading of the file

_createPopulationsFile

private void _createPopulationsFile(File file)
                             throws IOException,
                                    TransformerConfigurationException,
                                    SAXException

Throws:

IOException

TransformerConfigurationException

SAXException

_configurePopulation

private void _configurePopulation(Configuration configuration)
                           throws ConfigurationException

Throws:

ConfigurationException

_configureUserDirectories

private List<UserDirectory> _configureUserDirectories(Configuration configuration,
                                                      String upId)
                                               throws ConfigurationException

Throws:

ConfigurationException

_configureCredentialProviders

private List<CredentialProvider> _configureCredentialProviders(Configuration configuration,
                                                               String upId)
                                                        throws ConfigurationException

Throws:

ConfigurationException

_getUDParametersFromConfiguration

private Map<String,Object> _getUDParametersFromConfiguration(Configuration conf,
                                                             String modelId,
                                                             String populationId)
                                                      throws ConfigurationException,
                                                             IllegalArgumentException

Get the typed parameters of a user directory used by a population

Parameters:

conf - The user directory's configuration.

modelId - The id of user directory model

populationId - The id of population

Returns:

The typed parameters

Throws:

IllegalArgumentException - if the configured user directory references a non-existing user directory model

ConfigurationException - if a parameter is missing

_getCPParametersFromConfiguration

private Map<String,Object> _getCPParametersFromConfiguration(Configuration conf,
                                                             String modelId,
                                                             String populationId)
                                                      throws ConfigurationException,
                                                             IllegalArgumentException

Get the typed parameters of a credential provider used by a population

Parameters:

conf - The credential provider's configuration.

modelId - The id of credential provider model

populationId - The id of population

Returns:

The typed parameters

Throws:

IllegalArgumentException - if the configured credential provider references a non-existing credential provider model

ConfigurationException - if a parameter is missing

_writePopulations

private boolean _writePopulations()

Erases the config file representing the populations and rebuild it from the internal representation of the populations.

Returns:

True if an error occured

_toSAX

private void _toSAX(TransformerHandler handler)

_saxUserPopulation

private void _saxUserPopulation(UserPopulation userPopulation,
                                TransformerHandler handler)

dispose

public void dispose()

Specified by:

dispose in interface Disposable