org.camunda.bpm.engine.impl.history.producer
Class DefaultHistoryEventProducer

java.lang.Object
  org.camunda.bpm.engine.impl.history.producer.DefaultHistoryEventProducer

All Implemented Interfaces:

HistoryEventProducer

Direct Known Subclasses:

CacheAwareHistoryEventProducer

public class DefaultHistoryEventProducer
extends Object
implements HistoryEventProducer

Author:

Daniel Meyer, Ingo Richtsmeier

Constructor Summary

DefaultHistoryEventProducer()

Method Summary

HistoryEvent	createActivityInstanceEndEvt(DelegateExecution execution) Creates the history event fired when an activity instance is ended.
HistoryEvent	createActivityInstanceMigrateEvt(MigratingActivityInstance actInstance) Creates the history event which is fired when an activity instance is migrated.
HistoryEvent	createActivityInstanceStartEvt(DelegateExecution execution) Creates the history event fired when an activity instance is started.
HistoryEvent	createActivityInstanceUpdateEvt(DelegateExecution execution) Creates the history event fired when an activity instance is updated.
HistoryEvent	createActivityInstanceUpdateEvt(DelegateExecution execution, DelegateTask task) Creates the history event fired when an activity instance is updated.
HistoryEvent	createBatchEndEvent(Batch batch) Creates the history event fired when the a batch has been completed.
protected HistoryEvent	createBatchEvent(BatchEntity batch, HistoryEventTypes eventType)
HistoryEvent	createBatchStartEvent(Batch batch) Creates the history event fired when the a batch has been started.
HistoryEvent	createFormPropertyUpdateEvt(ExecutionEntity execution, String propertyId, String propertyValue, String taskId) Creates the history event fired when a form property is updated.
HistoryEvent	createHistoricIdentityLinkAddEvent(IdentityLink identityLink) Fired when an identity link is added
HistoryEvent	createHistoricIdentityLinkDeleteEvent(IdentityLink identityLink) Fired when an identity links is deleted
protected HistoryEvent	createHistoricIdentityLinkEvt(IdentityLink identityLink, HistoryEventTypes eventType)
HistoryEvent	createHistoricIncidentCreateEvt(Incident incident)
HistoryEvent	createHistoricIncidentDeleteEvt(Incident incident)
protected HistoryEvent	createHistoricIncidentEvt(Incident incident, HistoryEventTypes eventType)
HistoryEvent	createHistoricIncidentMigrateEvt(Incident incident)
HistoryEvent	createHistoricIncidentResolveEvt(Incident incident)
HistoryEvent	createHistoricJobLogCreateEvt(Job job) Creates the history event fired when a job has been created.
HistoryEvent	createHistoricJobLogDeleteEvt(Job job) Creates the history event fired when the a job has been deleted.
protected HistoryEvent	createHistoricJobLogEvt(Job job, HistoryEventType eventType)
HistoryEvent	createHistoricJobLogFailedEvt(Job job, Throwable exception) Creates the history event fired when the execution of a job failed.
HistoryEvent	createHistoricJobLogSuccessfulEvt(Job job) Creates the history event fired when the execution of a job was successful.
HistoryEvent	createHistoricVariableCreateEvt(VariableInstanceEntity variableInstance, VariableScope sourceVariableScope) Creates the history event fired when a variable is created.
HistoryEvent	createHistoricVariableDeleteEvt(VariableInstanceEntity variableInstance, VariableScope sourceVariableScope) Creates the history event fired when a variable is deleted.
protected HistoryEvent	createHistoricVariableEvent(VariableInstanceEntity variableInstance, VariableScope sourceVariableScope, HistoryEventType eventType)
HistoryEvent	createHistoricVariableMigrateEvt(VariableInstanceEntity variableInstance) Creates the history event fired when a variable is migrated.
HistoryEvent	createHistoricVariableUpdateEvt(VariableInstanceEntity variableInstance, VariableScope sourceVariableScope) Creates the history event fired when a variable is updated.
HistoryEvent	createProcessInstanceEndEvt(DelegateExecution execution) Creates the history event fired when a process instance is ended.
HistoryEvent	createProcessInstanceMigrateEvt(DelegateExecution execution) Creates the history event fired when a process instance is migrated.
HistoryEvent	createProcessInstanceStartEvt(DelegateExecution execution) Creates the history event fired when a process instances is created.
HistoryEvent	createProcessInstanceUpdateEvt(DelegateExecution execution) Creates the history event fired when a process instance is updated.
HistoryEvent	createTaskInstanceCompleteEvt(DelegateTask task, String deleteReason) Creates the history event fired when a task instances is completed.
HistoryEvent	createTaskInstanceCreateEvt(DelegateTask task) Creates the history event fired when a task instance is created.
HistoryEvent	createTaskInstanceMigrateEvt(DelegateTask task) Creates the history event fired when a task instance is migrated.
HistoryEvent	createTaskInstanceUpdateEvt(DelegateTask task) Creates the history event fired when a task instance is updated.
List<HistoryEvent>	createUserOperationLogEvents(UserOperationLogContext context) Creates the history event fired whenever an operation has been performed by a user.
protected void	determineEndState(ExecutionEntity executionEntity, HistoricProcessInstanceEventEntity evt)
protected void	initActivityInstanceEvent(HistoricActivityInstanceEventEntity evt, ExecutionEntity execution, HistoryEventType eventType)
protected void	initActivityInstanceEvent(HistoricActivityInstanceEventEntity evt, ExecutionEntity execution, PvmScope eventSource, String activityInstanceId, String parentActivityInstanceId, HistoryEventType eventType)
protected void	initActivityInstanceEvent(HistoricActivityInstanceEventEntity evt, MigratingActivityInstance migratingActivityInstance, HistoryEventType eventType)
protected void	initHistoricIdentityLinkEvent(HistoricIdentityLinkLogEventEntity evt, IdentityLink identityLink, HistoryEventType eventType)
protected void	initHistoricIncidentEvent(HistoricIncidentEventEntity evt, Incident incident, HistoryEventType eventType)
protected void	initHistoricJobLogEvent(HistoricJobLogEventEntity evt, Job job, HistoryEventType eventType)
protected void	initHistoricVariableUpdateEvt(HistoricVariableUpdateEventEntity evt, VariableInstanceEntity variableInstance, HistoryEventType eventType)
protected void	initProcessInstanceEvent(HistoricProcessInstanceEventEntity evt, ExecutionEntity execution, HistoryEventType eventType)
protected void	initSequenceCounter(ExecutionEntity execution, HistoryEvent event)
protected void	initSequenceCounter(JobEntity job, HistoryEvent event)
protected void	initSequenceCounter(long sequenceCounter, HistoryEvent event)
protected void	initSequenceCounter(VariableInstanceEntity variable, HistoryEvent event)
protected void	initTaskInstanceEvent(HistoricTaskInstanceEventEntity evt, TaskEntity taskEntity, HistoryEventType eventType)
protected void	initUserOperationLogEvent(UserOperationLogEntryEventEntity evt, UserOperationLogContext context, UserOperationLogContextEntry contextEntry, PropertyChange propertyChange)
protected HistoricActivityInstanceEventEntity	loadActivityInstanceEventEntity(ExecutionEntity execution)
protected HistoricIncidentEventEntity	loadIncidentEvent(Incident incident)
protected HistoricProcessInstanceEventEntity	loadProcessInstanceEventEntity(ExecutionEntity execution)
protected HistoricTaskInstanceEventEntity	loadTaskInstanceEvent(DelegateTask task)
protected HistoricActivityInstanceEventEntity	newActivityInstanceEventEntity(ExecutionEntity execution)
protected HistoricFormPropertyEventEntity	newHistoricFormPropertyEvent()
protected HistoricJobLogEventEntity	newHistoricJobLogEntity(Job job)
protected HistoricIdentityLinkLogEventEntity	newIdentityLinkEventEntity()
protected HistoricIncidentEventEntity	newIncidentEventEntity(Incident incident)
protected HistoricProcessInstanceEventEntity	newProcessInstanceEventEntity(ExecutionEntity execution)
protected HistoricTaskInstanceEventEntity	newTaskInstanceEventEntity(DelegateTask task)
protected HistoricVariableUpdateEventEntity	newVariableUpdateEventEntity(ExecutionEntity execution)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHistoryEventProducer

public DefaultHistoryEventProducer()

Method Detail

initActivityInstanceEvent

protected void initActivityInstanceEvent(HistoricActivityInstanceEventEntity evt,
                                         ExecutionEntity execution,
                                         HistoryEventType eventType)

initActivityInstanceEvent

protected void initActivityInstanceEvent(HistoricActivityInstanceEventEntity evt,
                                         MigratingActivityInstance migratingActivityInstance,
                                         HistoryEventType eventType)

initActivityInstanceEvent

protected void initActivityInstanceEvent(HistoricActivityInstanceEventEntity evt,
                                         ExecutionEntity execution,
                                         PvmScope eventSource,
                                         String activityInstanceId,
                                         String parentActivityInstanceId,
                                         HistoryEventType eventType)

initProcessInstanceEvent

protected void initProcessInstanceEvent(HistoricProcessInstanceEventEntity evt,
                                        ExecutionEntity execution,
                                        HistoryEventType eventType)

initTaskInstanceEvent

protected void initTaskInstanceEvent(HistoricTaskInstanceEventEntity evt,
                                     TaskEntity taskEntity,
                                     HistoryEventType eventType)

initHistoricVariableUpdateEvt

protected void initHistoricVariableUpdateEvt(HistoricVariableUpdateEventEntity evt,
                                             VariableInstanceEntity variableInstance,
                                             HistoryEventType eventType)

