org.jahia.services.workflow.jbpm

Class JBPM6WorkflowProvider

java.lang.Object

org.jahia.services.workflow.jbpm.JBPM6WorkflowProvider

All Implemented Interfaces:

JahiaAfterInitializationService, WorkflowObservationManagerAware, WorkflowProvider

public class JBPM6WorkflowProvider
extends Object
implements WorkflowProvider, WorkflowObservationManagerAware, JahiaAfterInitializationService

jBPM 6 Workflow Provider implementation

Field Summary

Fields

Modifier and Type	Field and Description
static List<org.kie.api.task.model.Status>	OPEN_STATUS_LIST
static List<org.kie.api.task.model.Status>	OPEN_STATUS_LIST_NON_RESERVED
static List<org.kie.api.task.model.Status>	RESERVED_STATUS_LIST

Constructor Summary

Constructors

Constructor and Description
JBPM6WorkflowProvider()

Method Summary

Modifier and Type	Method and Description
void	abortProcess(String processId)
void	addComment(String processId, String comment, String user)
void	addResource(org.springframework.core.io.Resource kieResource)
void	assignTask(String taskId, JahiaUser user)
void	completeTask(String taskId, JahiaUser jahiaUser, String outcome, Map<String,Object> args)
void	deleteProcess(String processId)
List<Workflow>	getActiveWorkflowsInformations(List<String> processIds, Locale uiLocale)
Set<WorkflowAction>	getAvailableActions(String processId, Locale uiLocale) Returns the next possible connections for a given process (usually only for User tasks).
List<WorkflowDefinition>	getAvailableWorkflows(Locale uiLocale)
static String	getDecodedProcessKey(String processKey) This method is used to decode an ISO9075-encoded process key, since these need to be encoded when used in XML files or even in some attribute values that enforce XML id formats.
static String	getEncodedProcessKey(String processKey) This method is used to handle process IDs that start with a number, in order to retain compatibility with older versions of Jahia that used process IDs that start with such characters
List<HistoryWorkflow>	getHistoryWorkflows(List<String> processIds, Locale uiLocale) Returns a list of process instance history records for the specified process IDs.
List<HistoryWorkflow>	getHistoryWorkflowsForNode(String nodeId, Locale uiLocale)
List<HistoryWorkflow>	getHistoryWorkflowsForPath(String path, Locale uiLocale)
List<HistoryWorkflowTask>	getHistoryWorkflowTasks(String processId, Locale uiLocale) Returns a list of history records for workflow tasks.
static JBPM6WorkflowProvider	getInstance()
String	getKey()
org.kie.api.builder.KieRepository	getKieRepository()
List<WorkflowTask>	getTasksForUser(JahiaUser user, Locale uiLocale)
Workflow	getWorkflow(String processId, Locale uiLocale)
WorkflowDefinition	getWorkflowDefinitionByKey(String key, Locale uiLocale)
WorkflowService	getWorkflowService()
List<Workflow>	getWorkflowsForDefinition(String definition, Locale uiLocale)
List<Workflow>	getWorkflowsForUser(JahiaUser user, Locale uiLocale)
WorkflowTask	getWorkflowTask(String taskId, Locale uiLocale)
void	initAfterAllServicesAreStarted()
boolean	isInitialized()
void	recompilePackages()
void	registerTaskLifeCycleEventListener(String name, AbstractTaskLifeCycleEventListener taskAssignmentListener)
void	registerWorkItemHandler(String name, org.kie.api.runtime.process.WorkItemHandler workItemHandler)
void	removeResource(org.springframework.core.io.Resource kieResource)
void	setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)
void	setGroupManager(JahiaGroupManagerService groupManager)
void	setJahiaUserGroupCallback(JahiaUserGroupCallback jahiaUserGroupCallback)
void	setJbpmServicesPersistenceManager(org.jbpm.shared.services.impl.JbpmServicesPersistenceManagerImpl jbpmServicesPersistenceManager)
void	setKey(String key)
void	setPeopleAssignmentPipeline(Pipeline peopleAssignmentPipeline)
void	setPlatformTransactionManager(org.springframework.transaction.support.AbstractPlatformTransactionManager platformTransactionManager)
void	setSchedulerService(SchedulerService schedulerService)
void	setSharedEntityManager(javax.persistence.EntityManager em)
void	setUserManager(JahiaUserManagerService userManager)
void	setWorkflowObservationManager(WorkflowObservationManager observationManager)
void	setWorkflowService(WorkflowService workflowService)
void	start()
String	startProcess(String processKey, Map<String,Object> args) Start a process instance previously registered
void	stop()
AbstractTaskLifeCycleEventListener	unregisterTaskLifeCycleEventListener(String name)
org.kie.api.runtime.process.WorkItemHandler	unregisterWorkItemHandler(String name)

