org.finra.herd.service.activiti.task

Class BaseJavaDelegate

java.lang.Object

org.finra.herd.service.activiti.task.BaseJavaDelegate

All Implemented Interfaces:

org.activiti.engine.delegate.JavaDelegate

Direct Known Subclasses:

AddBusinessObjectDataStorageFiles, AddBusinessObjectDataStorageUnit, AddEmrMasterSecurityGroup, BaseAddEmrStep, BaseEmrCluster, CheckBusinessObjectDataAvailability, CheckBusinessObjectDataAvailabilityCollection, CheckBusinessObjectDataAvailabilityMultiplePartitions, CreateBusinessObjectDataAttribute, DeleteBusinessObjectDataAttribute, ExecuteJdbc, GenerateBusinessObjectDataDdl, GenerateBusinessObjectDataDdlCollection, GenerateBusinessObjectFormatDdl, GenerateBusinessObjectFormatDdlCollection, GetBusinessObjectData, GetBusinessObjectDataAttribute, GetBusinessObjectDataAttributes, GetBusinessObjectDataStatus, GetBusinessObjectDefinition, GetBusinessObjectFormat, GetExpectedPartitionValue, GetS3KeyPrefix, InvalidateUnregisteredBusinessObjectData, LogVariables, RegisterBusinessObjectData, SearchBusinessObjectData, UpdateBusinessObjectDataAttribute, UpdateBusinessObjectDataStatus, UpdateBusinessObjectDataStorageUnitStatus

public abstract class BaseJavaDelegate
extends Object
implements org.activiti.engine.delegate.JavaDelegate

This class handles the core flow for our Activiti "JavaDelegate" tasks and calls back sub-classes for the actual task implementation. All of our custom tasks should extend this class.

WARNING: When Java Delegates make service calls, those service calls should all take place within a new transaction to ensure Activiti can set workflow variables upon errors and have those workflow variables committed to the database. If they don't take place within a new transaction, it is possible that the calling code could roll back the entire transaction and the workflow variables wouldn't get updated. Service methods can occur within a new transaction by annotating the service method with "@Transactional(propagation = Propagation.REQUIRES_NEW)". Note that JUnit invocations of those same services don't require their own transaction since we usually want JUnits to roll back all their data. For those situations, we can provide an alternate service implementation that extends the normal service implementation and simply doesn't annotate the service method with the "requires new" annotation.

Field Summary

Fields

Modifier and Type	Field and Description
protected ActivitiHelper	activitiHelper
protected ActivitiRuntimeHelper	activitiRuntimeHelper
protected ActivitiService	activitiService
protected ConfigurationDaoHelper	configurationDaoHelper
protected HerdStringHelper	daoHelper
protected HerdStringHelper	herdStringHelper
protected JobDefinitionDao	jobDefinitionDao
protected JobDefinitionDaoHelper	jobDefinitionDaoHelper
protected JobDefinitionHelper	jobDefinitionHelper
protected JsonHelper	jsonHelper
protected UserNamespaceAuthorizationHelper	userNamespaceAuthorizationHelper
static String	VARIABLE_JSON_RESPONSE Variable that is set in workflow for the json response.
protected XmlHelper	xmlHelper

Constructor Summary

Constructors

Constructor and Description
BaseJavaDelegate()

Method Summary

Modifier and Type	Method and Description
void	execute(org.activiti.engine.delegate.DelegateExecution execution) This is what Activiti will call to execute this task.
abstract void	executeImpl(org.activiti.engine.delegate.DelegateExecution execution) The execution implementation.
protected ApplicationUser	getApplicationUser(org.activiti.engine.delegate.DelegateExecution execution) Retrieves application user per last updater of the current process instance's job definition.
protected <T> T	getRequestObject(String contentType, String requestString, Class xsdClass) Converts the request string to xsd object.
protected void	handleException(org.activiti.engine.delegate.DelegateExecution execution, Exception exception) Handles any exception thrown by an Activiti task.
boolean	isSpringInitialized()
protected void	logInputParameters(org.activiti.engine.delegate.DelegateExecution execution) Loops through all process variables and logs them.
protected void	logTaskExecutionTime(long taskBeginTimeMillis, boolean taskSuccessFlag) Logs the Activiti task execution time
void	setJsonResponseAsWorkflowVariable(Object responseObject, org.activiti.engine.delegate.DelegateExecution execution) Sets a JSON response object as a workflow variable.
void	setJsonResponseAsWorkflowVariable(Object responseObject, String executionId, String activitiId)
protected void	setSecurityContext(ApplicationUser applicationUser) Sets the security context per last updater of the current process instance's job definition.
void	setSpringInitialized(boolean springInitialized)
protected void	setTaskWorkflowVariable(org.activiti.engine.delegate.DelegateExecution execution, String variableName, Object variableValue) Sets the workflow variable with task id prefixed.
protected void	setTaskWorkflowVariable(String executionId, String activitiId, String variableName, Object variableValue)

