org.jahia.services.workflow

Class WorkflowService

java.lang.Object

org.jahia.services.workflow.WorkflowService

All Implemented Interfaces:

EventListener, ReadOnlyModeCapable, org.springframework.beans.factory.config.BeanPostProcessor, org.springframework.context.ApplicationListener<JahiaTemplateManagerService.ModuleDeployedOnSiteEvent>

public class WorkflowService
extends Object
implements org.springframework.beans.factory.config.BeanPostProcessor, org.springframework.context.ApplicationListener<JahiaTemplateManagerService.ModuleDeployedOnSiteEvent>, ReadOnlyModeCapable

Jahia service for managing content workflow.

Since:

JAHIA 6.5

Author:

rincevent

Field Summary

Fields

Modifier and Type	Field and Description
static String	CANDIDATE
static String	START_ROLE
static String	WORKFLOWRULES_NODE_NAME

Constructor Summary

Constructors

Constructor and Description
WorkflowService()

Method Summary

Modifier and Type	Method and Description
void	abortProcess(String processId, String provider) This method will call the underlying provider to signal the identified process.
void	addComment(String processId, String provider, String comment, String user)
void	addProcessId(JCRNodeWrapper stageNode, String provider, String processId)
void	addProvider(WorkflowProvider provider) Adds the specified workflow provider into the registry.
void	addWorkflowListener(WorkflowListener listener)
void	addWorkflowRule(JCRNodeWrapper node, String wfName)
void	addWorkflowRule(JCRNodeWrapper node, WorkflowDefinition workflow)
void	assignAndCompleteTask(String taskId, String provider, String outcome, Map<String,Object> args, JahiaUser user)
void	assignAndCompleteTaskAsJob(String taskId, String provider, String outcome, Map<String,Object> args, JahiaUser user)
void	assignTask(String taskId, String provider, JahiaUser user)
void	completeTask(String taskId, JahiaUser user, String provider, String outcome, Map<String,Object> args)
void	deleteProcess(String processId, String provider)
List<Workflow>	getActiveWorkflows(JCRNodeWrapper node, Locale locale, Locale displayLocale) This method list all currently active workflow for the specified node.
Map<Locale,List<Workflow>>	getActiveWorkflowsForAllLocales(JCRNodeWrapper node) This method list all currently active workflow for the specified node.
List<JahiaPrincipal>	getAssignedRole(WorkflowDefinition definition, String activityName, String processId)
List<JahiaPrincipal>	getAssignedRole(WorkflowDefinition definition, String activityName, String processId, JCRSessionWrapper session)
Set<WorkflowAction>	getAvailableActions(String processId, String provider, Locale locale) This method list all actions available at execution time for a node.
String	getFormForAction(String definitionKey, String action)
HistoryWorkflow	getHistoryWorkflow(String id, String provider, Locale uiLocale)
List<HistoryWorkflow>	getHistoryWorkflows(JCRNodeWrapper node, Locale uiLocale) Returns a list of process instance history records for the specified node.
List<HistoryWorkflow>	getHistoryWorkflowsByPath(String path, Locale locale) Returns a list of process instance history records for the specified path.
List<HistoryWorkflowTask>	getHistoryWorkflowTasks(String workflowProcessId, String providerKey, Locale uiLocale) Returns a list of history records for workflow tasks.
static WorkflowService	getInstance() Returns a singleton instance of this service.
String	getModuleForWorkflow(String key)
WorkflowObservationManager	getObservationManager()
WorkflowDefinition	getPossibleWorkflowForType(JCRNodeWrapper node, boolean checkPermission, String type, Locale locale) This method return the workflow associated to an type, for the specified node.
Map<String,WorkflowDefinition>	getPossibleWorkflows(JCRNodeWrapper node, boolean checkPermission, Locale uiLocale) This method list all possible workflows for the specified node.
Map<String,WorkflowProvider>	getProviders() Returns a map with the registered workflow providers.
int	getReadOnlyModePriority() Get the priority of the service.
List<WorkflowTask>	getTasksForUser(JahiaUser user, Locale uiLocale)
Set<String>	getTypesOfWorkflow()
Workflow	getWorkflow(String provider, String id, Locale displayLocale)
WorkflowDefinition	getWorkflowDefinition(String provider, String id, Locale locale)
List<WorkflowDefinition>	getWorkflowDefinitionsForType(String type, JCRSiteNode siteNode, Locale uiLocale) Returns a list of available workflow definitions for the specified type.
List<WorkflowDefinition>	getWorkflowDefinitionsForType(String type, Locale uiLocale) Returns a list of available workflow definitions for the specified type.
WorklowTypeRegistration	getWorkflowRegistration(String definitionKey)
WorkflowRule	getWorkflowRuleForAction(JCRNodeWrapper objectNode, boolean checkPermission, String action)
Collection<WorkflowRule>	getWorkflowRules(JCRNodeWrapper objectNode)
List<WorkflowDefinition>	getWorkflows(Locale displayLocale) This method list all workflows deployed in the system
List<Workflow>	getWorkflowsForDefinition(String definition, Locale uiLocale)
List<Workflow>	getWorkflowsForType(String type, Locale uiLocale)
List<Workflow>	getWorkflowsForUser(JahiaUser user, Locale uiLocale)
WorkflowTask	getWorkflowTask(String taskId, String provider, Locale displayLocale)
String	getWorkflowType(WorkflowDefinition def)
boolean	hasActiveWorkflowForType(JCRNodeWrapper node, String type) This method list all currently active workflow for the specified node.
void	initAfterAllServicesAreStarted()
protected WorkflowProvider	lookupProvider(String key)
void	onApplicationEvent(JahiaTemplateManagerService.ModuleDeployedOnSiteEvent event)
Object	postProcessAfterInitialization(Object bean, String beanName)
Object	postProcessBeforeInitialization(Object bean, String beanName)
void	registerWorkflowType(WorklowTypeRegistration type) Performs the registration of the provided workflow type.
void	registerWorkflowTypes()
void	removeProcessId(JCRNodeWrapper stageNode, String provider, String processId)
void	removeProvider(WorkflowProvider provider) Removes the specified provider from the registry.
void	setCacheService(CacheService cacheService)
void	setJcrTemplate(JCRTemplate jcrTemplate)
void	start()
String	startProcess(List<String> nodeIds, JCRSessionWrapper session, String processKey, String provider, Map<String,Object> args, List<String> comments)
void	startProcessAsJob(List<String> nodeIds, JCRSessionWrapper session, String processKey, String provider, Map<String,Object> args, List<String> comments)
void	switchReadOnlyMode(boolean enable) Enable/disable read-only mode for a specific functional area this ReadOnlyModeCapable is responsible for.
void	unregisterWorkflowType(WorklowTypeRegistration type) Performs the unregistration of the provided workflow type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CANDIDATE