Methods inherited from class java.lang.Object

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

Field Detail

OPEN_STATUS_LIST

public static final List<org.kie.api.task.model.Status> OPEN_STATUS_LIST

OPEN_STATUS_LIST_NON_RESERVED

public static final List<org.kie.api.task.model.Status> OPEN_STATUS_LIST_NON_RESERVED

RESERVED_STATUS_LIST

public static final List<org.kie.api.task.model.Status> RESERVED_STATUS_LIST

Constructor Detail

JBPM6WorkflowProvider

public JBPM6WorkflowProvider()

Method Detail

getInstance

public static JBPM6WorkflowProvider getInstance()

setKey

public void setKey(String key)

getWorkflowService

public WorkflowService getWorkflowService()

setWorkflowService

public void setWorkflowService(WorkflowService workflowService)

setWorkflowObservationManager

public void setWorkflowObservationManager(WorkflowObservationManager observationManager)

Specified by:

setWorkflowObservationManager in interface WorkflowObservationManagerAware

setGroupManager

public void setGroupManager(JahiaGroupManagerService groupManager)

setUserManager

public void setUserManager(JahiaUserManagerService userManager)

setPeopleAssignmentPipeline

public void setPeopleAssignmentPipeline(Pipeline peopleAssignmentPipeline)

setJahiaUserGroupCallback

public void setJahiaUserGroupCallback(JahiaUserGroupCallback jahiaUserGroupCallback)

getKieRepository

public org.kie.api.builder.KieRepository getKieRepository()

setPlatformTransactionManager

public void setPlatformTransactionManager(org.springframework.transaction.support.AbstractPlatformTransactionManager platformTransactionManager)

setEntityManagerFactory

public void setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)

setSharedEntityManager

public void setSharedEntityManager(javax.persistence.EntityManager em)

setJbpmServicesPersistenceManager

public void setJbpmServicesPersistenceManager(org.jbpm.shared.services.impl.JbpmServicesPersistenceManagerImpl jbpmServicesPersistenceManager)

registerWorkItemHandler

public void registerWorkItemHandler(String name,
                                    org.kie.api.runtime.process.WorkItemHandler workItemHandler)

unregisterWorkItemHandler

public org.kie.api.runtime.process.WorkItemHandler unregisterWorkItemHandler(String name)

registerTaskLifeCycleEventListener

public void registerTaskLifeCycleEventListener(String name,
                                               AbstractTaskLifeCycleEventListener taskAssignmentListener)

unregisterTaskLifeCycleEventListener

public AbstractTaskLifeCycleEventListener unregisterTaskLifeCycleEventListener(String name)

start

public void start()

stop

public void stop()

getKey

public String getKey()

Specified by:

getKey in interface WorkflowProvider

getAvailableWorkflows

public List<WorkflowDefinition> getAvailableWorkflows(Locale uiLocale)

Specified by:

getAvailableWorkflows in interface WorkflowProvider

getWorkflowDefinitionByKey

public WorkflowDefinition getWorkflowDefinitionByKey(String key,
                                                     Locale uiLocale)

Specified by:

getWorkflowDefinitionByKey in interface WorkflowProvider

getActiveWorkflowsInformations

public List<Workflow> getActiveWorkflowsInformations(List<String> processIds,
                                                     Locale uiLocale)

