Package org.activiti.engine.delegate.event.impl

Class ActivitiEventBuilder

java.lang.Object

org.activiti.engine.delegate.event.impl.ActivitiEventBuilder

public class ActivitiEventBuilder
extends Object

Builder class used to create ActivitiEvent implementations.

Constructor Summary

Constructors

Constructor	Description
ActivitiEventBuilder()

Method Summary

Modifier and Type	Method	Description
static ActivitiSignalEvent	createActivitiySignalledEvent(DelegateExecution execution, String signalName, Object payload)
static ActivitiActivityCancelledEvent	createActivityCancelledEvent(String activityId, String activityName, String executionId, String processInstanceId, String processDefinitionId, String activityType, Object cause)
static ActivitiActivityCancelledEvent	createActivityCancelledEvent(ExecutionEntity execution, Object cause)
static ActivitiActivityEvent	createActivityEvent(ActivitiEventType type, String activityId, String activityName, String executionId, String processInstanceId, String processDefinitionId, org.activiti.bpmn.model.FlowElement flowElement)
static ActivitiActivityEvent	createActivityEvent(ActivitiEventType type, DelegateExecution execution, org.activiti.bpmn.model.FlowElement flowElement)
static ActivitiEntityEvent	createEntityEvent(ActivitiEventType type, Object entity)
static ActivitiEntityEvent	createEntityEvent(ActivitiEventType type, Object entity, String executionId, String processInstanceId, String processDefinitionId)
static ActivitiEvent	createEntityEventWithActor(ActivitiEventType type, ExecutionEntity entity, String actor)
static ActivitiEntityEvent	createEntityExceptionEvent(ActivitiEventType type, Object entity, Throwable cause)
static ActivitiEntityEvent	createEntityExceptionEvent(ActivitiEventType type, Object entity, Throwable cause, String executionId, String processInstanceId, String processDefinitionId)
static ActivitiEntityWithVariablesEvent	createEntityWithVariablesEvent(ActivitiEventType type, Object entity, Map variables, boolean localScope)
static ActivitiErrorEvent	createErrorEvent(ActivitiEventType type, String activityId, String errorId, String errorCode, String executionId, String processInstanceId, String processDefinitionId)
static ActivitiEvent	createEvent(ActivitiEventType type, String executionId, String processInstanceId, String processDefinitionId)
static ActivitiEvent	createGlobalEvent(ActivitiEventType type)
static ActivitiMembershipEvent	createMembershipEvent(ActivitiEventType type, String groupId, String userId)
static ActivitiMessageEvent	createMessageReceivedEvent(DelegateExecution execution, String messageName, String correlationKey, Object payload)
static ActivitiMessageEvent	createMessageSentEvent(DelegateExecution execution, String messageName, String correlationKey, Object payload)
static ActivitiMessageEvent	createMessageWaitingEvent(DelegateExecution execution, String messageName, String correlationKey)
static ActivitiProcessCancelledEvent	createProcessCancelledEvent(ProcessInstance processInstance, Object cause)
static ActivitiProcessStartedEvent	createProcessStartedEvent(Object entity, Map variables, boolean localScope)
static ActivitiProcessStartedEvent	createProcessStartedEvent(Object entity, Map variables, boolean localScope, String linkedProcessInstanceId, String linkedProcessInstanceType)
static ActivitiSequenceFlowTakenEvent	createSequenceFlowTakenEvent(ExecutionEntity executionEntity, ActivitiEventType type, String sequenceFlowId, String sourceActivityId, String sourceActivityName, String sourceActivityType, Object sourceActivityBehavior, String targetActivityId, String targetActivityName, String targetActivityType, Object targetActivityBehavior)
static ActivitiVariableEvent	createVariableEvent(ActivitiEventType type, String variableName, Object variableValue, VariableType variableType, String taskId, String executionId, String processInstanceId, String processDefinitionId)
static ActivitiVariableUpdatedEventImpl	createVariableUpdateEvent(VariableInstanceEntity variableInstance, Object previousValue, String processInstanceId, String processDefinitionId)
protected static String	mayBeResolveExpression(String expression, DelegateExecution execution)
protected static String	parseActivityBehavior(org.activiti.bpmn.model.FlowNode flowNode)
protected static String	parseActivityType(org.activiti.bpmn.model.FlowNode flowNode)
protected static void	populateEventWithCurrentContext(ActivitiEventImpl event)
protected static void	populateEventWithCurrentContextAndActor(ActivitiEventImpl event, String actor)