public static final String CANDIDATE

See Also:

Constant Field Values

START_ROLE

public static final String START_ROLE

See Also:

Constant Field Values

WORKFLOWRULES_NODE_NAME

public static final String WORKFLOWRULES_NODE_NAME

See Also:

Constant Field Values

Constructor Detail

WorkflowService

public WorkflowService()

Method Detail

getInstance

public static WorkflowService getInstance()

Returns a singleton instance of this service.

Returns:

a singleton instance of this service

setCacheService

public void setCacheService(CacheService cacheService)

start

public void start()
           throws JahiaInitializationException

Throws:

JahiaInitializationException

registerWorkflowType

public void registerWorkflowType(WorklowTypeRegistration type)

Performs the registration of the provided workflow type.

Parameters:

type - the helper object instance for registerng a new workflow type

registerWorkflowTypes

public void registerWorkflowTypes()

unregisterWorkflowType

public void unregisterWorkflowType(WorklowTypeRegistration type)

Performs the unregistration of the provided workflow type.

Parameters:

type - the helper object instance for unregisterng a workflow type

getProviders

public Map<String,WorkflowProvider> getProviders()

Returns a map with the registered workflow providers.

Returns:

a map with the registered workflow providers

addProvider

public void addProvider(WorkflowProvider provider)

Adds the specified workflow provider into the registry.

Parameters:

provider - a workflow provider to be registered

removeProvider

public void removeProvider(WorkflowProvider provider)

Removes the specified provider from the registry.

Parameters:

provider - the provider to be removed

getWorkflows

public List<WorkflowDefinition> getWorkflows(Locale displayLocale)
                                      throws javax.jcr.RepositoryException

This method list all workflows deployed in the system

Parameters:

displayLocale - the UI display locale

Returns:

A list of available workflows per provider.

Throws:

javax.jcr.RepositoryException - in case of an error

getWorkflowDefinitionsForType

public List<WorkflowDefinition> getWorkflowDefinitionsForType(String type,
                                                              Locale uiLocale)
                                                       throws javax.jcr.RepositoryException

Returns a list of available workflow definitions for the specified type.

Parameters:

type - workflow type

uiLocale - the locale used to localize workflow labels @return a list of available workflow definitions for the specified type

Throws:

javax.jcr.RepositoryException - in case of an error

getWorkflowDefinitionsForType

public List<WorkflowDefinition> getWorkflowDefinitionsForType(String type,
                                                              JCRSiteNode siteNode,
                                                              Locale uiLocale)
                                                       throws javax.jcr.RepositoryException

Returns a list of available workflow definitions for the specified type.