Methods inherited from class java.lang.Object

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

Field Detail

activitiService

@Autowired
protected ActivitiService activitiService

configurationDaoHelper

@Autowired
protected ConfigurationDaoHelper configurationDaoHelper

daoHelper

@Autowired
protected HerdStringHelper daoHelper

herdStringHelper

@Autowired
protected HerdStringHelper herdStringHelper

jobDefinitionDao

@Autowired
protected JobDefinitionDao jobDefinitionDao

jobDefinitionDaoHelper

@Autowired
protected JobDefinitionDaoHelper jobDefinitionDaoHelper

jobDefinitionHelper

@Autowired
protected JobDefinitionHelper jobDefinitionHelper

jsonHelper

@Autowired
protected JsonHelper jsonHelper

userNamespaceAuthorizationHelper

@Autowired
protected UserNamespaceAuthorizationHelper userNamespaceAuthorizationHelper

xmlHelper

@Autowired
protected XmlHelper xmlHelper

VARIABLE_JSON_RESPONSE

public static final String VARIABLE_JSON_RESPONSE

Variable that is set in workflow for the json response.

See Also:

Constant Field Values

activitiHelper

@Autowired
protected ActivitiHelper activitiHelper

activitiRuntimeHelper

@Autowired
protected ActivitiRuntimeHelper activitiRuntimeHelper

Constructor Detail

BaseJavaDelegate

public BaseJavaDelegate()

Method Detail

executeImpl

public abstract void executeImpl(org.activiti.engine.delegate.DelegateExecution execution)
                          throws Exception

The execution implementation. Sub-classes should override this method for their specific task implementation.

Parameters:

execution - the delegation execution.

Throws:

Exception - when a problem is encountered. A BpmnError should be thrown when there is a problem that should be handled by the workflow. All other errors will be considered system errors that will be logged.

execute

public final void execute(org.activiti.engine.delegate.DelegateExecution execution)
                   throws Exception

This is what Activiti will call to execute this task. Sub-classes should override the executeImpl method to supply the actual implementation.

Specified by:

execute in interface org.activiti.engine.delegate.JavaDelegate

Parameters:

execution - the execution information.

Throws:

Exception - if any errors were encountered.

logTaskExecutionTime

protected void logTaskExecutionTime(long taskBeginTimeMillis,
                                    boolean taskSuccessFlag)

Logs the Activiti task execution time

Parameters:

taskBeginTimeMillis - the task begin time in millisecond

taskSuccessFlag - the success flag for the task

setSecurityContext

protected void setSecurityContext(ApplicationUser applicationUser)

Sets the security context per last updater of the current process instance's job definition.

Parameters:

applicationUser - the application user

getApplicationUser

protected ApplicationUser getApplicationUser(org.activiti.engine.delegate.DelegateExecution execution)

Retrieves application user per last updater of the current process instance's job definition.

Parameters:

execution - the delegate execution

Returns:

the application user

handleException

protected void handleException(org.activiti.engine.delegate.DelegateExecution execution,
                               Exception exception)
                        throws Exception

Handles any exception thrown by an Activiti task.

Parameters:

execution - The execution which identifies the task.

exception - The exception that has been thrown

Throws:

Exception - Some exceptions may choose to bubble up the exception

setJsonResponseAsWorkflowVariable

public void setJsonResponseAsWorkflowVariable(Object responseObject,
                                              org.activiti.engine.delegate.DelegateExecution execution)
                                       throws Exception

Sets a JSON response object as a workflow variable.

Parameters:

responseObject - the JSON object.

execution - the delegate execution.

Throws:

Exception - if any problems were encountered.

setJsonResponseAsWorkflowVariable

public void setJsonResponseAsWorkflowVariable(Object responseObject,
                                              String executionId,
                                              String activitiId)
                                       throws Exception

Throws:

Exception

isSpringInitialized

public boolean isSpringInitialized()

setSpringInitialized

public void setSpringInitialized(boolean springInitialized)

setTaskWorkflowVariable

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

Sets the workflow variable with task id prefixed.

Parameters:

execution - the delegate execution.

variableName - the variable name

variableValue - the variable value

setTaskWorkflowVariable

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

getRequestObject

protected <T> T getRequestObject(String contentType,
                                 String requestString,
                                 Class xsdClass)

Converts the request string to xsd object.

Type Parameters:

T - the type of the returned object.

Parameters:

contentType - the content type "xml" or "json"

requestString - the request string

xsdClass - the xsd class of the object to convert to

Returns:

the request object.

logInputParameters

protected void logInputParameters(org.activiti.engine.delegate.DelegateExecution execution)

Loops through all process variables and logs them.

Parameters:

execution - the execution information