initUserOperationLogEvent

protected void initUserOperationLogEvent(UserOperationLogEntryEventEntity evt,
                                         UserOperationLogContext context,
                                         UserOperationLogContextEntry contextEntry,
                                         PropertyChange propertyChange)

initHistoricIncidentEvent

protected void initHistoricIncidentEvent(HistoricIncidentEventEntity evt,
                                         Incident incident,
                                         HistoryEventType eventType)

createHistoricVariableEvent

protected HistoryEvent createHistoricVariableEvent(VariableInstanceEntity variableInstance,
                                                   VariableScope sourceVariableScope,
                                                   HistoryEventType eventType)

newProcessInstanceEventEntity

protected HistoricProcessInstanceEventEntity newProcessInstanceEventEntity(ExecutionEntity execution)

newActivityInstanceEventEntity

protected HistoricActivityInstanceEventEntity newActivityInstanceEventEntity(ExecutionEntity execution)

newTaskInstanceEventEntity

protected HistoricTaskInstanceEventEntity newTaskInstanceEventEntity(DelegateTask task)

newVariableUpdateEventEntity

protected HistoricVariableUpdateEventEntity newVariableUpdateEventEntity(ExecutionEntity execution)

newHistoricFormPropertyEvent

protected HistoricFormPropertyEventEntity newHistoricFormPropertyEvent()

newIncidentEventEntity

protected HistoricIncidentEventEntity newIncidentEventEntity(Incident incident)

newHistoricJobLogEntity

protected HistoricJobLogEventEntity newHistoricJobLogEntity(Job job)

loadProcessInstanceEventEntity

protected HistoricProcessInstanceEventEntity loadProcessInstanceEventEntity(ExecutionEntity execution)

loadActivityInstanceEventEntity

protected HistoricActivityInstanceEventEntity loadActivityInstanceEventEntity(ExecutionEntity execution)

