org.flowable.engine.impl.history

Class DefaultHistoryManager

java.lang.Object

org.flowable.engine.impl.persistence.AbstractManager

org.flowable.engine.impl.history.AbstractHistoryManager

org.flowable.engine.impl.history.DefaultHistoryManager

All Implemented Interfaces:

HistoryManager

public class DefaultHistoryManager
extends AbstractHistoryManager

Manager class that centralises recording of all history-related operations that are originated from inside the engine.

Author:

Frederik Heremans, Joram Barrez

Field Summary

Fields inherited from class org.flowable.engine.impl.persistence.AbstractManager

processEngineConfiguration

Constructor Summary

Constructors

Constructor and Description
DefaultHistoryManager(ProcessEngineConfigurationImpl processEngineConfiguration)

Method Summary

Modifier and Type	Method and Description
void	createHistoricActivityInstance(ActivityInstance activityInstance) Create new historic activity instance from runtime activity instance
protected HistoricActivityInstanceEntity	createNewHistoricActivityInstance(ActivityInstance activityInstance)
void	deleteHistoryUserTaskLog(long logNumber) Delete historic user task log entry
void	recordActivityEnd(ActivityInstance activityInstance) Record the end of an activity, if activity history is enabled.
void	recordActivityEnd(ExecutionEntity executionEntity, String deleteReason, Date endTime) Record activity end in the case when runtime activity instance does not exist.
void	recordActivityStart(ActivityInstance activityInstance) Record the start of an activity, if activity history is enabled.
void	recordDeleteHistoricProcessInstancesByProcessDefinitionId(String processDefinitionId) Deletes historic process instances for a provided process definition id
void	recordEntityLinkCreated(EntityLinkEntity entityLink) Record the creation of a new EntityLink, if audit history is enabled.
void	recordEntityLinkDeleted(EntityLinkEntity entityLink) Record the deletion of a EntityLink, if audit history is enabled
void	recordFormPropertiesSubmitted(ExecutionEntity processInstance, Map<String,String> properties, String taskId, Date createTime) Report form properties submitted, if audit history is enabled.
void	recordHistoricDetailVariableCreate(VariableInstanceEntity variable, ExecutionEntity sourceActivityExecution, boolean useActivityId, String activityInstanceId, Date createTime) Record a variable has been created, if audit history is enabled.
void	recordHistoricUserTaskLogEntry(org.flowable.task.api.history.HistoricTaskLogEntryBuilder taskLogEntryBuilder) Record historic user task log entry
void	recordIdentityLinkCreated(IdentityLinkEntity identityLink) Record the creation of a new IdentityLink, if audit history is enabled.
void	recordIdentityLinkDeleted(IdentityLinkEntity identityLink) Record the deletion of a IdentityLink, if audit history is enabled
void	recordProcessDefinitionChange(String processInstanceId, String processDefinitionId) Record a change of the process-definition id of a process instance, if activity history is enabled.
void	recordProcessInstanceDeleted(String processInstanceId, String processDefinitionId, String processTenantId) Deletes a historic process instance and all historic data included
void	recordProcessInstanceEnd(ExecutionEntity processInstance, String deleteReason, String activityId, Date endTime) Record a process-instance ended.
void	recordProcessInstanceNameChange(ExecutionEntity processInstanceExecution, String newName) Record a process-instance name change.
void	recordProcessInstanceStart(ExecutionEntity processInstance) Record a process-instance started and record start-event if activity history is enabled.
void	recordTaskCreated(TaskEntity task, ExecutionEntity execution) Record the creation of a task, if audit history is enabled.
void	recordTaskEnd(TaskEntity task, ExecutionEntity execution, String deleteReason, Date endTime) Record task as ended, if audit history is enabled.
void	recordTaskInfoChange(TaskEntity taskEntity, String activityInstanceId, Date changeTime) Record task name change, if audit history is enabled.
void	recordVariableCreate(VariableInstanceEntity variable, Date createTime) Record a variable has been created, if audit history is enabled.
void	recordVariableRemoved(VariableInstanceEntity variableInstanceEntity) Record a variable has been deleted, if audit history is enabled.
void	recordVariableUpdate(VariableInstanceEntity variableInstanceEntity, Date updateTime) Record a variable has been updated, if audit history is enabled.
void	updateHistoricActivityInstance(ActivityInstance activityInstance) Update historic activity instance according to changes done in the runtime activity
void	updateProcessBusinessKeyInHistory(ExecutionEntity processInstance)
void	updateProcessDefinitionIdInHistory(ProcessDefinitionEntity processDefinitionEntity, ExecutionEntity processInstance) Record the update of a process definition for historic process instance, task, and activity instance, if history is enabled.

