Package org.activiti.engine.impl.bpmn.helper

Class ClassDelegate

java.lang.Object

org.activiti.engine.impl.bpmn.behavior.FlowNodeActivityBehavior

org.activiti.engine.impl.bpmn.behavior.AbstractBpmnActivityBehavior

org.activiti.engine.impl.bpmn.helper.ClassDelegate

All Implemented Interfaces:

Serializable, BaseExecutionListener, BaseTaskListener, CustomPropertiesResolver, ExecutionListener, TaskListener, TransactionDependentExecutionListener, TransactionDependentTaskListener, ActivityBehavior, SubProcessActivityBehavior, TriggerableActivityBehavior

public class ClassDelegate
extends AbstractBpmnActivityBehavior
implements TaskListener, ExecutionListener, TransactionDependentExecutionListener, TransactionDependentTaskListener, SubProcessActivityBehavior, CustomPropertiesResolver

Helper class for bpmn constructs that allow class delegation. This class will lazily instantiate the referenced classes when needed at runtime.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ActivityBehavior	activityBehaviorInstance
protected String	className
protected CustomPropertiesResolver	customPropertiesResolverInstance
protected ExecutionListener	executionListenerInstance
protected List<FieldDeclaration>	fieldDeclarations
protected List<MapExceptionEntry>	mapExceptions
protected String	serviceTaskId
protected Expression	skipExpression
protected TaskListener	taskListenerInstance
protected TransactionDependentExecutionListener	transactionDependentExecutionListenerInstance
protected TransactionDependentTaskListener	transactionDependentTaskListenerInstance

Fields inherited from class org.activiti.engine.impl.bpmn.behavior.AbstractBpmnActivityBehavior

multiInstanceActivityBehavior

Fields inherited from class org.activiti.engine.impl.bpmn.behavior.FlowNodeActivityBehavior

bpmnActivityBehavior

Fields inherited from interface org.activiti.engine.delegate.BaseExecutionListener

EVENTNAME_END, EVENTNAME_START, EVENTNAME_TAKE

Fields inherited from interface org.activiti.engine.delegate.BaseTaskListener

EVENTNAME_ALL_EVENTS, EVENTNAME_ASSIGNMENT, EVENTNAME_COMPLETE, EVENTNAME_CREATE, EVENTNAME_DELETE

Fields inherited from interface org.activiti.engine.delegate.TransactionDependentExecutionListener

ON_TRANSACTION_BEFORE_COMMIT, ON_TRANSACTION_COMMITTED, ON_TRANSACTION_ROLLED_BACK

Fields inherited from interface org.activiti.engine.delegate.TransactionDependentTaskListener

ON_TRANSACTION_COMMITTED, ON_TRANSACTION_COMMITTING, ON_TRANSACTION_ROLLED_BACK

Constructor Summary

Constructors

Constructor	Description
ClassDelegate(Class<?> clazz, List<FieldDeclaration> fieldDeclarations)
ClassDelegate(Class<?> clazz, List<FieldDeclaration> fieldDeclarations, Expression skipExpression)
ClassDelegate(String id, String className, List<FieldDeclaration> fieldDeclarations, Expression skipExpression, List<MapExceptionEntry> mapExceptions)
ClassDelegate(String className, List<FieldDeclaration> fieldDeclarations)
ClassDelegate(String className, List<FieldDeclaration> fieldDeclarations, Expression skipExpression)

Method Summary

