org.ametys.web.site

Class SiteConfigurationExtensionPoint

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint<RepositoryElementType>

org.ametys.web.site.SiteConfigurationExtensionPoint

All Implemented Interfaces:

Model, ModelItemContainer, LogEnabled, ExtensionPoint<RepositoryElementType>, Disposable, Initializable, Component, Contextualizable, Serviceable, ThreadSafe

public class SiteConfigurationExtensionPoint
extends AbstractThreadSafeComponentExtensionPoint<RepositoryElementType>
implements Model

Extension point holding all SiteParameter definitions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	SiteConfigurationExtensionPoint.I18nizableTextTranslationComparator I18nizableText comparator for site parameters General information category is the first one, then sort the I18nizableText with their translation
(package private) class	SiteConfigurationExtensionPoint.SiteParameterParser Parser for SiteParameter.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__GENERAL_INFORMATIONS_I18N_KEY
private static Pattern	__PARAM_NAME_PATTERN
private ThreadSafeComponentManager<Enumerator>	_enumeratorManager ComponentManager for Enumerators.
protected I18nUtils	_i18nUtils Component gathering utility methods for internationalizable text translation I18nUtils
private Map<String,Boolean>	_isComplete Determines if all parameters are valued, by site.
private SiteConfigurationExtensionPoint.SiteParameterParser	_parameterParser Site parameter parser.
private Map<String,SiteParameter>	_parameters Parameters map, indexed by parameter ID.
protected SiteManager	_siteManager The site manager.
private SiteParameterTypeExtensionPoint	_siteParameterTypeEP
protected SiteTypesExtensionPoint	_siteTypeEP The site type extension point.
private ThreadSafeComponentManager<Validator>	_validatorManager ComponentManager for Validators.
static String	ROLE Avalon Role

Fields inherited from class org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint

_cocoonManager, _context, _manager

Constructor Summary

Constructors

Constructor and Description
SiteConfigurationExtensionPoint()

Method Summary