Specified by:

getActiveWorkflowsInformations in interface WorkflowProvider

startProcess

public String startProcess(String processKey,
                           Map<String,Object> args)

Description copied from interface: WorkflowProvider

Start a process instance previously registered

Specified by:

startProcess in interface WorkflowProvider

Returns:

the process instance identifier

abortProcess

public void abortProcess(String processId)

Specified by:

abortProcess in interface WorkflowProvider

getWorkflow

public Workflow getWorkflow(String processId,
                            Locale uiLocale)

Specified by:

getWorkflow in interface WorkflowProvider

getAvailableActions

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

Description copied from interface: WorkflowProvider

Returns the next possible connections for a given process (usually only for User tasks).

Specified by:

getAvailableActions in interface WorkflowProvider

uiLocale - current UI display locale

Returns:

getTasksForUser

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

Specified by:

getTasksForUser in interface WorkflowProvider

getWorkflowsForDefinition

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

Specified by:

getWorkflowsForDefinition in interface WorkflowProvider

getWorkflowsForUser

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

Specified by:

getWorkflowsForUser in interface WorkflowProvider

assignTask

public void assignTask(String taskId,
                       JahiaUser user)

Specified by:

assignTask in interface WorkflowProvider

completeTask

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

Specified by:

completeTask in interface WorkflowProvider

addComment

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

Specified by:

addComment in interface WorkflowProvider

getWorkflowTask

public WorkflowTask getWorkflowTask(String taskId,
                                    Locale uiLocale)

Specified by:

getWorkflowTask in interface WorkflowProvider

getHistoryWorkflowsForNode

public List<HistoryWorkflow> getHistoryWorkflowsForNode(String nodeId,
                                                        Locale uiLocale)

Specified by:

getHistoryWorkflowsForNode in interface WorkflowProvider

getHistoryWorkflowsForPath

public List<HistoryWorkflow> getHistoryWorkflowsForPath(String path,
                                                        Locale uiLocale)

Specified by:

getHistoryWorkflowsForPath in interface WorkflowProvider

getHistoryWorkflows

public List<HistoryWorkflow> getHistoryWorkflows(List<String> processIds,
                                                 Locale uiLocale)

Description copied from interface: WorkflowProvider

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

Specified by:

getHistoryWorkflows in interface WorkflowProvider

Parameters:

processIds - list of process IDs to retrieve history records for

uiLocale - the UI locale

Returns:

a list of process instance history records for the specified process IDs

getHistoryWorkflowTasks

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

Description copied from interface: WorkflowProvider

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

Specified by:

getHistoryWorkflowTasks in interface WorkflowProvider

Parameters:

processId - the process instance ID

uiLocale - the UI locale

Returns:

a list of history records for workflow tasks

deleteProcess

public void deleteProcess(String processId)

Specified by:

deleteProcess in interface WorkflowProvider

getEncodedProcessKey

public static String getEncodedProcessKey(String processKey)

This method is used to handle process IDs that start with a number, in order to retain compatibility with older versions of Jahia that used process IDs that start with such characters

Parameters:

processKey -

Returns:

getDecodedProcessKey

public static String getDecodedProcessKey(String processKey)

This method is used to decode an ISO9075-encoded process key, since these need to be encoded when used in XML files or even in some attribute values that enforce XML id formats.

Parameters:

processKey -

Returns:

addResource

public void addResource(org.springframework.core.io.Resource kieResource)
                 throws IOException

Throws:

IOException

removeResource

public void removeResource(org.springframework.core.io.Resource kieResource)
                    throws IOException

Throws:

IOException

recompilePackages

public void recompilePackages()

isInitialized

public boolean isInitialized()

initAfterAllServicesAreStarted

public void initAfterAllServicesAreStarted()
                                    throws JahiaInitializationException

Specified by:

initAfterAllServicesAreStarted in interface JahiaAfterInitializationService

Throws:

JahiaInitializationException

setSchedulerService

public void setSchedulerService(SchedulerService schedulerService)

Parameters:

schedulerService - the schedulerService to set