Package org.ametys.plugins.workflow.definition

Class WorkflowDefinitionExtensionPoint

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.plugins.workflow.definition.WorkflowDefinitionExtensionPoint

All Implemented Interfaces:

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

public class WorkflowDefinitionExtensionPoint
extends AbstractThreadSafeComponentExtensionPoint<WorkflowDefinition>

The WorkflowDefinition extension point to list all available workflows.

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_cocoonContext	The Cocoon context
static final String	ROLE	The Avalon role

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

_cocoonManager, _context, _manager

Constructor Summary

Constructors

Constructor	Description
WorkflowDefinitionExtensionPoint()

Method Summary

Modifier and Type	Method	Description
protected File	_getParamWorkflowDir()	Get the param workflows directory.
protected String	_getWorkflowIdFromFilename(String filename)	Get the workflow ID from the workflow filename.
void	addExtension(String id, String pluginName, String featureName, Configuration configuration)	Add an extension to this point.
void	contextualize(Context context)
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.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint

addComponent, dispose, getExtension, getExtensionsIds, hasExtension, initialize, service

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

_cocoonContext

protected Context _cocoonContext

The Cocoon context

Constructor Details

WorkflowDefinitionExtensionPoint

public WorkflowDefinitionExtensionPoint()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Overrides:

contextualize in class AbstractThreadSafeComponentExtensionPoint<WorkflowDefinition>

Throws:

ContextException

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

Overrides:

initializeExtensions in class AbstractThreadSafeComponentExtensionPoint<WorkflowDefinition>

Throws:

Exception - if something wrong occurs

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

Overrides:

addExtension in class AbstractThreadSafeComponentExtensionPoint<WorkflowDefinition>

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

_getParamWorkflowDir

protected File _getParamWorkflowDir()

Get the param workflows directory.

Returns:

the workflows directory in WEB-INF/param.

_getWorkflowIdFromFilename

protected String _getWorkflowIdFromFilename(String filename)

Get the workflow ID from the workflow filename.

Parameters:

filename - The workflow filename

Returns:

the workflow ID