Package org.ametys.core.user.directory

Class UserDirectoryFactory

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.user.directory.UserDirectoryFactory

All Implemented Interfaces:

LogEnabled, ExtensionPoint<UserDirectoryModel>, Disposable, Initializable, Component, Contextualizable, Serviceable, ThreadSafe

public class UserDirectoryFactory
extends AbstractLogEnabled
implements ExtensionPoint<UserDirectoryModel>, Initializable, ThreadSafe, Component, Serviceable, Contextualizable, Disposable

This extension point handles a list of UserDirectoryModel handled by the plugins.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	UserDirectoryFactory.UserDirectoryModelParameterParser	Class for parsing parameters of a UserDirectoryModel

Field Summary

Fields

Modifier and Type	Field	Description
protected UserDirectoryParameterTypeExtensionPoint	_userDirectoryParameterTypeExtensionPoint	The User Directory parameters Extension Point
static final String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
UserDirectoryFactory()

Method Summary

Modifier and Type	Method	Description
void	addExtension(String id, String pluginName, String featureName, Configuration configuration)	Add an extension to this point.
protected void	addUserDirectoryModel(String pluginName, Configuration configuration)	Add a user directory model
protected void	configureParamChecker(ItemCheckerParser parser, Configuration configuration, String pluginName, Map<String,ItemCheckerDescriptor> parameterCheckers)	Configure a parameter checker of a user directory
protected void	configureParameters(UserDirectoryFactory.UserDirectoryModelParameterParser paramParser, Configuration configuration, String pluginName, Map<String,ElementDefinition> parameters)	Configure a parameter to access the user directory
void	contextualize(Context context)
UserDirectory	createUserDirectory(String id, String modelId, Map<String,Object> paramsValues, String populationId, String label)	Creates a instance of UserDirectory
void	dispose()
UserDirectoryModel	getExtension(String id)	Returns the named extension
Set<String>	getExtensionsIds()	Returns a Set containing the ids of all known extensions
boolean	hasExtension(String id)	Returns true if the named extension exists
void	initialize()
void	initializeExtensions()	Finalize the initialization of the extensions. This method is called after all addExtension() calls. This is the last step before the actual startup of the application.
void	service(ServiceManager smanager)

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 Details

ROLE

public static final String ROLE

The avalon role

_userDirectoryParameterTypeExtensionPoint

protected UserDirectoryParameterTypeExtensionPoint _userDirectoryParameterTypeExtensionPoint

The User Directory parameters Extension Point

Constructor Details

UserDirectoryFactory

public UserDirectoryFactory()

Method Details

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

dispose

public void dispose()

Specified by:

dispose in interface Disposable

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

createUserDirectory

public UserDirectory createUserDirectory(String id,
 String modelId,
 Map<String,Object> paramsValues,
 String populationId,
 String label)

Creates a instance of UserDirectory

Parameters:

modelId - The id of the user directory model

id - A non-null and non-empty unique identifier

paramsValues - The parameters's values

populationId - The id of the population the created user directory belongs to.

label - The directory optional label

Returns:

a user's directory

addExtension

public void addExtension(String id,
 String pluginName,
 String featureName,
 Configuration configuration)
                  throws ConfigurationException

Description copied from interface: ExtensionPoint

Add an extension to this point. Each implementation knows the meaning of the given configuration.

Specified by:

addExtension in interface ExtensionPoint<UserDirectoryModel>

Parameters:

id - the unique identifier of the extension.

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

configuration - the information about the extension to be added

Throws:

ConfigurationException - when a configuration problem occurs

addUserDirectoryModel

protected void addUserDirectoryModel(String pluginName,
 Configuration configuration)
                              throws ConfigurationException

Add a user directory model

Parameters:

pluginName - The plugin name

configuration - The configuration

Throws:

ConfigurationException - when a configuration problem occurs

configureParameters

protected void configureParameters(UserDirectoryFactory.UserDirectoryModelParameterParser paramParser,
 Configuration configuration,
 String pluginName,
 Map<String,ElementDefinition> parameters)
                            throws ConfigurationException

Configure a parameter to access the user directory

Parameters:

paramParser - the parameter parser.

configuration - The parameter configuration.

pluginName - The plugin name

parameters - The model's parameters

Throws:

ConfigurationException - if configuration is incomplete or invalid.

configureParamChecker

protected void configureParamChecker(ItemCheckerParser parser,
 Configuration configuration,
 String pluginName,
 Map<String,ItemCheckerDescriptor> parameterCheckers)
                              throws ConfigurationException

Configure a parameter checker of a user directory

Parameters:

parser - the parameter checker parser.

configuration - The parameter checker configuration.

pluginName - The plugin name

parameterCheckers - The model's parameter checkers

Throws:

ConfigurationException - if configuration is incomplete or invalid.

initializeExtensions

public void initializeExtensions()
                          throws Exception

Description copied from interface: ExtensionPoint

Finalize the initialization of the extensions.
This method is called after all addExtension() calls.
This is the last step before the actual startup of the application.

Specified by:

initializeExtensions in interface ExtensionPoint<UserDirectoryModel>

Throws:

Exception - if something wrong occurs

hasExtension

public boolean hasExtension(String id)

Description copied from interface: ExtensionPoint

Returns true if the named extension exists

Specified by:

hasExtension in interface ExtensionPoint<UserDirectoryModel>

Parameters:

id - the unique id of the extension

Returns:

true if the named extension exists

getExtension

public UserDirectoryModel getExtension(String id)

Description copied from interface: ExtensionPoint

Returns the named extension

Specified by:

getExtension in interface ExtensionPoint<UserDirectoryModel>

Parameters:

id - the unique id of the extension

Returns:

the named extension

getExtensionsIds

public Set<String> getExtensionsIds()

Description copied from interface: ExtensionPoint

Returns a Set containing the ids of all known extensions

Specified by:

getExtensionsIds in interface ExtensionPoint<UserDirectoryModel>

Returns:

a Set containing the ids of all known extensions