Modifier and Type	Method	Description
static void	applyFieldDeclaration(List<FieldDeclaration> fieldDeclarations, Object target)
static void	applyFieldDeclaration(List<FieldDeclaration> fieldDeclarations, Object target, boolean throwExceptionOnMissingField)
static void	applyFieldDeclaration(FieldDeclaration declaration, Object target)
static void	applyFieldDeclaration(FieldDeclaration declaration, Object target, boolean throwExceptionOnMissingField)
void	completed(DelegateExecution execution)	called after the process instance is destroyed for this activity to perform its outgoing control flow logic.
void	completing(DelegateExecution execution, DelegateExecution subProcessInstance)	called before the process instance is destroyed to allow this activity to extract data from the sub process instance.
static Object	defaultInstantiateDelegate(Class<?> clazz, List<FieldDeclaration> fieldDeclarations)
static Object	defaultInstantiateDelegate(String className, List<FieldDeclaration> fieldDeclarations)
protected ActivityBehavior	determineBehaviour(ActivityBehavior delegateInstance)
void	execute(DelegateExecution execution)	Default behaviour: just leave the activity with no extra functionality.
static boolean	fieldTypeCompatible(FieldDeclaration declaration, Field field)
protected ActivityBehavior	getActivityBehaviorInstance()
String	getClassName()	returns the class name this ClassDelegate is configured to.
Map<String,Object>	getCustomPropertiesMap(DelegateExecution execution)
protected CustomPropertiesResolver	getCustomPropertiesResolverInstance()
protected ExecutionListener	getExecutionListenerInstance()
protected TaskListener	getTaskListenerInstance()
protected TransactionDependentExecutionListener	getTransactionDependentExecutionListenerInstance()
protected TransactionDependentTaskListener	getTransactionDependentTaskListenerInstance()
protected Object	instantiateDelegate(String className, List<FieldDeclaration> fieldDeclarations)
void	notify(String processInstanceId, String executionId, FlowElement flowElement, Map<String,Object> executionVariables, Map<String,Object> customPropertiesMap)
void	notify(String processInstanceId, String executionId, Task task, Map<String,Object> executionVariables, Map<String,Object> customPropertiesMap)
void	notify(DelegateExecution execution)
void	notify(DelegateTask delegateTask)
void	trigger(DelegateExecution execution, String signalName, Object signalData)

Methods inherited from class org.activiti.engine.impl.bpmn.behavior.AbstractBpmnActivityBehavior

executeCompensateBoundaryEvents, findBoundaryEventsForFlowNode, getMultiInstanceActivityBehavior, getProcessDefinition, hasLoopCharacteristics, hasMultiInstanceCharacteristics, leave, setMultiInstanceActivityBehavior

Methods inherited from class org.activiti.engine.impl.bpmn.behavior.FlowNodeActivityBehavior

leaveIgnoreConditions, parseActivityType

Methods inherited from class java.lang.Object

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

Field Details

serviceTaskId

protected String serviceTaskId

className

protected String className

fieldDeclarations

protected List<FieldDeclaration> fieldDeclarations

executionListenerInstance

protected ExecutionListener executionListenerInstance

transactionDependentExecutionListenerInstance

protected TransactionDependentExecutionListener transactionDependentExecutionListenerInstance

taskListenerInstance

protected TaskListener taskListenerInstance

transactionDependentTaskListenerInstance

protected TransactionDependentTaskListener transactionDependentTaskListenerInstance

activityBehaviorInstance

protected ActivityBehavior activityBehaviorInstance

skipExpression

protected Expression skipExpression

mapExceptions

protected List<MapExceptionEntry> mapExceptions

customPropertiesResolverInstance

protected CustomPropertiesResolver customPropertiesResolverInstance

Constructor Details

ClassDelegate

public ClassDelegate(String className,
 List<FieldDeclaration> fieldDeclarations,
 Expression skipExpression)

ClassDelegate

public ClassDelegate(String id,
 String className,
 List<FieldDeclaration> fieldDeclarations,
 Expression skipExpression,
 List<MapExceptionEntry> mapExceptions)

ClassDelegate

public ClassDelegate(String className,
 List<FieldDeclaration> fieldDeclarations)

ClassDelegate

public ClassDelegate(Class<?> clazz,
 List<FieldDeclaration> fieldDeclarations)

ClassDelegate

public ClassDelegate(Class<?> clazz,
 List<FieldDeclaration> fieldDeclarations,
 Expression skipExpression)

Method Details

notify

