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 WorkflowHelper	_workflowHelper	The workflow helper
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 String	_getWorkflowIdFromFilename(String filename)	Get the workflow ID from the workflow filename.
void	addOrUpdateExtension(String workflowId)	Add a workflow to the workflow definition extension point
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, addExtension, contextualize, dispose, getExtension, getExtensionsIds, hasExtension, initialize

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

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper

Constructor Details

WorkflowDefinitionExtensionPoint

public WorkflowDefinitionExtensionPoint()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractThreadSafeComponentExtensionPoint<WorkflowDefinition>

Throws:

ServiceException

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

addOrUpdateExtension

public void addOrUpdateExtension(String workflowId)
                          throws ConfigurationException

Add a workflow to the workflow definition extension point

Parameters:

workflowId - id of workflow

Throws:

ConfigurationException - exception while trying to configure workflow

_getWorkflowIdFromFilename

protected String _getWorkflowIdFromFilename(String filename)

Get the workflow ID from the workflow filename.

Parameters:

filename - The workflow filename

Returns:

the workflow ID