Package 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
Manager class that centralises recording of all history-related operations that are originated from inside the engine.
- Author:
- Frederik Heremans, Joram Barrez
-
Field Summary
FieldsFields inherited from class org.flowable.engine.impl.persistence.AbstractManager
processEngineConfiguration -
Constructor Summary
ConstructorsConstructorDescriptionDefaultHistoryManager(ProcessEngineConfigurationImpl processEngineConfiguration) -
Method Summary
Modifier and TypeMethodDescriptionvoidcreateHistoricActivityInstance(ActivityInstance activityInstance) Create new historic activity instance from runtime activity instanceprotected HistoricActivityInstanceEntitycreateNewHistoricActivityInstance(ActivityInstance activityInstance) voiddeleteHistoryUserTaskLog(long logNumber) Delete historic user task log entryvoidrecordActivityEnd(ActivityInstance activityInstance) Record the end of an activity, if activity history is enabled.voidrecordActivityStart(ActivityInstance activityInstance) Record the start of an activity, if activity history is enabled.voidrecordBulkDeleteProcessInstances(Collection<String> processInstanceIds) Bulk delete historic process instances by idvoidrecordDeleteHistoricProcessInstancesByProcessDefinitionId(String processDefinitionId) Deletes historic process instances for a provided process definition idvoidrecordEntityLinkCreated(EntityLinkEntity entityLink) Record the creation of a newEntityLink, if audit history is enabled.voidrecordEntityLinkDeleted(EntityLinkEntity entityLink) Record the deletion of aEntityLink, if audit history is enabledvoidrecordFormPropertiesSubmitted(ExecutionEntity processInstance, Map<String, String> properties, String taskId, Date createTime) Report form properties submitted, if audit history is enabled.voidrecordHistoricDetailVariableCreate(VariableInstanceEntity variable, ExecutionEntity sourceActivityExecution, boolean useActivityId, String activityInstanceId, Date createTime) Record a variable has been created, if audit history is enabled.voidRecord historic task deleted, if audit history is enabled.voidrecordHistoricUserTaskLogEntry(HistoricTaskLogEntryBuilder taskLogEntryBuilder) Record historic user task log entryvoidrecordIdentityLinkCreated(IdentityLinkEntity identityLink) Record the creation of a newIdentityLink, if audit history is enabled.voidrecordIdentityLinkDeleted(IdentityLinkEntity identityLink) Record the deletion of aIdentityLink, if audit history is enabledvoidrecordProcessDefinitionChange(String processInstanceId, String processDefinitionId) Record a change of the process-definition id of a process instance, if activity history is enabled.voidrecordProcessInstanceDeleted(String processInstanceId, String processDefinitionId, String processTenantId) Deletes a historic process instance and all historic data includedvoidrecordProcessInstanceEnd(ExecutionEntity processInstance, String deleteReason, String activityId, Date endTime) Record a process-instance ended.voidrecordProcessInstanceNameChange(ExecutionEntity processInstanceExecution, String newName) Record a process-instance name change.voidrecordProcessInstanceStart(ExecutionEntity processInstance) Record a process-instance started and record start-event if activity history is enabled.voidrecordTaskCreated(TaskEntity task, ExecutionEntity execution) Record the creation of a task, if audit history is enabled.voidrecordTaskEnd(TaskEntity task, ExecutionEntity execution, String userId, String deleteReason, Date endTime) Record task as ended, if audit history is enabled.voidrecordTaskInfoChange(TaskEntity taskEntity, String activityInstanceId, Date changeTime) Record task name change, if audit history is enabled.voidrecordVariableCreate(VariableInstanceEntity variable, Date createTime) Record a variable has been created, if audit history is enabled.voidrecordVariableRemoved(VariableInstanceEntity variableInstanceEntity) Record a variable has been deleted, if audit history is enabled.voidrecordVariableUpdate(VariableInstanceEntity variableInstanceEntity, Date updateTime) Record a variable has been updated, if audit history is enabled.voidupdateHistoricActivityInstance(ActivityInstance activityInstance) Update historic activity instance according to changes done in the runtime activityvoidupdateProcessBusinessKeyInHistory(ExecutionEntity processInstance) voidupdateProcessBusinessStatusInHistory(ExecutionEntity processInstance) voidupdateProcessDefinitionIdInHistory(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, getHistoryConfigurationSettings, getProcessDefinitionId, isHistoryEnabled, isHistoryEnabled, isHistoryLevelAtLeast, isHistoryLevelAtLeast, parseActivityType, updateActivityMethods 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
-
Field Details
-
MAX_SUB_PROCESS_INSTANCES
public static final int MAX_SUB_PROCESS_INSTANCES- See Also:
-
-
Constructor Details
-
DefaultHistoryManager
-
-
Method Details
-
recordProcessInstanceEnd
public void recordProcessInstanceEnd(ExecutionEntity processInstance, String deleteReason, String activityId, Date endTime) Description copied from interface:HistoryManagerRecord 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:HistoryManagerRecord a process-instance name change. -
recordProcessInstanceStart
Description copied from interface:HistoryManagerRecord 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:HistoryManagerDeletes a historic process instance and all historic data included -
recordDeleteHistoricProcessInstancesByProcessDefinitionId
Description copied from interface:HistoryManagerDeletes historic process instances for a provided process definition id -
recordBulkDeleteProcessInstances
Description copied from interface:HistoryManagerBulk delete historic process instances by id -
recordActivityStart
Description copied from interface:HistoryManagerRecord the start of an activity, if activity history is enabled.- Parameters:
activityInstance- activity instance template
-
recordActivityEnd
Description copied from interface:HistoryManagerRecord the end of an activity, if activity history is enabled.- Parameters:
activityInstance- activity instance template
-
recordProcessDefinitionChange
Description copied from interface:HistoryManagerRecord a change of the process-definition id of a process instance, if activity history is enabled. -
recordTaskCreated
Description copied from interface:HistoryManagerRecord the creation of a task, if audit history is enabled. -
recordTaskEnd
public void recordTaskEnd(TaskEntity task, ExecutionEntity execution, String userId, String deleteReason, Date endTime) Description copied from interface:HistoryManagerRecord task as ended, if audit history is enabled. -
recordTaskInfoChange
Description copied from interface:HistoryManagerRecord task name change, if audit history is enabled. -
recordHistoricTaskDeleted
Description copied from interface:HistoryManagerRecord historic task deleted, if audit history is enabled. -
recordVariableCreate
Description copied from interface:HistoryManagerRecord 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:HistoryManagerRecord a variable has been created, if audit history is enabled. -
recordVariableUpdate
Description copied from interface:HistoryManagerRecord a variable has been updated, if audit history is enabled. -
recordVariableRemoved
Description copied from interface:HistoryManagerRecord 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:HistoryManagerReport form properties submitted, if audit history is enabled. -
recordIdentityLinkCreated
Description copied from interface:HistoryManagerRecord the creation of a newIdentityLink, if audit history is enabled. -
recordIdentityLinkDeleted
Description copied from interface:HistoryManagerRecord the deletion of aIdentityLink, if audit history is enabled -
recordEntityLinkCreated
Description copied from interface:HistoryManagerRecord the creation of a newEntityLink, if audit history is enabled. -
recordEntityLinkDeleted
Description copied from interface:HistoryManagerRecord the deletion of aEntityLink, if audit history is enabled -
updateProcessBusinessKeyInHistory
-
updateProcessBusinessStatusInHistory
-
updateProcessDefinitionIdInHistory
public void updateProcessDefinitionIdInHistory(ProcessDefinitionEntity processDefinitionEntity, ExecutionEntity processInstance) Description copied from interface:HistoryManagerRecord the update of a process definition for historic process instance, task, and activity instance, if history is enabled. -
updateHistoricActivityInstance
Description copied from interface:HistoryManagerUpdate historic activity instance according to changes done in the runtime activity -
recordHistoricUserTaskLogEntry
Description copied from interface:HistoryManagerRecord historic user task log entry- Parameters:
taskLogEntryBuilder- historic user task log entry description
-
deleteHistoryUserTaskLog
public void deleteHistoryUserTaskLog(long logNumber) Description copied from interface:HistoryManagerDelete historic user task log entry- Parameters:
logNumber- log identifier
-
createHistoricActivityInstance
Description copied from interface:HistoryManagerCreate new historic activity instance from runtime activity instance- Parameters:
activityInstance- activity instance template
-
createNewHistoricActivityInstance
protected HistoricActivityInstanceEntity createNewHistoricActivityInstance(ActivityInstance activityInstance)
-