public void notify(DelegateExecution execution)

Specified by:

notify in interface ExecutionListener

notify

public void notify(String processInstanceId,
 String executionId,
 FlowElement flowElement,
 Map<String,Object> executionVariables,
 Map<String,Object> customPropertiesMap)

Specified by:

notify in interface TransactionDependentExecutionListener

getCustomPropertiesMap

public Map<String,Object> getCustomPropertiesMap(DelegateExecution execution)

Specified by:

getCustomPropertiesMap in interface CustomPropertiesResolver

notify

public void notify(DelegateTask delegateTask)

Specified by:

notify in interface TaskListener

notify

public void notify(String processInstanceId,
 String executionId,
 Task task,
 Map<String,Object> executionVariables,
 Map<String,Object> customPropertiesMap)

Specified by:

notify in interface TransactionDependentTaskListener

getExecutionListenerInstance

protected ExecutionListener getExecutionListenerInstance()

getTransactionDependentExecutionListenerInstance

protected TransactionDependentExecutionListener getTransactionDependentExecutionListenerInstance()

getCustomPropertiesResolverInstance

protected CustomPropertiesResolver getCustomPropertiesResolverInstance()

getTaskListenerInstance

protected TaskListener getTaskListenerInstance()

getTransactionDependentTaskListenerInstance

protected TransactionDependentTaskListener getTransactionDependentTaskListenerInstance()

execute

public void execute(DelegateExecution execution)

Description copied from class: FlowNodeActivityBehavior

Default behaviour: just leave the activity with no extra functionality.

Specified by:

execute in interface ActivityBehavior

Overrides:

execute in class FlowNodeActivityBehavior

trigger

public void trigger(DelegateExecution execution,
 String signalName,
 Object signalData)

Specified by:

trigger in interface TriggerableActivityBehavior

Overrides:

trigger in class FlowNodeActivityBehavior

completing

public void completing(DelegateExecution execution,
 DelegateExecution subProcessInstance)
                throws Exception

Description copied from interface: SubProcessActivityBehavior

called before the process instance is destroyed to allow this activity to extract data from the sub process instance. No control flow should be done on the execution yet.

Specified by:

completing in interface SubProcessActivityBehavior

Throws:

Exception

completed

public void completed(DelegateExecution execution)
               throws Exception

Description copied from interface: SubProcessActivityBehavior

called after the process instance is destroyed for this activity to perform its outgoing control flow logic.

Specified by:

completed in interface SubProcessActivityBehavior

Throws:

Exception

getActivityBehaviorInstance

protected ActivityBehavior getActivityBehaviorInstance()

determineBehaviour

protected ActivityBehavior determineBehaviour(ActivityBehavior delegateInstance)

instantiateDelegate

protected Object instantiateDelegate(String className,
 List<FieldDeclaration> fieldDeclarations)

defaultInstantiateDelegate

public static Object defaultInstantiateDelegate(Class<?> clazz,
 List<FieldDeclaration> fieldDeclarations)

defaultInstantiateDelegate

public static Object defaultInstantiateDelegate(String className,
 List<FieldDeclaration> fieldDeclarations)

applyFieldDeclaration

public static void applyFieldDeclaration(List<FieldDeclaration> fieldDeclarations,
 Object target)

applyFieldDeclaration

public static void applyFieldDeclaration(List<FieldDeclaration> fieldDeclarations,
 Object target,
 boolean throwExceptionOnMissingField)

applyFieldDeclaration

public static void applyFieldDeclaration(FieldDeclaration declaration,
 Object target)

applyFieldDeclaration

public static void applyFieldDeclaration(FieldDeclaration declaration,
 Object target,
 boolean throwExceptionOnMissingField)

fieldTypeCompatible

public static boolean fieldTypeCompatible(FieldDeclaration declaration,
 Field field)

getClassName

public String getClassName()

returns the class name this ClassDelegate is configured to. Comes in handy if you want to check which delegates you already have e.g. in a list of listeners