org.ametys.runtime.config

Class ConfigManager

java.lang.Object

org.ametys.runtime.config.ConfigManager

All Implemented Interfaces:

Initializable, Contextualizable, Serviceable

public final class ConfigManager
extends Object
implements Contextualizable, Serviceable, Initializable

This manager handle the parameters of the application that have to be stored by the plugins.

Field Summary

Fields

Modifier and Type	Field and Description
private static ConfigManager	__manager
private Map<I18nizableText,ConfigParameterCategory>	_categorizedParameters
private Context	_context
private Map<String,ConfigParameterInfo>	_declaredParameterCheckers
private Map<String,ConfigParameterInfo>	_declaredParams
private ThreadSafeComponentManager<Enumerator>	_enumeratorManager
private boolean	_isComplete
private boolean	_isInitialized
(package private) Logger	_logger
private ServiceManager	_manager
private ThreadSafeComponentManager<ParameterChecker>	_parameterCheckerManager
private Map<String,ConfigParameterCheckerDescriptor>	_parameterCheckers
private Map<String,ConfigParameter>	_params
private Collection<String>	_usedParamsName
private ThreadSafeComponentManager<Validator>	_validatorManager
static Pattern	CONFIG_ID_PATTERN the regular expression for ids
private static String	FIELD_SEPARATOR The field separator for the field hierarchy

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ConfigManager()

Method Summary

Modifier and Type	Method and Description
private Map<String,Object>	_bindAndValidateParameters(Map<String,String> untypedValues, Map<String,String> oldUntypedValues, Map<String,Errors> errorFields) Bind all parameters to typed values and for each, if enabled, validate it
private Map<I18nizableText,ConfigParameterCategory>	_categorizeParameters(Map<String,ConfigParameter> params, Map<String,ConfigParameterCheckerDescriptor> paramCheckers)
private boolean	_evaluateCondition(DisableCondition condition, Map<String,String> untypedValues)
private Object	_getValue(String paramID, ParameterHelper.ParameterType type, Map<String,String> untypedValues)
private void	_toSAX(TransformerHandler handler, Map<String,Object> typedValues) SAX the config values into a content handler
private Object	_validateParameter(Map<String,String> untypedValues, ConfigParameter parameter)
private void	_validateParameters(Map<String,String> untypedValues)
void	addConfig(String featureId, Map<String,ConfigParameterInfo> parameters, Collection<String> parametersReferences, Map<String,ConfigParameterInfo> paramCheckers) Registers a new parameter or references a globalConfig parameter.
void	addGlobalConfig(String pluginName, Map<String,ConfigParameterInfo> parameters, Map<String,ConfigParameterInfo> paramCheckers) Registers new available parameters. The addConfig() method allows to select which ones are actually useful.
void	contextualize(Context context)
void	dispose() Dispose the manager before restarting it
boolean	evaluateDisableConditions(DisableConditions disableConditions, Map<String,String> untypedValues) Recursively evaluate the DisableConditions against the configuration values
ConfigParameter	get(String id) Gets the config parameter by its id
Map<I18nizableText,ConfigParameterCategory>	getCategories() Returns all ConfigParameter grouped by categories and groups.
static ConfigManager	getInstance() Returns the shared instance of the PluginManager
ConfigParameterCheckerDescriptor	getParameterChecker(String id) Gets the parameter checker with its id
Map<String,ConfigParameterCheckerDescriptor>	getParameterCheckers() Returns all ConfigParameterCheckerDescriptors.
Map<String,ConfigParameter>	getParameters() Gets the typed configuration parameters
String[]	getParametersIds() Get the id of the config parameters.
Map<String,Object>	getValues() Returns typed config values.
void	initialize()
boolean	isComplete() Returns true if the model is initialized and all parameters are valued
boolean	isEmpty() Returns true if the config file does not exist
Map<String,Errors>	save(Map<String,String> untypedValues, String fileName) Update the configuration file with the given values Values are untyped (all are of type String) and might be null.
void	service(ServiceManager manager)
void	validate() Ends the initialization of the config parameters, by checking against the already valued parameters. If at least one parameter has no value, the application won't start.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_ID_PATTERN

public static final Pattern CONFIG_ID_PATTERN

the regular expression for ids

FIELD_SEPARATOR

private static final String FIELD_SEPARATOR

The field separator for the field hierarchy

See Also:

Constant Field Values

__manager

private static ConfigManager __manager

_logger

Logger _logger

_manager

private ServiceManager _manager

_context

private Context _context

_usedParamsName

private Collection<String> _usedParamsName

_declaredParams

private Map<String,ConfigParameterInfo> _declaredParams

_params

private Map<String,ConfigParameter> _params

_declaredParameterCheckers

private Map<String,ConfigParameterInfo> _declaredParameterCheckers

_parameterCheckers

private Map<String,ConfigParameterCheckerDescriptor> _parameterCheckers

_categorizedParameters

private Map<I18nizableText,ConfigParameterCategory> _categorizedParameters

_isInitialized

private boolean _isInitialized

_isComplete

private boolean _isComplete

_validatorManager

private ThreadSafeComponentManager<Validator> _validatorManager

_enumeratorManager