Parameters:

type - workflow type

siteNode - site node

uiLocale - the locale used to localize workflow labels @return a list of available workflow definitions for the specified type

Throws:

javax.jcr.RepositoryException - in case of an error

getPossibleWorkflows

public Map<String,WorkflowDefinition> getPossibleWorkflows(JCRNodeWrapper node,
                                                           boolean checkPermission,
                                                           Locale uiLocale)
                                                    throws javax.jcr.RepositoryException

This method list all possible workflows for the specified node.

Parameters:

node -

checkPermission -

Returns:

A list of available workflows per provider.

Throws:

javax.jcr.RepositoryException

getPossibleWorkflowForType

public WorkflowDefinition getPossibleWorkflowForType(JCRNodeWrapper node,
                                                     boolean checkPermission,
                                                     String type,
                                                     Locale locale)
                                              throws javax.jcr.RepositoryException

This method return the workflow associated to an type, for the specified node.

Parameters:

node -

checkPermission -

Returns:

A list of available workflows per provider.

Throws:

javax.jcr.RepositoryException

getAssignedRole

public List<JahiaPrincipal> getAssignedRole(WorkflowDefinition definition,
                                            String activityName,
                                            String processId)
                                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getAssignedRole

public List<JahiaPrincipal> getAssignedRole(WorkflowDefinition definition,
                                            String activityName,
                                            String processId,
                                            JCRSessionWrapper session)
                                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getActiveWorkflows

public List<Workflow> getActiveWorkflows(JCRNodeWrapper node,
                                         Locale locale,
                                         Locale displayLocale)

This method list all currently active workflow for the specified node.

Parameters:

node -

locale - the content locale

displayLocale - the UI display locale

Returns:

A list of active workflows per provider

getActiveWorkflowsForAllLocales

public Map<Locale,List<Workflow>> getActiveWorkflowsForAllLocales(JCRNodeWrapper node)

This method list all currently active workflow for the specified node.

Parameters:

node -

Returns:

A list of active workflows per provider

getAvailableActions

public Set<WorkflowAction> getAvailableActions(String processId,
                                               String provider,
                                               Locale locale)

This method list all actions available at execution time for a node.

Parameters:

processId - the process we want to advance

provider - The provider executing the process

locale -

Returns:

a set of actions per workflows per provider.

abortProcess

public void abortProcess(String processId,
                         String provider)

This method will call the underlying provider to signal the identified process.

Parameters:

processId - the process we want to advance

provider - The provider executing the process

startProcessAsJob

public void startProcessAsJob(List<String> nodeIds,
                              JCRSessionWrapper session,
                              String processKey,
                              String provider,
                              Map<String,Object> args,
                              List<String> comments)
                       throws javax.jcr.RepositoryException,
                              org.quartz.SchedulerException

Throws:

javax.jcr.RepositoryException

org.quartz.SchedulerException

startProcess

public String startProcess(List<String> nodeIds,
                           JCRSessionWrapper session,
                           String processKey,
                           String provider,
                           Map<String,Object> args,
                           List<String> comments)
                    throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

addProcessId

public void addProcessId(JCRNodeWrapper stageNode,
                         String provider,
                         String processId)
                  throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

removeProcessId

public void removeProcessId(JCRNodeWrapper stageNode,
                            String provider,
                            String processId)
                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getTasksForUser

public List<WorkflowTask> getTasksForUser(JahiaUser user,
                                          Locale uiLocale)

getWorkflowsForUser

public List<Workflow> getWorkflowsForUser(JahiaUser user,
                                          Locale uiLocale)

getWorkflowsForType

public List<Workflow> getWorkflowsForType(String type,
                                          Locale uiLocale)

getWorkflowsForDefinition

public List<Workflow> getWorkflowsForDefinition(String definition,
                                                Locale uiLocale)

assignTask

public void assignTask(String taskId,
                       String provider,
                       JahiaUser user)

completeTask

public void completeTask(String taskId,
                         JahiaUser user,
                         String provider,
                         String outcome,
                         Map<String,Object> args)

assignAndCompleteTaskAsJob

public void assignAndCompleteTaskAsJob(String taskId,
                                       String provider,
                                       String outcome,
                                       Map<String,Object> args,
                                       JahiaUser user)
                                throws javax.jcr.RepositoryException,
                                       org.quartz.SchedulerException

Throws:

javax.jcr.RepositoryException

org.quartz.SchedulerException

assignAndCompleteTask

public void assignAndCompleteTask(String taskId,
                                  String provider,
                                  String outcome,
                                  Map<String,Object> args,
                                  JahiaUser user)

addWorkflowRule

public void addWorkflowRule(JCRNodeWrapper node,
                            WorkflowDefinition workflow)
                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

