Package org.ametys.web.frontoffice

Class AdditionalParameterFOSearchExtensionPoint

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.web.frontoffice.AdditionalParameterFOSearchExtensionPoint

All Implemented Interfaces:

ExtensionPoint<Configuration>, Component, LogEnabled

public class AdditionalParameterFOSearchExtensionPoint
extends AbstractLogEnabled
implements ExtensionPoint<Configuration>, Component

This extension point handle additional parameters for FO search service

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
AdditionalParameterFOSearchExtensionPoint()

Method Summary

Modifier and Type	Method	Description
void	addExtension(String id, String pluginName, String featureName, Configuration configuration)	Add an extension to this point.
Configuration	getExtension(String id)	Returns the named extension
Set<String>	getExtensionsIds()	Returns a Set containing the ids of all known extensions
String	getPluginName(String id)	Get the plugin name of the extension
boolean	hasExtension(String id)	Returns true if the named extension exists
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.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The avalon role

Constructor Detail

AdditionalParameterFOSearchExtensionPoint

public AdditionalParameterFOSearchExtensionPoint()

Method Detail

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

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 Configuration getExtension(String id)

Description copied from interface: ExtensionPoint

Returns the named extension

Specified by:

getExtension in interface ExtensionPoint<Configuration>

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

Returns:

a Set containing the ids of all known extensions

hasExtension

public boolean hasExtension(String id)

Description copied from interface: ExtensionPoint

Returns true if the named extension exists

Specified by:

hasExtension in interface ExtensionPoint<Configuration>

Parameters:

id - the unique id of the extension

Returns:

true if the named extension exists

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

Throws:

Exception - if something wrong occurs

getPluginName

public String getPluginName(String id)

Get the plugin name of the extension

Parameters:

id - the id of the extension

Returns:

the plugin name