private ThreadSafeComponentManager<Enumerator> _enumeratorManager

_parameterCheckerManager

private ThreadSafeComponentManager<ParameterChecker> _parameterCheckerManager

Constructor Detail

ConfigManager

private ConfigManager()

Method Detail

getInstance

public static ConfigManager getInstance()

Returns the shared instance of the PluginManager

Returns:

the shared instance of the PluginManager

isComplete

public boolean isComplete()

Returns true if the model is initialized and all parameters are valued

Returns:

true if the model is initialized and all parameters are valued

isEmpty

public boolean isEmpty()

Returns true if the config file does not exist

Returns:

true if the config file does not exist

contextualize

public void contextualize(Context context)

Specified by:

contextualize in interface Contextualizable

service

public void service(ServiceManager manager)

Specified by:

service in interface Serviceable

initialize

public void initialize()

Specified by:

initialize in interface Initializable

addGlobalConfig

public void addGlobalConfig(String pluginName,
                            Map<String,ConfigParameterInfo> parameters,
                            Map<String,ConfigParameterInfo> paramCheckers)

Registers new available parameters.
The addConfig() method allows to select which ones are actually useful.

Parameters:

pluginName - the name of the plugin defining the parameters

parameters - the config parameters definition

paramCheckers - the parameters checkers definition

addConfig

public void addConfig(String featureId,
                      Map<String,ConfigParameterInfo> parameters,
                      Collection<String> parametersReferences,
                      Map<String,ConfigParameterInfo> paramCheckers)

Registers a new parameter or references a globalConfig parameter.

Parameters:

featureId - the id of the feature defining the parameters

parameters - the config parameters definition

parametersReferences - references to already defined parameters

paramCheckers - the parameters checkers definition

validate

public void validate()

Ends the initialization of the config parameters, by checking against the already valued parameters.
If at least one parameter has no value, the application won't start.

_validateParameters

private void _validateParameters(Map<String,String> untypedValues)

_validateParameter

private Object _validateParameter(Map<String,String> untypedValues,
                                  ConfigParameter parameter)

evaluateDisableConditions

public boolean evaluateDisableConditions(DisableConditions disableConditions,
                                         Map<String,String> untypedValues)

Recursively evaluate the DisableConditions against the configuration values

Parameters:

disableConditions - the disable conditions to evaluate

untypedValues - the untyped configuration values

Returns:

true if the disable conditions are true, false otherwise

_evaluateCondition

private boolean _evaluateCondition(DisableCondition condition,
                                   Map<String,String> untypedValues)

dispose

public void dispose()

Dispose the manager before restarting it

getParametersIds

public String[] getParametersIds()

Get the id of the config parameters. Use get to retrieve the parameter

Returns:

An array of String containing the id of the parameters existing in the model

getValues

public Map<String,Object> getValues()

Returns typed config values.

Returns:

typed config values.

getCategories

public Map<I18nizableText,ConfigParameterCategory> getCategories()

Returns all ConfigParameter grouped by categories and groups.

Returns:

all ConfigParameter.

get

public ConfigParameter get(String id)

Gets the config parameter by its id

Parameters:

id - Id of the config parameter to get

Returns:

The config parameter.

getParameters

public Map<String,ConfigParameter> getParameters()

Gets the typed configuration parameters

Returns:

the _params map

getParameterCheckers

public Map<String,ConfigParameterCheckerDescriptor> getParameterCheckers()

Returns all ConfigParameterCheckerDescriptors.

Returns:

all ConfigParameterCheckerDescriptors.

getParameterChecker

public ConfigParameterCheckerDescriptor getParameterChecker(String id)

Gets the parameter checker with its id

Parameters:

id - the id of the parameter checker to get

Returns:

the associated parameter checker descriptor

_categorizeParameters

private Map<I18nizableText,ConfigParameterCategory> _categorizeParameters(Map<String,ConfigParameter> params,
                                                                          Map<String,ConfigParameterCheckerDescriptor> paramCheckers)

_getValue

private Object _getValue(String paramID,
                         ParameterHelper.ParameterType type,
                         Map<String,String> untypedValues)

save

public Map<String,Errors> save(Map<String,String> untypedValues,
                               String fileName)
                        throws Exception

Update the configuration file with the given values
Values are untyped (all are of type String) and might be null.

Parameters:

untypedValues - A map (key, untyped value).

fileName - the config file absolute path

Returns:

errors The fields in error

Throws:

Exception - If an error occurred while saving values

_bindAndValidateParameters

private Map<String,Object> _bindAndValidateParameters(Map<String,String> untypedValues,
                                                      Map<String,String> oldUntypedValues,
                                                      Map<String,Errors> errorFields)

Bind all parameters to typed values and for each, if enabled, validate it

Parameters:

untypedValues - The untyped values (from client-side)

oldUntypedValues - The old untyped values (before saving)

errorFields - The parameters in errors to be completed by validation process

Returns:

The typed values

_toSAX

private void _toSAX(TransformerHandler handler,
                    Map<String,Object> typedValues)
             throws SAXException

SAX the config values into a content handler

Parameters:

handler - Handler where to sax

typedValues - Map (key, typed value) to sax

Throws:

SAXException - if an error occurred