Package org.camunda.bpm.engine.impl.history.producer

Interface HistoryEventProducer

All Known Implementing Classes:
CacheAwareHistoryEventProducer, DefaultHistoryEventProducer
public interface HistoryEventProducer

The producer for history events. The history event producer is responsible for extracting data from the runtime structures (Executions, Tasks, ...) and adding the data to a HistoryEvent.

Author:
Daniel Meyer, Marcel Wieczorek, Ingo Richtsmeier

  • Method Details

    • createProcessInstanceStartEvt

      HistoryEvent createProcessInstanceStartEvt(DelegateExecution execution)
      Creates the history event fired when a process instances is created.
      Parameters:
      execution - the current execution.
      Returns:
      the history event

    • createProcessInstanceUpdateEvt

      HistoryEvent createProcessInstanceUpdateEvt(DelegateExecution execution)
      Creates the history event fired when a process instance is updated.
      Parameters:
      execution - the process instance
      Returns:
      the created history event

    • createProcessInstanceMigrateEvt

      HistoryEvent createProcessInstanceMigrateEvt(DelegateExecution execution)
      Creates the history event fired when a process instance is migrated.
      Parameters:
      execution - the process instance
      Returns:
      the created history event

    • createProcessInstanceEndEvt

      HistoryEvent createProcessInstanceEndEvt(DelegateExecution execution)
      Creates the history event fired when a process instance is ended.
      Parameters:
      execution - the current execution.
      Returns:
      the history event

    • createActivityInstanceStartEvt

      HistoryEvent createActivityInstanceStartEvt(DelegateExecution execution)
      Creates the history event fired when an activity instance is started.
      Parameters:
      execution - the current execution.
      Returns:
      the history event

    • createActivityInstanceUpdateEvt

      HistoryEvent createActivityInstanceUpdateEvt(DelegateExecution execution)
      Creates the history event fired when an activity instance is updated.
      Parameters:
      execution - the current execution.
      Returns:
      the history event

    • createActivityInstanceUpdateEvt

      HistoryEvent createActivityInstanceUpdateEvt(DelegateExecution execution, DelegateTask task)
      Creates the history event fired when an activity instance is updated.
      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

      HistoryEvent createActivityInstanceMigrateEvt(MigratingActivityInstance actInstance)
      Creates the history event which is fired when an activity instance is migrated.
      Parameters:
      actInstance - the migrated activity instance which contains the new id's
      Returns:
      the created history event

    • createActivityInstanceEndEvt

      HistoryEvent createActivityInstanceEndEvt(DelegateExecution execution)
      Creates the history event fired when an activity instance is ended.
      Parameters:
      execution - the current execution.
      Returns:
      the history event

    • createTaskInstanceCreateEvt

      HistoryEvent createTaskInstanceCreateEvt(DelegateTask task)
      Creates the history event fired when a task instance is created.
      Parameters:
      task - the task
      Returns:
      the history event

    • createTaskInstanceUpdateEvt

      HistoryEvent createTaskInstanceUpdateEvt(DelegateTask task)
      Creates the history event fired when a task instance is updated.
      Parameters:
      task - the task
      Returns:
      the history event

    • createTaskInstanceMigrateEvt

      HistoryEvent createTaskInstanceMigrateEvt(DelegateTask task)
      Creates the history event fired when a task instance is migrated.
      Parameters:
      task - the task
      Returns:
      the history event

    • createTaskInstanceCompleteEvt

      HistoryEvent createTaskInstanceCompleteEvt(DelegateTask task, String deleteReason)
      Creates the history event fired when a task instances is completed.
      Parameters:
      task - the task
      deleteReason -
      Returns:
      the history event

    • createUserOperationLogEvents

      List<HistoryEvent> createUserOperationLogEvents(UserOperationLogContext context)
      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, ...
      Parameters:
      context - the UserOperationLogContext providing the needed informations
      Returns:
      a List of HistoryEvents

    • createHistoricVariableCreateEvt

      HistoryEvent createHistoricVariableCreateEvt(VariableInstanceEntity variableInstance, VariableScope sourceVariableScope)
      Creates the history event fired when a variable is created.
      Parameters:
      variableInstance - the runtime variable instance
      the - scope to which the variable is linked
      Returns:
      the history event

    • createHistoricVariableUpdateEvt

      HistoryEvent createHistoricVariableUpdateEvt(VariableInstanceEntity variableInstance, VariableScope sourceVariableScope)
      Creates the history event fired when a variable is updated.
      Parameters:
      variableInstance - the runtime variable instance
      the - scope to which the variable is linked
      Returns:
      the history event

    • createHistoricVariableMigrateEvt

      HistoryEvent createHistoricVariableMigrateEvt(VariableInstanceEntity variableInstance)
      Creates the history event fired when a variable is migrated.
      Parameters:
      variableInstance - the runtime variable instance
      the - scope to which the variable is linked
      Returns:
      the history event

    • createHistoricVariableDeleteEvt

      HistoryEvent createHistoricVariableDeleteEvt(VariableInstanceEntity variableInstance, VariableScope sourceVariableScope)
      Creates the history event fired when a variable is deleted.
      Parameters:
      variableInstance -
      variableScopeImpl -
      Returns:
      the history event

    • createFormPropertyUpdateEvt

      HistoryEvent createFormPropertyUpdateEvt(ExecutionEntity execution, String propertyId, String propertyValue, String taskId)
      Creates the history event fired when a form property is updated.
      Parameters:
      processInstance - the id for the process instance
      propertyId - the id of the form property
      propertyValue - the value of the form property
      taskId -
      Returns:
      the history event

    • createHistoricIncidentCreateEvt

      HistoryEvent createHistoricIncidentCreateEvt(Incident incident)

    • createHistoricIncidentResolveEvt

      HistoryEvent createHistoricIncidentResolveEvt(Incident incident)

    • createHistoricIncidentDeleteEvt

      HistoryEvent createHistoricIncidentDeleteEvt(Incident incident)

    • createHistoricIncidentMigrateEvt

      HistoryEvent createHistoricIncidentMigrateEvt(Incident incident)

    • createHistoricIncidentUpdateEvt

      HistoryEvent createHistoricIncidentUpdateEvt(Incident incident)

    • createHistoricJobLogCreateEvt

      HistoryEvent createHistoricJobLogCreateEvt(Job job)
      Creates the history event fired when a job has been created.
      Since:
      7.3

    • createHistoricJobLogFailedEvt

      HistoryEvent createHistoricJobLogFailedEvt(Job job, Throwable exception)
      Creates the history event fired when the execution of a job failed.
      Since:
      7.3

    • createHistoricJobLogSuccessfulEvt

      HistoryEvent createHistoricJobLogSuccessfulEvt(Job job)
      Creates the history event fired when the execution of a job was successful.
      Since:
      7.3

    • createHistoricJobLogDeleteEvt

      HistoryEvent createHistoricJobLogDeleteEvt(Job job)
      Creates the history event fired when the a job has been deleted.
      Since:
      7.3

    • createBatchStartEvent

      HistoryEvent createBatchStartEvent(Batch batch)
      Creates the history event fired when the a batch has been started.
      Since:
      7.5

    • createBatchEndEvent

      HistoryEvent createBatchEndEvent(Batch batch)
      Creates the history event fired when the a batch has been completed.
      Since:
      7.5

    • createBatchUpdateEvent

      HistoryEvent createBatchUpdateEvent(Batch batch)
      Creates the history event fired when a batch has been updated.
      Since:
      7.18

    • createHistoricIdentityLinkAddEvent

      HistoryEvent createHistoricIdentityLinkAddEvent(IdentityLink identitylink)
      Fired when an identity link is added
      Parameters:
      identitylink -
      Returns:

    • createHistoricIdentityLinkDeleteEvent

      HistoryEvent createHistoricIdentityLinkDeleteEvent(IdentityLink identityLink)
      Fired when an identity links is deleted
      Parameters:
      identityLink -
      Returns:

    • createHistoricExternalTaskLogCreatedEvt

      HistoryEvent createHistoricExternalTaskLogCreatedEvt(ExternalTask task)
      Creates the history event when an external task has been created.
      Since:
      7.7

    • createHistoricExternalTaskLogFailedEvt

      HistoryEvent createHistoricExternalTaskLogFailedEvt(ExternalTask task)
      Creates the history event when the execution of an external task has failed.
      Since:
      7.7

    • createHistoricExternalTaskLogSuccessfulEvt

      HistoryEvent createHistoricExternalTaskLogSuccessfulEvt(ExternalTask task)
      Creates the history event when the execution of an external task was successful.
      Since:
      7.7

    • createHistoricExternalTaskLogDeletedEvt

      HistoryEvent createHistoricExternalTaskLogDeletedEvt(ExternalTask task)
      Creates the history event when an external task has been deleted.
      Since:
      7.7