org.mule.module.jbpm

Class Jbpm

java.lang.Object

org.mule.module.jbpm.Jbpm

All Implemented Interfaces:

org.mule.api.lifecycle.Disposable, org.mule.api.lifecycle.Initialisable, org.mule.api.NameableObject, org.mule.api.NamedObject, BPMS

public class Jbpm
extends Object
implements BPMS, org.mule.api.lifecycle.Initialisable, org.mule.api.lifecycle.Disposable

An implementation of Mule's generic BPMS interface for JBoss jBPM.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	containerManaged Indicates whether jBPM has been instantiated by Mule (false) or was passed in from somewhere else (true).
protected static org.slf4j.Logger	log
static int	PROCESS_CREATION_WAIT Given the multi-threaded nature of Mule, sometimes a response message will arrive to advance the process before the creation of the process has fully terminated (e.g., during in-memory unit tests).
static String	PROCESS_ENDED
protected org.jbpm.api.ProcessEngine	processEngine The initialized jBPM ProcessEngine.

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
Jbpm() Creates the Mule wrapper for jBPM
Jbpm(org.jbpm.api.ProcessEngine processEngine, Properties processDefinitions) Creates the Mule wrapper for jBPM
Jbpm(String configurationResource, Properties processDefinitions) Creates the Mule wrapper for jBPM

Method Summary

Methods

Modifier and Type	Method and Description
void	abortProcess(Object processInstanceId) Delete a process instance.
Object	advanceProcess(Object executionId) Advance a process instance one step.
Object	advanceProcess(Object executionId, Object signalName, Map variables) Advance a process instance one step.
void	completeTask(org.jbpm.api.task.Task task)
void	completeTask(org.jbpm.api.task.Task task, String outcome, Map variables)
void	deployProcess(String processDefinitionFile)
void	deployProcessFromStream(String resourceName, InputStream processDefinition)
void	dispose()
String	getConfigurationResource()
Object	getId(Object process)
String	getName()
Properties	getProcessDefinitions()
org.jbpm.api.ProcessEngine	getProcessEngine()
Object	getState(Object process)
static String	getState(org.jbpm.api.ProcessInstance processInstance)
boolean	hasEnded(Object process)
void	initialise()
boolean	isProcess(Object obj)
Object	lookupProcess(Object processId) Look up an already-running process instance.
void	setConfigurationResource(String configurationResource)
void	setMessageService(MessageService msgService)
void	setName(String name)
void	setProcessDefinitions(Properties processDefinitions)
void	setProcessEngine(org.jbpm.api.ProcessEngine processEngine)
Object	startProcess(Object processDefinitionKey) Start a new process.
Object	startProcess(Object processDefinitionKey, Object signalName, Map variables) Start a new process.
void	undeployProcess(String resource)
Object	updateProcess(Object executionId, Map variables) Update the variables for an execution.

Methods inherited from class java.lang.Object

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

Field Detail

processEngine

protected org.jbpm.api.ProcessEngine processEngine

The initialized jBPM ProcessEngine.

containerManaged

protected boolean containerManaged

Indicates whether jBPM has been instantiated by Mule (false) or was passed in from somewhere else (true).

PROCESS_ENDED

public static final String PROCESS_ENDED

See Also:

Constant Field Values

PROCESS_CREATION_WAIT

public static final int PROCESS_CREATION_WAIT

Given the multi-threaded nature of Mule, sometimes a response message will arrive to advance the process before the creation of the process has fully terminated (e.g., during in-memory unit tests). After this amount of time (in ms), we stop waiting and assume there must be some other problem.

See Also:

Constant Field Values

log

protected static final org.slf4j.Logger log

Constructor Detail

Jbpm

public Jbpm()

Creates the Mule wrapper for jBPM

Jbpm

public Jbpm(String configurationResource,
    Properties processDefinitions)

Creates the Mule wrapper for jBPM

Parameters:

configurationResource - - The configuration file for jBPM, default is "jbpm.cfg.xml" if not specified.

processDefinitions - - A list of process definitions to load into jBPM upon initialization.

