public class UserDirectoryFactory extends AbstractLogEnabled implements ExtensionPoint<UserDirectoryModel>, Initializable, ThreadSafe, Component, Serviceable, Contextualizable, Disposable
UserDirectoryModel
handled by the plugins.Modifier and Type | Class and Description |
---|---|
class |
UserDirectoryFactory.UserDirectoryModelParameterParser
Class for parsing parameters of a
UserDirectoryModel |
Modifier and Type | Field and Description |
---|---|
private Context |
_context |
private ServiceManager |
_smanager |
private Map<String,UserDirectoryModel> |
_udModels |
static String |
ROLE
The avalon role
|
Constructor and Description |
---|
UserDirectoryFactory() |
Modifier and Type | Method and 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(ParameterCheckerParser parser,
Configuration configuration,
String pluginName,
Map<String,ParameterCheckerDescriptor> parameterCheckers)
Configure a parameter checker of a user directory
|
protected void |
configureParameters(UserDirectoryFactory.UserDirectoryModelParameterParser paramParser,
Configuration configuration,
String pluginName,
Map<String,Parameter<ParameterHelper.ParameterType>> 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) |
getLogger, setLogger
private Map<String,UserDirectoryModel> _udModels
private ServiceManager _smanager
public UserDirectoryFactory()
public void initialize() throws Exception
initialize
in interface Initializable
Exception
public void dispose()
dispose
in interface Disposable
public void service(ServiceManager smanager) throws ServiceException
service
in interface Serviceable
ServiceException
public void contextualize(Context context) throws ContextException
contextualize
in interface Contextualizable
ContextException
public UserDirectory createUserDirectory(String id, String modelId, Map<String,Object> paramsValues, String populationId, String label)
UserDirectory
modelId
- The id of the user directory modelid
- A non-null and non-empty unique identifierparamsValues
- The parameters's valuespopulationId
- The id of the population the created user directory belongs to.label
- The directory optional labelpublic void addExtension(String id, String pluginName, String featureName, Configuration configuration) throws ConfigurationException
ExtensionPoint
addExtension
in interface ExtensionPoint<UserDirectoryModel>
id
- the unique identifier of the extension.pluginName
- Unique identifier for the plugin hosting the extensionfeatureName
- Unique feature identifier (unique for a given pluginName)configuration
- the information about the extension to be addedConfigurationException
- when a configuration problem occursprotected void addUserDirectoryModel(String pluginName, Configuration configuration) throws ConfigurationException
pluginName
- The plugin nameconfiguration
- The configurationConfigurationException
- when a configuration problem occursprotected void configureParameters(UserDirectoryFactory.UserDirectoryModelParameterParser paramParser, Configuration configuration, String pluginName, Map<String,Parameter<ParameterHelper.ParameterType>> parameters) throws ConfigurationException
paramParser
- the parameter parser.configuration
- The parameter configuration.pluginName
- The plugin nameparameters
- The model's parametersConfigurationException
- if configuration is incomplete or invalid.protected void configureParamChecker(ParameterCheckerParser parser, Configuration configuration, String pluginName, Map<String,ParameterCheckerDescriptor> parameterCheckers) throws ConfigurationException
parser
- the parameter checker parser.configuration
- The parameter checker configuration.pluginName
- The plugin nameparameterCheckers
- The model's parameter checkersConfigurationException
- if configuration is incomplete or invalid.public void initializeExtensions() throws Exception
ExtensionPoint
addExtension()
calls.initializeExtensions
in interface ExtensionPoint<UserDirectoryModel>
Exception
- if something wrong occurspublic boolean hasExtension(String id)
ExtensionPoint
hasExtension
in interface ExtensionPoint<UserDirectoryModel>
id
- the unique id of the extensionpublic UserDirectoryModel getExtension(String id)
ExtensionPoint
getExtension
in interface ExtensionPoint<UserDirectoryModel>
id
- the unique id of the extensionpublic Set<String> getExtensionsIds()
ExtensionPoint
getExtensionsIds
in interface ExtensionPoint<UserDirectoryModel>