loadTaskInstanceEvent

protected HistoricTaskInstanceEventEntity loadTaskInstanceEvent(DelegateTask task)

loadIncidentEvent

protected HistoricIncidentEventEntity loadIncidentEvent(Incident incident)

createProcessInstanceStartEvt

public HistoryEvent createProcessInstanceStartEvt(DelegateExecution execution)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a process instances is created.

Specified by:

createProcessInstanceStartEvt in interface HistoryEventProducer

Parameters:

execution - the current execution.

Returns:

the history event

createProcessInstanceUpdateEvt

public HistoryEvent createProcessInstanceUpdateEvt(DelegateExecution execution)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a process instance is updated.

Specified by:

createProcessInstanceUpdateEvt in interface HistoryEventProducer

Parameters:

execution - the process instance

Returns:

the created history event

createProcessInstanceMigrateEvt

public HistoryEvent createProcessInstanceMigrateEvt(DelegateExecution execution)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a process instance is migrated.

Specified by:

createProcessInstanceMigrateEvt in interface HistoryEventProducer

Parameters:

execution - the process instance

Returns:

the created history event

createProcessInstanceEndEvt

public HistoryEvent createProcessInstanceEndEvt(DelegateExecution execution)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a process instance is ended.

Specified by:

createProcessInstanceEndEvt in interface HistoryEventProducer

Parameters:

execution - the current execution.

Returns:

the history event

determineEndState

protected void determineEndState(ExecutionEntity executionEntity,
                                 HistoricProcessInstanceEventEntity evt)

createActivityInstanceStartEvt

public HistoryEvent createActivityInstanceStartEvt(DelegateExecution execution)

Description copied from interface: HistoryEventProducer

Creates the history event fired when an activity instance is started.

Specified by:

createActivityInstanceStartEvt in interface HistoryEventProducer

Parameters:

execution - the current execution.

Returns:

the history event

createActivityInstanceUpdateEvt

public HistoryEvent createActivityInstanceUpdateEvt(DelegateExecution execution)

Description copied from interface: HistoryEventProducer

Creates the history event fired when an activity instance is updated.

Specified by:

createActivityInstanceUpdateEvt in interface HistoryEventProducer

Parameters:

execution - the current execution.

Returns:

the history event

createActivityInstanceUpdateEvt

public HistoryEvent createActivityInstanceUpdateEvt(DelegateExecution execution,
                                                    DelegateTask task)

Description copied from interface: HistoryEventProducer

Creates the history event fired when an activity instance is updated.

Specified by:

createActivityInstanceUpdateEvt in interface HistoryEventProducer

Parameters:

execution - the current execution.

task - the task association that is currently updated. (May be null in case there is not task associated.)

Returns:

the history event

createActivityInstanceMigrateEvt

public HistoryEvent createActivityInstanceMigrateEvt(MigratingActivityInstance actInstance)

Description copied from interface: HistoryEventProducer

Creates the history event which is fired when an activity instance is migrated.

Specified by:

createActivityInstanceMigrateEvt in interface HistoryEventProducer

Parameters:

actInstance - the migrated activity instance which contains the new id's

Returns:

the created history event

createActivityInstanceEndEvt

public HistoryEvent createActivityInstanceEndEvt(DelegateExecution execution)

Description copied from interface: HistoryEventProducer

Creates the history event fired when an activity instance is ended.

Specified by:

createActivityInstanceEndEvt in interface HistoryEventProducer

Parameters:

execution - the current execution.

Returns:

the history event

createTaskInstanceCreateEvt

public HistoryEvent createTaskInstanceCreateEvt(DelegateTask task)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a task instance is created.

Specified by:

createTaskInstanceCreateEvt in interface HistoryEventProducer

Parameters:

task - the task

Returns:

the history event

createTaskInstanceUpdateEvt

public HistoryEvent createTaskInstanceUpdateEvt(DelegateTask task)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a task instance is updated.