addComment

public void addComment(String processId,
                       String provider,
                       String comment,
                       String user)

getWorkflowTask

public WorkflowTask getWorkflowTask(String taskId,
                                    String provider,
                                    Locale displayLocale)

getHistoryWorkflow

public HistoryWorkflow getHistoryWorkflow(String id,
                                          String provider,
                                          Locale uiLocale)

getHistoryWorkflows

public List<HistoryWorkflow> getHistoryWorkflows(JCRNodeWrapper node,
                                                 Locale uiLocale)

Returns a list of process instance history records for the specified node. This method also returns "active" (i.e. not completed) workflow process instance.

Parameters:

node - the JCR node to retrieve history records for

uiLocale - the current UI locale

Returns:

a list of process instance history records for the specified node

getHistoryWorkflowsByPath

public List<HistoryWorkflow> getHistoryWorkflowsByPath(String path,
                                                       Locale locale)

Returns a list of process instance history records for the specified path. This method also returns "active" (i.e. not completed) workflow process instance.

Parameters:

path - the Path of the node to retrieve history records for

locale -

Returns:

a list of process instance history records for the specified node

getHistoryWorkflowTasks

public List<HistoryWorkflowTask> getHistoryWorkflowTasks(String workflowProcessId,
                                                         String providerKey,
                                                         Locale uiLocale)

Returns a list of history records for workflow tasks. This method also returns not completed tasks.

Parameters:

workflowProcessId - the process instance ID

providerKey - the workflow provider key

uiLocale - current UI display locale

Returns:

a list of history records for workflow tasks

lookupProvider

protected WorkflowProvider lookupProvider(String key)

hasActiveWorkflowForType

public boolean hasActiveWorkflowForType(JCRNodeWrapper node,
                                        String type)

This method list all currently active workflow for the specified node.

Parameters:

node -

type -

Returns:

A list of active workflows per provider

addWorkflowRule

public void addWorkflowRule(JCRNodeWrapper node,
                            String wfName)
                     throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getWorkflowRuleForAction

public WorkflowRule getWorkflowRuleForAction(JCRNodeWrapper objectNode,
                                             boolean checkPermission,
                                             String action)
                                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getWorkflowRules

public Collection<WorkflowRule> getWorkflowRules(JCRNodeWrapper objectNode)

onApplicationEvent

public void onApplicationEvent(JahiaTemplateManagerService.ModuleDeployedOnSiteEvent event)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<JahiaTemplateManagerService.ModuleDeployedOnSiteEvent>

getWorkflow

public Workflow getWorkflow(String provider,
                            String id,
                            Locale displayLocale)

getWorkflowDefinition

public WorkflowDefinition getWorkflowDefinition(String provider,
                                                String id,
                                                Locale locale)

getWorkflowRegistration

public WorklowTypeRegistration getWorkflowRegistration(String definitionKey)

getWorkflowType

public String getWorkflowType(WorkflowDefinition def)

getFormForAction

public String getFormForAction(String definitionKey,
                               String action)

getModuleForWorkflow

public String getModuleForWorkflow(String key)

getTypesOfWorkflow

public Set<String> getTypesOfWorkflow()

deleteProcess

public void deleteProcess(String processId,
                          String provider)

addWorkflowListener

public void addWorkflowListener(WorkflowListener listener)

postProcessBeforeInitialization

public Object postProcessBeforeInitialization(Object bean,
                                              String beanName)

Specified by:

postProcessBeforeInitialization in interface org.springframework.beans.factory.config.BeanPostProcessor

postProcessAfterInitialization

public Object postProcessAfterInitialization(Object bean,
                                             String beanName)

Specified by:

postProcessAfterInitialization in interface org.springframework.beans.factory.config.BeanPostProcessor

setJcrTemplate

public void setJcrTemplate(JCRTemplate jcrTemplate)

getObservationManager

public WorkflowObservationManager getObservationManager()

initAfterAllServicesAreStarted

public void initAfterAllServicesAreStarted()

switchReadOnlyMode

public void switchReadOnlyMode(boolean enable)

Description copied from interface: ReadOnlyModeCapable

Enable/disable read-only mode for a specific functional area this ReadOnlyModeCapable is responsible for.

Specified by:

switchReadOnlyMode in interface ReadOnlyModeCapable

Parameters:

enable - true in case the read-only mode should be enabled; false otherwise

getReadOnlyModePriority

public int getReadOnlyModePriority()

Description copied from interface: ReadOnlyModeCapable

Get the priority of the service.

Specified by:

getReadOnlyModePriority in interface ReadOnlyModeCapable

Returns:

the priority of the service; higher priority means earlier invocation of switchReadOnlyMode when switching read only mode on, and later invocation when switching it off