Jbpm

public Jbpm(org.jbpm.api.ProcessEngine processEngine,
    Properties processDefinitions)

Creates the Mule wrapper for jBPM

Parameters:

processEngine - The already-initialized jBPM ProcessEngine. This is useful if you use Spring to configure your jBPM instance.

Method Detail

initialise

public void initialise()

Specified by:

initialise in interface org.mule.api.lifecycle.Initialisable

dispose

public void dispose()

Specified by:

dispose in interface org.mule.api.lifecycle.Disposable

setMessageService

public void setMessageService(MessageService msgService)

Specified by:

setMessageService in interface BPMS

startProcess

public Object startProcess(Object processDefinitionKey)
                    throws Exception

Start a new process.

Returns:

the newly-created ProcessInstance

Throws:

Exception

startProcess

public Object startProcess(Object processDefinitionKey,
                  Object signalName,
                  Map variables)
                    throws Exception

Start a new process.

Specified by:

startProcess in interface BPMS

Returns:

the newly-created ProcessInstance

Throws:

Exception

advanceProcess

public Object advanceProcess(Object executionId)
                      throws Exception

Advance a process instance one step.

Returns:

the updated ProcessInstance

Throws:

Exception

advanceProcess

public Object advanceProcess(Object executionId,
                    Object signalName,
                    Map variables)
                      throws Exception

Advance a process instance one step.

Specified by:

advanceProcess in interface BPMS

Parameters:

variables - - optional process variables/parameters to set

Returns:

the updated ProcessInstance

Throws:

Exception

updateProcess

public Object updateProcess(Object executionId,
                   Map variables)
                     throws Exception

Update the variables for an execution.

Specified by:

updateProcess in interface BPMS

Returns:

the updated ProcessInstance

Throws:

Exception

abortProcess

public void abortProcess(Object processInstanceId)
                  throws Exception

Delete a process instance.

Specified by:

abortProcess in interface BPMS

Throws:

Exception

isProcess

public boolean isProcess(Object obj)
                  throws Exception

Specified by:

isProcess in interface BPMS

Throws:

Exception

getId

public Object getId(Object process)
             throws Exception

Specified by:

getId in interface BPMS

Throws:

Exception

getState

public Object getState(Object process)
                throws Exception

Specified by:

getState in interface BPMS

Throws:

Exception

getState

public static String getState(org.jbpm.api.ProcessInstance processInstance)
                       throws Exception

Throws:

Exception

hasEnded

public boolean hasEnded(Object process)
                 throws Exception

Specified by:

hasEnded in interface BPMS

Throws:

Exception

lookupProcess

public Object lookupProcess(Object processId)
                     throws Exception

Look up an already-running process instance.

Specified by:

lookupProcess in interface BPMS

Returns:

the ProcessInstance

Throws:

Exception

deployProcess

public void deployProcess(String processDefinitionFile)
                   throws IOException

Specified by:

deployProcess in interface BPMS

Throws:

IOException

deployProcessFromStream

public void deployProcessFromStream(String resourceName,
                           InputStream processDefinition)
                             throws IOException

Throws:

IOException

undeployProcess

public void undeployProcess(String resource)
                     throws Exception

Specified by:

undeployProcess in interface BPMS

Throws:

Exception

completeTask

public void completeTask(org.jbpm.api.task.Task task)

completeTask

public void completeTask(org.jbpm.api.task.Task task,
                String outcome,
                Map variables)

getProcessEngine

public org.jbpm.api.ProcessEngine getProcessEngine()

setProcessEngine

public void setProcessEngine(org.jbpm.api.ProcessEngine processEngine)

getConfigurationResource

public String getConfigurationResource()

setConfigurationResource

public void setConfigurationResource(String configurationResource)

getProcessDefinitions

public Properties getProcessDefinitions()

setProcessDefinitions

public void setProcessDefinitions(Properties processDefinitions)

setName

public void setName(String name)

Specified by:

setName in interface org.mule.api.NameableObject

getName

public String getName()

Specified by:

getName in interface org.mule.api.NamedObject