Specified by:

createTaskInstanceUpdateEvt in interface HistoryEventProducer

Parameters:

task - the task

Returns:

the history event

createTaskInstanceMigrateEvt

public HistoryEvent createTaskInstanceMigrateEvt(DelegateTask task)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a task instance is migrated.

Specified by:

createTaskInstanceMigrateEvt in interface HistoryEventProducer

Parameters:

task - the task

Returns:

the history event

createTaskInstanceCompleteEvt

public HistoryEvent createTaskInstanceCompleteEvt(DelegateTask task,
                                                  String deleteReason)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a task instances is completed.

Specified by:

createTaskInstanceCompleteEvt in interface HistoryEventProducer

Parameters:

task - the task

Returns:

the history event

createUserOperationLogEvents

public List<HistoryEvent> createUserOperationLogEvents(UserOperationLogContext context)

Description copied from interface: HistoryEventProducer

Creates the history event fired whenever an operation has been performed by a user. This is used for logging actions such as creating a new Task, completing a task, canceling a a process instance, ...

Specified by:

createUserOperationLogEvents in interface HistoryEventProducer

Parameters:

context - the UserOperationLogContext providing the needed informations

Returns:

a List of HistoryEvents

createHistoricVariableCreateEvt

public HistoryEvent createHistoricVariableCreateEvt(VariableInstanceEntity variableInstance,
                                                    VariableScope sourceVariableScope)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a variable is created.

Specified by:

createHistoricVariableCreateEvt in interface HistoryEventProducer

Parameters:

variableInstance - the runtime variable instance

Returns:

the history event

createHistoricVariableDeleteEvt

public HistoryEvent createHistoricVariableDeleteEvt(VariableInstanceEntity variableInstance,
                                                    VariableScope sourceVariableScope)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a variable is deleted.

Specified by:

createHistoricVariableDeleteEvt in interface HistoryEventProducer

Returns:

the history event

createHistoricVariableUpdateEvt

public HistoryEvent createHistoricVariableUpdateEvt(VariableInstanceEntity variableInstance,
                                                    VariableScope sourceVariableScope)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a variable is updated.

Specified by:

createHistoricVariableUpdateEvt in interface HistoryEventProducer

Parameters:

variableInstance - the runtime variable instance

Returns:

the history event

createHistoricVariableMigrateEvt

public HistoryEvent createHistoricVariableMigrateEvt(VariableInstanceEntity variableInstance)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a variable is migrated.

Specified by:

createHistoricVariableMigrateEvt in interface HistoryEventProducer

Parameters:

variableInstance - the runtime variable instance

Returns:

the history event

createFormPropertyUpdateEvt

public HistoryEvent createFormPropertyUpdateEvt(ExecutionEntity execution,
                                                String propertyId,
                                                String propertyValue,
                                                String taskId)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a form property is updated.

Specified by:

createFormPropertyUpdateEvt in interface HistoryEventProducer

propertyId - the id of the form property

propertyValue - the value of the form property

Returns:

the history event

createHistoricIncidentCreateEvt

public HistoryEvent createHistoricIncidentCreateEvt(Incident incident)

Specified by:

createHistoricIncidentCreateEvt in interface HistoryEventProducer

createHistoricIncidentResolveEvt

public HistoryEvent createHistoricIncidentResolveEvt(Incident incident)

Specified by:

createHistoricIncidentResolveEvt in interface HistoryEventProducer

createHistoricIncidentDeleteEvt

public HistoryEvent createHistoricIncidentDeleteEvt(Incident incident)

Specified by:

createHistoricIncidentDeleteEvt in interface HistoryEventProducer

createHistoricIncidentMigrateEvt

public HistoryEvent createHistoricIncidentMigrateEvt(Incident incident)

Specified by:

createHistoricIncidentMigrateEvt in interface HistoryEventProducer

createHistoricIncidentEvt

