public class HelpExtensionPoint extends AbstractLogEnabled implements ExtensionPoint<String>, Initializable, ThreadSafe, Component, Serviceable
Modifier and Type | Field and 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 String |
ROLE
The avalon role
|
Constructor and Description |
---|
HelpExtensionPoint() |
Modifier and Type | Method and 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) |
getLogger, setLogger
protected HelpManager _helpManager
public HelpExtensionPoint()
public void initialize() throws Exception
initialize
in interface Initializable
Exception
public void service(ServiceManager manager) throws ServiceException
service
in interface Serviceable
ServiceException
public boolean hasExtension(String id)
ExtensionPoint
hasExtension
in interface ExtensionPoint<String>
id
- the unique id of the extensionpublic void addExtension(String id, String pluginName, String featureName, Configuration configuration) throws ConfigurationException
ExtensionPoint
addExtension
in interface ExtensionPoint<String>
id
- the unique identifier of the extension.pluginName
- Unique identifier for the plugin hosting the extensionfeatureName
- Unique feature identifier (unique for a given pluginName)configuration
- the information about the extension to be addedConfigurationException
- when a configuration problem occurspublic HelpLink getHelpLink(String point, String id)
point
- extension pointid
- id of the extension for this extension pointHelpLink
public Set<String> getExtensionsIds()
ExtensionPoint
getExtensionsIds
in interface ExtensionPoint<String>
public void initializeExtensions() throws Exception
ExtensionPoint
addExtension()
calls.initializeExtensions
in interface ExtensionPoint<String>
Exception
- if something wrong occurspublic String getExtension(String id)
ExtensionPoint
getExtension
in interface ExtensionPoint<String>
id
- the unique id of the extension