Modifier and Type	Method and Description
protected void	_addParameter(String pluginName, String featureName, Configuration configuration) Declare a site parameter.
protected Map<I18nizableText,Map<I18nizableText,List<SiteParameter>>>	_categorize(Collection<SiteParameter> parameters) Organize a collection of site parameters by categories and groups.
protected boolean	_validateParameter(SiteParameter parameter, String siteName) Validate a parameter value for a given site.
protected boolean	_validateSiteConfig(String siteName) Validate the configuration of a site.
void	addExtension(String id, String pluginName, String featureName, Configuration configuration) Add an extension to this point.
void	dispose() Dispose the manager before restarting it
Map<I18nizableText,Map<I18nizableText,List<SiteParameter>>>	getCategorizedParameters(String siteName) Get all the parameters of a given site, classified by category and group.
RepositoryElementType	getExtension(String id) Returns the named extension
Set<String>	getExtensionsIds() Returns a Set containing the ids of all known extensions
String	getFamilyId() Retrieves the Family Id (for example the extension point) Each model Id have to be unique in it's family Id
String	getId() Retrieves the model id (an id must be unique in the family Model.getFamilyId()
ModelItem	getModelItem(String itemPath) Retrieves the model item at given path
Collection<? extends ModelItem>	getModelItems() Retrieves all the model items of this container
Map<String,SiteParameter>	getParameters(String siteName) Get all the parameters for a given site.
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.
boolean	isValid(String siteName) Test if a site configuration is valid.
void	reloadConfiguration(String siteName) Reload a site's configuration.
void	removeConfiguration(String siteName) Remove a site's configuration.
void	service(ServiceManager manager)

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

addComponent, contextualize

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

Methods inherited from interface org.ametys.runtime.model.ModelItemContainer

getChild, hasModelItem

Field Detail

ROLE

public static final String ROLE

Avalon Role

__PARAM_NAME_PATTERN

private static final Pattern __PARAM_NAME_PATTERN

__GENERAL_INFORMATIONS_I18N_KEY

private static final String __GENERAL_INFORMATIONS_I18N_KEY

See Also:

Constant Field Values

_siteManager

protected SiteManager _siteManager

The site manager.

_siteTypeEP

protected SiteTypesExtensionPoint _siteTypeEP

The site type extension point.

_i18nUtils

protected I18nUtils _i18nUtils

Component gathering utility methods for internationalizable text translation I18nUtils

_parameters

private Map<String,SiteParameter> _parameters

Parameters map, indexed by parameter ID.

_isComplete

private Map<String,Boolean> _isComplete

Determines if all parameters are valued, by site.

_validatorManager

private ThreadSafeComponentManager<Validator> _validatorManager

ComponentManager for Validators.

_enumeratorManager

private ThreadSafeComponentManager<Enumerator> _enumeratorManager

ComponentManager for Enumerators.

_parameterParser

private SiteConfigurationExtensionPoint.SiteParameterParser _parameterParser

Site parameter parser.

_siteParameterTypeEP

private SiteParameterTypeExtensionPoint _siteParameterTypeEP

Constructor Detail

SiteConfigurationExtensionPoint

public SiteConfigurationExtensionPoint()

Method Detail

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AbstractThreadSafeComponentExtensionPoint<RepositoryElementType>

Throws:

Exception

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractThreadSafeComponentExtensionPoint<RepositoryElementType>

Throws:

ServiceException

dispose

public void dispose()

Dispose the manager before restarting it

Specified by:

dispose in interface Disposable

Overrides:

dispose in class AbstractThreadSafeComponentExtensionPoint<RepositoryElementType>

hasExtension

public boolean hasExtension(String id)

Description copied from interface: ExtensionPoint

Returns true if the named extension exists

Specified by:

hasExtension in interface ExtensionPoint<RepositoryElementType>

Overrides:

hasExtension in class AbstractThreadSafeComponentExtensionPoint<RepositoryElementType>

Parameters:

id - the unique id of the extension

Returns:

true if the named extension exists

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<RepositoryElementType>

Overrides:

addExtension in class AbstractThreadSafeComponentExtensionPoint<RepositoryElementType>

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

getExtension

public RepositoryElementType getExtension(String id)

Description copied from interface: ExtensionPoint

Returns the named extension

Specified by:

getExtension in interface ExtensionPoint<RepositoryElementType>

Overrides:

getExtension in class AbstractThreadSafeComponentExtensionPoint<RepositoryElementType>

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<RepositoryElementType>

Overrides:

getExtensionsIds in class AbstractThreadSafeComponentExtensionPoint<RepositoryElementType>

Returns:

a Set containing the ids of all known extensions

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<RepositoryElementType>

Overrides:

initializeExtensions in class AbstractThreadSafeComponentExtensionPoint<RepositoryElementType>

Throws:

Exception - if something wrong occurs

isValid

public boolean isValid(String siteName)
                throws UnknownAmetysObjectException

Test if a site configuration is valid.

Parameters:

siteName - the site name.

Returns:

true if the site configuration is valid, false otherwise.

Throws:

UnknownAmetysObjectException - if the site doesn't exist.

reloadConfiguration

public void reloadConfiguration(String siteName)
                         throws UnknownAmetysObjectException

Reload a site's configuration.

Parameters:

siteName - the site name.

Throws:

UnknownAmetysObjectException - if the site doesn't exist.

removeConfiguration

public void removeConfiguration(String siteName)

Remove a site's configuration.

Parameters:

siteName - the site name.

getParameters

public Map<String,SiteParameter> getParameters(String siteName)

Get all the parameters for a given site.

Parameters:

siteName - the site name.

Returns:

the parameters

getCategorizedParameters

public Map<I18nizableText,Map<I18nizableText,List<SiteParameter>>> getCategorizedParameters(String siteName)

Get all the parameters of a given site, classified by category and group.

Parameters:

siteName - the site name.

Returns:

the parameters classified by category and group.

_addParameter

protected void _addParameter(String pluginName,
                             String featureName,
                             Configuration configuration)
                      throws ConfigurationException

Declare a site parameter.

Parameters:

pluginName - The name of the plugin declaring the extension.

featureName - the name of the feature

configuration - The parameter configuration.

Throws:

ConfigurationException - if configuration if not complete.

_validateSiteConfig

protected boolean _validateSiteConfig(String siteName)

Validate the configuration of a site.

Parameters:

siteName - the name of the site to check.

Returns:

true if the site is correctly configured, false otherwise.

_validateParameter

protected boolean _validateParameter(SiteParameter parameter,
                                     String siteName)

Validate a parameter value for a given site.

Parameters:

parameter - the site parameter to validate.

siteName - the site name on which to check.

Returns:

true if the parameter's value is valid, false otherwise.

_categorize

protected Map<I18nizableText,Map<I18nizableText,List<SiteParameter>>> _categorize(Collection<SiteParameter> parameters)

Organize a collection of site parameters by categories and groups.

Parameters:

parameters - a collection of site parameters.

Returns:

a Map of parameters sorted first by category then group.

getModelItem

public ModelItem getModelItem(String itemPath)
                       throws UndefinedItemPathException

Description copied from interface: ModelItemContainer

Retrieves the model item at given path

Specified by:

getModelItem in interface ModelItemContainer

Parameters:

itemPath - the item path

Returns:

the model item.

Throws:

UndefinedItemPathException - if there is no item defined at the given path

getModelItems

public Collection<? extends ModelItem> getModelItems()

Description copied from interface: ModelItemContainer

Retrieves all the model items of this container

Specified by:

getModelItems in interface ModelItemContainer

Returns:

the model items

getId

public String getId()

Description copied from interface: Model

Retrieves the model id (an id must be unique in the family Model.getFamilyId()

Specified by:

getId in interface Model

Returns:

model id (for example the content type id for a content)

getFamilyId

public String getFamilyId()

Description copied from interface: Model

Retrieves the Family Id (for example the extension point) Each model Id have to be unique in it's family Id

Specified by:

getFamilyId in interface Model

Returns:

content point (for example "org.ametys.cms.contenttype.ContentTypeExtensionPoint" for a content)