protected HistoryEvent createHistoricIncidentEvt(Incident incident,
                                                 HistoryEventTypes eventType)

createHistoricIdentityLinkAddEvent

public HistoryEvent createHistoricIdentityLinkAddEvent(IdentityLink identityLink)

Description copied from interface: HistoryEventProducer

Fired when an identity link is added

Specified by:

createHistoricIdentityLinkAddEvent in interface HistoryEventProducer

Returns:

createHistoricIdentityLinkDeleteEvent

public HistoryEvent createHistoricIdentityLinkDeleteEvent(IdentityLink identityLink)

Description copied from interface: HistoryEventProducer

Fired when an identity links is deleted

Specified by:

createHistoricIdentityLinkDeleteEvent in interface HistoryEventProducer

Returns:

createHistoricIdentityLinkEvt

protected HistoryEvent createHistoricIdentityLinkEvt(IdentityLink identityLink,
                                                     HistoryEventTypes eventType)

newIdentityLinkEventEntity

protected HistoricIdentityLinkLogEventEntity newIdentityLinkEventEntity()

initHistoricIdentityLinkEvent

protected void initHistoricIdentityLinkEvent(HistoricIdentityLinkLogEventEntity evt,
                                             IdentityLink identityLink,
                                             HistoryEventType eventType)

createBatchStartEvent

public HistoryEvent createBatchStartEvent(Batch batch)

Description copied from interface: HistoryEventProducer

Creates the history event fired when the a batch has been started.

Specified by:

createBatchStartEvent in interface HistoryEventProducer

createBatchEndEvent

public HistoryEvent createBatchEndEvent(Batch batch)

Description copied from interface: HistoryEventProducer

Creates the history event fired when the a batch has been completed.

Specified by:

createBatchEndEvent in interface HistoryEventProducer

createBatchEvent

protected HistoryEvent createBatchEvent(BatchEntity batch,
                                        HistoryEventTypes eventType)

createHistoricJobLogCreateEvt

public HistoryEvent createHistoricJobLogCreateEvt(Job job)

Description copied from interface: HistoryEventProducer

Creates the history event fired when a job has been created.

Specified by:

createHistoricJobLogCreateEvt in interface HistoryEventProducer

createHistoricJobLogFailedEvt

public HistoryEvent createHistoricJobLogFailedEvt(Job job,
                                                  Throwable exception)

Description copied from interface: HistoryEventProducer

Creates the history event fired when the execution of a job failed.

Specified by:

createHistoricJobLogFailedEvt in interface HistoryEventProducer

createHistoricJobLogSuccessfulEvt

public HistoryEvent createHistoricJobLogSuccessfulEvt(Job job)

Description copied from interface: HistoryEventProducer

Creates the history event fired when the execution of a job was successful.

Specified by:

createHistoricJobLogSuccessfulEvt in interface HistoryEventProducer

createHistoricJobLogDeleteEvt

public HistoryEvent createHistoricJobLogDeleteEvt(Job job)

Description copied from interface: HistoryEventProducer

Creates the history event fired when the a job has been deleted.

Specified by:

createHistoricJobLogDeleteEvt in interface HistoryEventProducer

createHistoricJobLogEvt

protected HistoryEvent createHistoricJobLogEvt(Job job,
                                               HistoryEventType eventType)

initHistoricJobLogEvent

protected void initHistoricJobLogEvent(HistoricJobLogEventEntity evt,
                                       Job job,
                                       HistoryEventType eventType)

initSequenceCounter

protected void initSequenceCounter(ExecutionEntity execution,
                                   HistoryEvent event)

initSequenceCounter

protected void initSequenceCounter(VariableInstanceEntity variable,
                                   HistoryEvent event)

initSequenceCounter

protected void initSequenceCounter(JobEntity job,
                                   HistoryEvent event)

initSequenceCounter

protected void initSequenceCounter(long sequenceCounter,
                                   HistoryEvent event)