Package org.ametys.plugins.workflow.dao

Class WorkflowsDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workflow.dao.WorkflowsDAO

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class WorkflowsDAO
extends AbstractLogEnabled
implements Serviceable, Component, Contextualizable

DAO for managing workflows

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_cocoonContext	The Cocoon context
protected Context	_context	The context
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected I18nHelper	_i18nHelper	The helper for i18n translations and catalogs
protected I18nUtils	_i18nUtils	I18n Utils
protected ObservationManager	_observationManager	The observation manager
protected final String	_regexPattern	The regex pattern for workflow names
protected SourceResolver	_sourceResolver	The source resolver
protected WorkflowDefinitionExtensionPoint	_workflowDefinitionEP	The Workflow Definition Extension Point
protected WorkflowHelper	_workflowHelper	The workflow helper
protected WorkflowLanguageManager	_workflowLanguageManager	The workflow language manager
protected WorflowRightHelper	_workflowRightHelper	The workflow right helper
protected WorkflowSessionHelper	_workflowSessionHelper	The workflow session helper
protected WorkflowTransitionDAO	_workflowTransitionDAO	The workflow transition DAO
static final String	META_NEW_WORKFLOW	Meta to set in new workflows
static final String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
WorkflowsDAO()

Method Summary

Modifier and Type	Method	Description
protected Map<String,String>	_getWorkflowLabels(String workflowName)	Get multilingual labels for current workflow
protected boolean	_hasEmptyConditionalResult(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor, Map<String,Object> results, Set<Integer> transitionIds)	Check for result without condition or operators without conditions
protected boolean	_hasEmptyOperator(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor, Set<Integer> transitionIds, Map<String,Object> results)	Check for operators without conditions
protected boolean	_setErrors(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor, Map<String,Object> results)	Check for invalid components in workflow, return true if there is any
void	contextualize(Context context)
Map<String,Object>	createWorkflow(Map<String,String> labels, String id)	Create a new workflow
Map<String,Object>	duplicateWorkflow(String workflowName, Map<String,String> labels, String duplicateId)	Duplicate a workflow
Map<String,Object>	getWorkflowInfos(String workflowName)	Get workflow infos
Map<String,Object>	getWorkflowRootProperties(String workflowName)	Get the workflow properties
Map<String,Object>	getWorkflowsList()	Get the list of all workflows
Map<String,Object>	reinit(String workflowName)	Restore last version of current workflow if exist
Map<String,Object>	renameWorkflow(String workflowName, Map<String,String> labels)	Rename the workflow
Map<String,Object>	saveChanges(String workflowName)	Overwrite the current workflow in a XML file
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

META_NEW_WORKFLOW

public static final String META_NEW_WORKFLOW

Meta to set in new workflows

See Also:

• Constant Field Values

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper

_workflowSessionHelper

protected WorkflowSessionHelper _workflowSessionHelper

The workflow session helper

_workflowRightHelper

protected WorflowRightHelper _workflowRightHelper

The workflow right helper

_workflowLanguageManager

protected WorkflowLanguageManager _workflowLanguageManager

The workflow language manager

_i18nHelper

protected I18nHelper _i18nHelper

The helper for i18n translations and catalogs

_cocoonContext

protected Context _cocoonContext

The Cocoon context

_i18nUtils

protected I18nUtils _i18nUtils

I18n Utils

_context

protected Context _context

The context

_regexPattern

protected final String _regexPattern

The regex pattern for workflow names

See Also:

• Constant Field Values

_workflowDefinitionEP

protected WorkflowDefinitionExtensionPoint _workflowDefinitionEP

The Workflow Definition Extension Point

_workflowTransitionDAO

protected WorkflowTransitionDAO _workflowTransitionDAO

The workflow transition DAO

_observationManager

protected ObservationManager _observationManager

The observation manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_sourceResolver

protected SourceResolver _sourceResolver

The source resolver

Constructor Details

WorkflowsDAO

public WorkflowsDAO()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getWorkflowRootProperties

public Map<String,Object> getWorkflowRootProperties(String workflowName)

Get the workflow properties

Parameters:

workflowName - the name of the workflow to get

Returns:

the workflow properties

getWorkflowsList

public Map<String,Object> getWorkflowsList()

Get the list of all workflows

Returns:

a map with workflow's list as value

saveChanges

public Map<String,Object> saveChanges(String workflowName)

Overwrite the current workflow in a XML file

Parameters:

workflowName - id of current workflow

Returns:

an empty map if all went well, an error message if not

reinit

public Map<String,Object> reinit(String workflowName)

Restore last version of current workflow if exist

Parameters:

workflowName - name of current workflow

Returns:

map of result

_setErrors

protected boolean _setErrors(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor,
 Map<String,Object> results)

Check for invalid components in workflow, return true if there is any

Parameters:

workflowDescriptor - the workflow to check

results - a map to fill with error message and invalid component's labels

Returns:

true if there are errors

_hasEmptyConditionalResult

protected boolean _hasEmptyConditionalResult(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor,
 Map<String,Object> results,
 Set<Integer> transitionIds)

Check for result without condition or operators without conditions

Parameters:

workflowDescriptor - the workflow to check

results - a map to fill with error message and invalid transition's labels

transitionIds - a list of all the workflow's transitions ids

Returns:

true if there are invalid conditional results

_hasEmptyOperator

protected boolean _hasEmptyOperator(com.opensymphony.workflow.loader.WorkflowDescriptor workflowDescriptor,
 Set<Integer> transitionIds,
 Map<String,Object> results)

Check for operators without conditions

Parameters:

workflowDescriptor - the workflow to check

transitionIds - a list of all the workflow's transitions ids

results - a map to fill with error message and invalid transition's labels

Returns:

true if there are operator without conditions

_getWorkflowLabels

protected Map<String,String> _getWorkflowLabels(String workflowName)

Get multilingual labels for current workflow

Parameters:

workflowName - name of current workflow

Returns:

a map of labels, key is language and value is translation

getWorkflowInfos

public Map<String,Object> getWorkflowInfos(String workflowName)

Get workflow infos

Parameters:

workflowName - the name of the workflow

Returns:

a map of the list of workflow names and the workflow's labels

createWorkflow

public Map<String,Object> createWorkflow(Map<String,String> labels,
 String id)

Create a new workflow

Parameters:

labels - the multilingual labels

id - the unique name

Returns:

map of error message or workflow name if creation went well

renameWorkflow

public Map<String,Object> renameWorkflow(String workflowName,
 Map<String,String> labels)

Rename the workflow

Parameters:

workflowName - unique name of current workflow

labels - the new multilingual labels

Returns:

the workflow name

duplicateWorkflow

public Map<String,Object> duplicateWorkflow(String workflowName,
 Map<String,String> labels,
 String duplicateId)

Duplicate a workflow

Parameters:

workflowName - the workflow to duplicate's name

labels - the new labels for the workflow

duplicateId - the new id for the clone

Returns:

map of results