Methods inherited from class org.flowable.engine.impl.history.AbstractHistoryManager

createAttachmentComment, createGroupIdentityLinkComment, createIdentityLinkComment, createIdentityLinkComment, createProcessInstanceIdentityLinkComment, createProcessInstanceIdentityLinkComment, createUserIdentityLinkComment, createUserIdentityLinkComment, findHistoricActivityInstance, findHistoricActivityInstance, getActivityIdForExecution, getEntityCache, getHistoricActivityInstanceFromCache, getHistoryLevel, getProcessDefinitionHistoryLevel, getProcessDefinitionId, getProcessDefinitionId, getProcessDefinitionId, isEnableProcessDefinitionHistoryLevel, isHistoryEnabled, isHistoryEnabled, isHistoryLevelAtLeast, isHistoryLevelAtLeast, parseActivityType, updateActivity

Methods inherited from class org.flowable.engine.impl.persistence.AbstractManager

getActivityInstanceEntityManager, getAsyncExecutor, getAttachmentEntityManager, getByteArrayEntityManager, getClock, getCommandContext, getCommandExecutor, getCommentEntityManager, getDeploymentEntityManager, getEventDispatcher, getExecutionEntityManager, getHistoricActivityInstanceEntityManager, getHistoricDetailEntityManager, getHistoricProcessInstanceEntityManager, getHistoryManager, getModelEntityManager, getProcessDefinitionEntityManager, getProcessDefinitionInfoEntityManager, getProcessEngineConfiguration, getResourceEntityManager, getSession

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHistoryManager

public DefaultHistoryManager(ProcessEngineConfigurationImpl processEngineConfiguration)

Method Detail

recordProcessInstanceEnd

public void recordProcessInstanceEnd(ExecutionEntity processInstance,
                                     String deleteReason,
                                     String activityId,
                                     Date endTime)

Description copied from interface: HistoryManager

Record a process-instance ended. Updates the historic process instance if activity history is enabled.

recordProcessInstanceNameChange

public void recordProcessInstanceNameChange(ExecutionEntity processInstanceExecution,
                                            String newName)

Description copied from interface: HistoryManager

Record a process-instance name change.

recordProcessInstanceStart

public void recordProcessInstanceStart(ExecutionEntity processInstance)

Description copied from interface: HistoryManager

Record a process-instance started and record start-event if activity history is enabled.

recordProcessInstanceDeleted

public void recordProcessInstanceDeleted(String processInstanceId,
                                         String processDefinitionId,
                                         String processTenantId)

Description copied from interface: HistoryManager

Deletes a historic process instance and all historic data included

recordDeleteHistoricProcessInstancesByProcessDefinitionId

public void recordDeleteHistoricProcessInstancesByProcessDefinitionId(String processDefinitionId)

Description copied from interface: HistoryManager

Deletes historic process instances for a provided process definition id

recordActivityStart

public void recordActivityStart(ActivityInstance activityInstance)

Description copied from interface: HistoryManager

Record the start of an activity, if activity history is enabled.

Parameters:

activityInstance - activity instance template

recordActivityEnd

public void recordActivityEnd(ActivityInstance activityInstance)

Description copied from interface: HistoryManager

Record the end of an activity, if activity history is enabled.

Parameters:

activityInstance - activity instance template

recordActivityEnd

public void recordActivityEnd(ExecutionEntity executionEntity,
                              String deleteReason,
                              Date endTime)

Description copied from interface: HistoryManager

Record activity end in the case when runtime activity instance does not exist.

recordProcessDefinitionChange

public void recordProcessDefinitionChange(String processInstanceId,
                                          String processDefinitionId)

Description copied from interface: HistoryManager

Record a change of the process-definition id of a process instance, if activity history is enabled.

recordTaskCreated

