org.finra.herd.service.activiti

Class ActivitiRuntimeHelper

java.lang.Object

org.finra.herd.service.activiti.ActivitiRuntimeHelper

@Component
public class ActivitiRuntimeHelper
extends Object

A helper for activiti's RuntimeService.

This class is distinguished from ActivitiHelper in that it has direct access to a RuntimeService. This class was separated from ActivitiHelper implementation due to a circular dependency introduced if RuntimeService is autowired into ActivitiHelper. The circular dependency is as thus:

RuntimeService -> ProcessEngine -> ProcessEngineConfiguration -> HerdCommandInvoker -> ActivitiHelper -> RuntimeService

So instead, this class breaks the circularity:

RuntimeService -> ProcessEngine -> ProcessEngineConfiguration -> HerdCommandInvoker -> ActivitiHelper ActivitiRuntimeHelper -> RuntimeService

Due to historical reasons, some methods that were previously in ActivitiHelper have been moved into this class.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TASK_STATUS_ERROR
static String	TASK_STATUS_SUCCESS
static String	TASK_VARIABLE_MARKER
static String	VARIABLE_ERROR_MESSAGE
static String	VARIABLE_STATUS

Constructor Summary

Constructors

Constructor and Description
ActivitiRuntimeHelper()

Method Summary

Modifier and Type	Method and Description
String	buildTaskWorkflowVariableName(String activitiId, String variableName) Builds a workflow variable name based on the template.
void	setTaskErrorInWorkflow(org.activiti.engine.delegate.DelegateExecution execution, String errorMessage, Exception exception) Sets the task error status and message in workflow variables.
void	setTaskSuccessInWorkflow(org.activiti.engine.delegate.DelegateExecution execution) Sets the task success status in a workflow variable.
void	setTaskWorkflowVariable(org.activiti.engine.delegate.DelegateExecution execution, String variableName, Object variableValue) Sets a workflow variable name based on the template.
void	setTaskWorkflowVariable(String executionId, String activitiId, String variableName, Object variableValue) Sets the workflow variable whose name references the task which produced the variable.
void	signal(String processInstanceId, String signalTaskId) Signals a task by its process instance ID and the ID of the task to signal.

Methods inherited from class java.lang.Object

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

Field Detail

VARIABLE_STATUS

public static final String VARIABLE_STATUS

See Also:

Constant Field Values

VARIABLE_ERROR_MESSAGE

public static final String VARIABLE_ERROR_MESSAGE

See Also:

Constant Field Values

TASK_STATUS_SUCCESS

public static final String TASK_STATUS_SUCCESS

See Also:

Constant Field Values

TASK_STATUS_ERROR

public static final String TASK_STATUS_ERROR

See Also:

Constant Field Values

TASK_VARIABLE_MARKER

public static final String TASK_VARIABLE_MARKER

See Also:

Constant Field Values

Constructor Detail

ActivitiRuntimeHelper

public ActivitiRuntimeHelper()

Method Detail

signal

public void signal(String processInstanceId,
                   String signalTaskId)

Signals a task by its process instance ID and the ID of the task to signal.

Parameters:

processInstanceId - The process instance ID of the waiting task.

signalTaskId - The ID of the task to signal.

setTaskWorkflowVariable

public void setTaskWorkflowVariable(String executionId,
                                    String activitiId,
                                    String variableName,
                                    Object variableValue)

Sets the workflow variable whose name references the task which produced the variable. This method will automatically generate and concatenate a name to the variable name which can help reference the task which produces the variable.

Parameters:

executionId - The execution ID

activitiId - The task's ID

variableName - Name of the variable without the task reference

variableValue - The value of the variable.

setTaskWorkflowVariable

public void setTaskWorkflowVariable(org.activiti.engine.delegate.DelegateExecution execution,
                                    String variableName,
                                    Object variableValue)

Sets a workflow variable name based on the template.

Parameters:

execution - the workflow execution

variableName - the variable name

variableValue - the variable value

setTaskSuccessInWorkflow

public void setTaskSuccessInWorkflow(org.activiti.engine.delegate.DelegateExecution execution)

Sets the task success status in a workflow variable.

Parameters:

execution - the workflow execution.

setTaskErrorInWorkflow

public void setTaskErrorInWorkflow(org.activiti.engine.delegate.DelegateExecution execution,
                                   String errorMessage,
                                   Exception exception)

Sets the task error status and message in workflow variables.

Parameters:

execution - the workflow execution.

errorMessage - the error message.

exception - an optional exception that caused the error.

buildTaskWorkflowVariableName

public String buildTaskWorkflowVariableName(String activitiId,
                                            String variableName)

Builds a workflow variable name based on the template.

Parameters:

activitiId - activitiId

variableName - the variable name

Returns:

the workflow variable name