Package org.ametys.plugins.core.ui.help

Class HelpExtensionPoint

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.ui.help.HelpExtensionPoint

All Implemented Interfaces:

LogEnabled, ExtensionPoint<String>, Initializable, Component, Serviceable, ThreadSafe

public class HelpExtensionPoint
extends AbstractLogEnabled
implements ExtensionPoint<String>, Initializable, ThreadSafe, Component, Serviceable

This extension point handle a list of help URLs handled by the plugins or the application.

Field Summary

Fields

Modifier and Type	Field	Description
protected HelpManager	_helpManager	The help manager
protected Map<String,HelpLink>	_links	The map of rightId, Right of declared rights
protected Set<String>	_points	Set of extensions points added
static final String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
HelpExtensionPoint()

Method Summary

Modifier and Type	Method	Description
void	addExtension(String id, String pluginName, String featureName, Configuration configuration)	Add an extension to this point.
String	getExtension(String id)	Returns the named extension
Set<String>	getExtensionsIds()	Returns a Set containing the ids of all known extensions
HelpLink	getHelpLink(String point, String id)	Return the helpLink available for this point/id
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.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

The avalon role

_links

protected Map<String,HelpLink> _links

The map of rightId, Right of declared rights

_points

protected Set<String> _points

Set of extensions points added

_helpManager

protected HelpManager _helpManager

The help manager

Constructor Details

HelpExtensionPoint

public HelpExtensionPoint()

Method Details

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

hasExtension

public boolean hasExtension(String id)

Description copied from interface: ExtensionPoint

Returns true if the named extension exists

Specified by:

hasExtension in interface ExtensionPoint<String>

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

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

getHelpLink

public HelpLink getHelpLink(String point,
 String id)

Return the helpLink available for this point/id

Parameters:

point - extension point

id - id of the extension for this extension point

Returns:

a HelpLink

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

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

Throws:

Exception - if something wrong occurs

getExtension

public String getExtension(String id)

Description copied from interface: ExtensionPoint

Returns the named extension

Specified by:

getExtension in interface ExtensionPoint<String>

Parameters:

id - the unique id of the extension

Returns:

the named extension