Methods inherited from class java.lang.Object

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

Constructor Details

ActivitiEventBuilder

public ActivitiEventBuilder()

Method Details

createGlobalEvent

public static ActivitiEvent createGlobalEvent(ActivitiEventType type)

Parameters:

type - type of event

Returns:

an ActivitiEvent that doesn't have it's execution context-fields filled, as the event is a global event, independent of any running execution.

createEvent

public static ActivitiEvent createEvent(ActivitiEventType type,
 String executionId,
 String processInstanceId,
 String processDefinitionId)

createEntityEvent

public static ActivitiEntityEvent createEntityEvent(ActivitiEventType type,
 Object entity)

Parameters:

type - type of event

entity - the entity this event targets

Returns:

an ActivitiEntityEvent. In case an ExecutionContext is active, the execution related event fields will be populated. If not, execution details will be retrieved from the Object if possible.

createProcessStartedEvent

public static ActivitiProcessStartedEvent createProcessStartedEvent(Object entity,
 Map variables,
 boolean localScope)

Parameters:

entity - the entity this event targets

variables - the variables associated with this entity

Returns:

an ActivitiEntityEvent. In case an ExecutionContext is active, the execution related event fields will be populated. If not, execution details will be reteived from the Object if possible.

createProcessStartedEvent

public static ActivitiProcessStartedEvent createProcessStartedEvent(Object entity,
 Map variables,
 boolean localScope,
 String linkedProcessInstanceId,
 String linkedProcessInstanceType)

Parameters:

entity - the entity this event targets

variables - the variables associated with this entity

linkedProcessInstanceId - the id of the linked process instance

linkedProcessInstanceType - the type of the linked process instance

Returns:

an ActivitiProcessStartedEvent. In case an ExecutionContext is active, the execution related event fields will be populated. If not, execution details will be retrieved from the Object if possible.

createEntityWithVariablesEvent

public static ActivitiEntityWithVariablesEvent createEntityWithVariablesEvent(ActivitiEventType type,
 Object entity,
 Map variables,
 boolean localScope)

Parameters:

type - type of event

entity - the entity this event targets

variables - the variables associated with this entity

Returns:

an ActivitiEntityEvent. In case an ExecutionContext is active, the execution related event fields will be populated. If not, execution details will be retrieved from the Object if possible.

createSequenceFlowTakenEvent

public static ActivitiSequenceFlowTakenEvent createSequenceFlowTakenEvent(ExecutionEntity executionEntity,
 ActivitiEventType type,
 String sequenceFlowId,
 String sourceActivityId,
 String sourceActivityName,
 String sourceActivityType,
 Object sourceActivityBehavior,
 String targetActivityId,
 String targetActivityName,
 String targetActivityType,
 Object targetActivityBehavior)

createEntityEvent

public static ActivitiEntityEvent createEntityEvent(ActivitiEventType type,
 Object entity,
 String executionId,
 String processInstanceId,
 String processDefinitionId)

Parameters:

type - type of event

entity - the entity this event targets

Returns:

an ActivitiEntityEvent

createEntityExceptionEvent

public static ActivitiEntityEvent createEntityExceptionEvent(ActivitiEventType type,
 Object entity,
 Throwable cause)

Parameters:

type - type of event

entity - the entity this event targets

