Package org.ametys.web.site

Class SiteConfigurationExtensionPoint

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.web.site.SiteConfigurationExtensionPoint

All Implemented Interfaces:

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

public class SiteConfigurationExtensionPoint
extends AbstractThreadSafeComponentExtensionPoint<SiteParameterWrapper>

Extension point holding all SiteParameterWrapper definitions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	Avalon Role

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

_cocoonManager, _context, _manager

Constructor Summary

Constructors

Constructor	Description
SiteConfigurationExtensionPoint()

Method Summary

Modifier and Type	Method	Description
protected void	_addParameter(String pluginName, String featureName, Configuration configuration)	Declare a site parameter.
void	addExtension(String id, String pluginName, String featureName, Configuration configuration)	Add an extension to this point.
void	dispose()	Dispose the manager before restarting it
SiteParameterWrapper	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 manager)

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

addComponent, contextualize, deferredInitializeExtensions

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

Avalon Role

Constructor Details

SiteConfigurationExtensionPoint

public SiteConfigurationExtensionPoint()

Method Details

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AbstractThreadSafeComponentExtensionPoint<SiteParameterWrapper>

Throws:

Exception

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractThreadSafeComponentExtensionPoint<SiteParameterWrapper>

Throws:

ServiceException

dispose

public void dispose()

Dispose the manager before restarting it

Specified by:

dispose in interface Disposable

Overrides:

dispose in class AbstractThreadSafeComponentExtensionPoint<SiteParameterWrapper>

hasExtension

public boolean hasExtension(String id)

Description copied from interface: ExtensionPoint

Returns true if the named extension exists

Specified by:

hasExtension in interface ExtensionPoint<SiteParameterWrapper>

Overrides:

hasExtension in class AbstractThreadSafeComponentExtensionPoint<SiteParameterWrapper>

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

Overrides:

addExtension in class AbstractThreadSafeComponentExtensionPoint<SiteParameterWrapper>

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

_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 is not complete.

getExtension

public SiteParameterWrapper getExtension(String id)

Description copied from interface: ExtensionPoint

Returns the named extension

Specified by:

getExtension in interface ExtensionPoint<SiteParameterWrapper>

Overrides:

getExtension in class AbstractThreadSafeComponentExtensionPoint<SiteParameterWrapper>

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

Overrides:

getExtensionsIds in class AbstractThreadSafeComponentExtensionPoint<SiteParameterWrapper>

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

Overrides:

initializeExtensions in class AbstractThreadSafeComponentExtensionPoint<SiteParameterWrapper>

Throws:

Exception - if something wrong occurs