public void recordTaskCreated(TaskEntity task,
                              ExecutionEntity execution)

Description copied from interface: HistoryManager

Record the creation of a task, if audit history is enabled.

recordTaskEnd

public void recordTaskEnd(TaskEntity task,
                          ExecutionEntity execution,
                          String deleteReason,
                          Date endTime)

Description copied from interface: HistoryManager

Record task as ended, if audit history is enabled.

recordTaskInfoChange

public void recordTaskInfoChange(TaskEntity taskEntity,
                                 String activityInstanceId,
                                 Date changeTime)

Description copied from interface: HistoryManager

Record task name change, if audit history is enabled.

recordVariableCreate

public void recordVariableCreate(VariableInstanceEntity variable,
                                 Date createTime)

Description copied from interface: HistoryManager

Record a variable has been created, if audit history is enabled.

recordHistoricDetailVariableCreate

public void recordHistoricDetailVariableCreate(VariableInstanceEntity variable,
                                               ExecutionEntity sourceActivityExecution,
                                               boolean useActivityId,
                                               String activityInstanceId,
                                               Date createTime)

Description copied from interface: HistoryManager

Record a variable has been created, if audit history is enabled.

recordVariableUpdate

public void recordVariableUpdate(VariableInstanceEntity variableInstanceEntity,
                                 Date updateTime)

Description copied from interface: HistoryManager

Record a variable has been updated, if audit history is enabled.

recordVariableRemoved

public void recordVariableRemoved(VariableInstanceEntity variableInstanceEntity)

Description copied from interface: HistoryManager

Record a variable has been deleted, if audit history is enabled.

recordFormPropertiesSubmitted

public void recordFormPropertiesSubmitted(ExecutionEntity processInstance,
                                          Map<String,String> properties,
                                          String taskId,
                                          Date createTime)

Description copied from interface: HistoryManager

Report form properties submitted, if audit history is enabled.

recordIdentityLinkCreated

public void recordIdentityLinkCreated(IdentityLinkEntity identityLink)

Description copied from interface: HistoryManager

Record the creation of a new IdentityLink, if audit history is enabled.

recordIdentityLinkDeleted

public void recordIdentityLinkDeleted(IdentityLinkEntity identityLink)

Description copied from interface: HistoryManager

Record the deletion of a IdentityLink, if audit history is enabled

recordEntityLinkCreated

public void recordEntityLinkCreated(EntityLinkEntity entityLink)

Description copied from interface: HistoryManager

Record the creation of a new EntityLink, if audit history is enabled.

recordEntityLinkDeleted

public void recordEntityLinkDeleted(EntityLinkEntity entityLink)

Description copied from interface: HistoryManager

Record the deletion of a EntityLink, if audit history is enabled

updateProcessBusinessKeyInHistory

public void updateProcessBusinessKeyInHistory(ExecutionEntity processInstance)

updateProcessDefinitionIdInHistory

public void updateProcessDefinitionIdInHistory(ProcessDefinitionEntity processDefinitionEntity,
                                               ExecutionEntity processInstance)

Description copied from interface: HistoryManager

Record the update of a process definition for historic process instance, task, and activity instance, if history is enabled.

updateHistoricActivityInstance

public void updateHistoricActivityInstance(ActivityInstance activityInstance)

Description copied from interface: HistoryManager

Update historic activity instance according to changes done in the runtime activity

recordHistoricUserTaskLogEntry

public void recordHistoricUserTaskLogEntry(org.flowable.task.api.history.HistoricTaskLogEntryBuilder taskLogEntryBuilder)

Description copied from interface: HistoryManager

Record historic user task log entry

Parameters:

taskLogEntryBuilder - historic user task log entry description

deleteHistoryUserTaskLog

public void deleteHistoryUserTaskLog(long logNumber)

Description copied from interface: HistoryManager

Delete historic user task log entry

Parameters:

logNumber - log identifier

createHistoricActivityInstance

public void createHistoricActivityInstance(ActivityInstance activityInstance)

Description copied from interface: HistoryManager

Create new historic activity instance from runtime activity instance

Parameters:

activityInstance - activity instance template

createNewHistoricActivityInstance

protected HistoricActivityInstanceEntity createNewHistoricActivityInstance(ActivityInstance activityInstance)