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 TypeMethodDescriptionvoid
createHistoricActivityInstance
(ActivityInstance activityInstance) Create new historic activity instance from runtime activity instanceprotected HistoricActivityInstanceEntity
createNewHistoricActivityInstance
(ActivityInstance activityInstance) void
deleteHistoryUserTaskLog
(long logNumber) Delete historic user task log entryvoid
recordActivityEnd
(ActivityInstance activityInstance) Record the end of an activity, if activity history is enabled.void
recordActivityStart
(ActivityInstance activityInstance) Record the start of an activity, if activity history is enabled.void
recordBulkDeleteProcessInstances
(Collection<String> processInstanceIds) Bulk delete historic process instances by idvoid
recordDeleteHistoricProcessInstancesByProcessDefinitionId
(String processDefinitionId) Deletes historic process instances for a provided process definition idvoid
recordEntityLinkCreated
(EntityLinkEntity entityLink) Record the creation of a newEntityLink
, if audit history is enabled.void
recordEntityLinkDeleted
(EntityLinkEntity entityLink) Record the deletion of aEntityLink
, if audit history is enabledvoid
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
Record historic task deleted, if audit history is enabled.void
recordHistoricUserTaskLogEntry
(HistoricTaskLogEntryBuilder taskLogEntryBuilder) Record historic user task log entryvoid
recordIdentityLinkCreated
(IdentityLinkEntity identityLink) Record the creation of a newIdentityLink
, if audit history is enabled.void
recordIdentityLinkDeleted
(IdentityLinkEntity identityLink) Record the deletion of aIdentityLink
, if audit history is enabledvoid
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 includedvoid
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 userId, 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 activityvoid
updateProcessBusinessKeyInHistory
(ExecutionEntity processInstance) void
updateProcessBusinessStatusInHistory
(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, getHistoryConfigurationSettings, getProcessDefinitionId, 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
-
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: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
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
Description copied from interface:HistoryManager
Deletes historic process instances for a provided process definition id -
recordBulkDeleteProcessInstances
Description copied from interface:HistoryManager
Bulk delete historic process instances by id -
recordActivityStart
Description copied from interface:HistoryManager
Record the start of an activity, if activity history is enabled.- Parameters:
activityInstance
- activity instance template
-
recordActivityEnd
Description copied from interface:HistoryManager
Record the end of an activity, if activity history is enabled.- Parameters:
activityInstance
- activity instance template
-
recordProcessDefinitionChange
Description copied from interface:HistoryManager
Record a change of the process-definition id of a process instance, if activity history is enabled. -
recordTaskCreated
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 userId, String deleteReason, Date endTime) Description copied from interface:HistoryManager
Record task as ended, if audit history is enabled. -
recordTaskInfoChange
Description copied from interface:HistoryManager
Record task name change, if audit history is enabled. -
recordHistoricTaskDeleted
Description copied from interface:HistoryManager
Record historic task deleted, if audit history is enabled. -
recordVariableCreate
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
Description copied from interface:HistoryManager
Record a variable has been updated, if audit history is enabled. -
recordVariableRemoved
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
Description copied from interface:HistoryManager
Record the creation of a newIdentityLink
, if audit history is enabled. -
recordIdentityLinkDeleted
Description copied from interface:HistoryManager
Record the deletion of aIdentityLink
, if audit history is enabled -
recordEntityLinkCreated
Description copied from interface:HistoryManager
Record the creation of a newEntityLink
, if audit history is enabled. -
recordEntityLinkDeleted
Description copied from interface:HistoryManager
Record the deletion of aEntityLink
, if audit history is enabled -
updateProcessBusinessKeyInHistory
-
updateProcessBusinessStatusInHistory
-
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
Description copied from interface:HistoryManager
Update historic activity instance according to changes done in the runtime activity -
recordHistoricUserTaskLogEntry
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
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)
-