cause - the cause of the event

Returns:

an ActivitiEntityEvent that is also instance of ActivitiExceptionEvent. In case an ExecutionContext is active, the execution related event fields will be populated.

createEntityExceptionEvent

public static ActivitiEntityEvent createEntityExceptionEvent(ActivitiEventType type,
 Object entity,
 Throwable cause,
 String executionId,
 String processInstanceId,
 String processDefinitionId)

Parameters:

type - type of event

entity - the entity this event targets

cause - the cause of the event

Returns:

an ActivitiEntityEvent that is also instance of ActivitiExceptionEvent.

createActivityEvent

public static ActivitiActivityEvent createActivityEvent(ActivitiEventType type,
 String activityId,
 String activityName,
 String executionId,
 String processInstanceId,
 String processDefinitionId,
 org.activiti.bpmn.model.FlowElement flowElement)

createActivityEvent

public static ActivitiActivityEvent createActivityEvent(ActivitiEventType type,
 DelegateExecution execution,
 org.activiti.bpmn.model.FlowElement flowElement)

mayBeResolveExpression

protected static String mayBeResolveExpression(String expression,
 DelegateExecution execution)

parseActivityType

protected static String parseActivityType(org.activiti.bpmn.model.FlowNode flowNode)

parseActivityBehavior

protected static String parseActivityBehavior(org.activiti.bpmn.model.FlowNode flowNode)

createActivityCancelledEvent

public static ActivitiActivityCancelledEvent createActivityCancelledEvent(String activityId,
 String activityName,
 String executionId,
 String processInstanceId,
 String processDefinitionId,
 String activityType,
 Object cause)

createActivityCancelledEvent

public static ActivitiActivityCancelledEvent createActivityCancelledEvent(ExecutionEntity execution,
 Object cause)

createProcessCancelledEvent

public static ActivitiProcessCancelledEvent createProcessCancelledEvent(ProcessInstance processInstance,
 Object cause)

createActivitiySignalledEvent

public static ActivitiSignalEvent createActivitiySignalledEvent(DelegateExecution execution,
 String signalName,
 Object payload)

createMessageReceivedEvent

public static ActivitiMessageEvent createMessageReceivedEvent(DelegateExecution execution,
 String messageName,
 String correlationKey,
 Object payload)

createMessageWaitingEvent

public static ActivitiMessageEvent createMessageWaitingEvent(DelegateExecution execution,
 String messageName,
 String correlationKey)

createMessageSentEvent

public static ActivitiMessageEvent createMessageSentEvent(DelegateExecution execution,
 String messageName,
 String correlationKey,
 Object payload)

createErrorEvent

public static ActivitiErrorEvent createErrorEvent(ActivitiEventType type,
 String activityId,
 String errorId,
 String errorCode,
 String executionId,
 String processInstanceId,
 String processDefinitionId)

createVariableEvent

public static ActivitiVariableEvent createVariableEvent(ActivitiEventType type,
 String variableName,
 Object variableValue,
 VariableType variableType,
 String taskId,
 String executionId,
 String processInstanceId,
 String processDefinitionId)

createVariableUpdateEvent

public static ActivitiVariableUpdatedEventImpl createVariableUpdateEvent(VariableInstanceEntity variableInstance,
 Object previousValue,
 String processInstanceId,
 String processDefinitionId)

createMembershipEvent

public static ActivitiMembershipEvent createMembershipEvent(ActivitiEventType type,
 String groupId,
 String userId)

populateEventWithCurrentContextAndActor

protected static void populateEventWithCurrentContextAndActor(ActivitiEventImpl event,
 String actor)

populateEventWithCurrentContext

protected static void populateEventWithCurrentContext(ActivitiEventImpl event)

createEntityEventWithActor

public static ActivitiEvent createEntityEventWithActor(ActivitiEventType type,
 ExecutionEntity entity,
 String actor)