org.flowable.engine.impl.history

Class CompositeHistoryManager

java.lang.Object

org.flowable.engine.impl.history.CompositeHistoryManager

All Implemented Interfaces:

HistoryManager

public class CompositeHistoryManager
extends Object
implements HistoryManager

Author:

Filip Hrisafov

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection<HistoryManager>	historyManagers

Constructor Summary

Constructors

Constructor and Description
CompositeHistoryManager(Collection<HistoryManager> historyManagers)

Method Summary

Modifier and Type	Method and Description
void	createAttachmentComment(TaskEntity task, ExecutionEntity processInstance, String attachmentName, boolean create) Creates a new comment to indicate a new attachment has been created or deleted, if history is enabled.
void	createGroupIdentityLinkComment(TaskEntity task, String groupId, String type, boolean create) Creates a new comment to indicate a new group IdentityLink has been created or deleted, if history is enabled.
void	createHistoricActivityInstance(ActivityInstance activityInstance) Create new historic activity instance from runtime activity instance
void	createIdentityLinkComment(TaskEntity task, String userId, String groupId, String type, boolean create) Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.
void	createIdentityLinkComment(TaskEntity task, String userId, String groupId, String type, boolean create, boolean forceNullUserId) Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.
void	createProcessInstanceIdentityLinkComment(ExecutionEntity processInstance, String userId, String groupId, String type, boolean create) Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.
void	createProcessInstanceIdentityLinkComment(ExecutionEntity processInstance, String userId, String groupId, String type, boolean create, boolean forceNullUserId) Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.
void	createUserIdentityLinkComment(TaskEntity task, String userId, String type, boolean create) Creates a new comment to indicate a new user IdentityLink has been created or deleted, if history is enabled.
void	createUserIdentityLinkComment(TaskEntity task, String userId, String type, boolean create, boolean forceNullUserId) Creates a new comment to indicate a new user IdentityLink has been created or deleted, if history is enabled.
void	deleteHistoryUserTaskLog(long logNumber) Delete historic user task log entry
HistoricActivityInstanceEntity	findHistoricActivityInstance(ExecutionEntity execution, boolean validateEndTimeNull) Finds the HistoricActivityInstanceEntity that is active in the given execution.
boolean	isHistoryEnabled()
boolean	isHistoryEnabled(String processDefinitionId)
boolean	isHistoryLevelAtLeast(HistoryLevel level)
boolean	isHistoryLevelAtLeast(HistoryLevel level, String processDefinitionId)
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) 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 variable) Record a variable has been deleted, if audit history is enabled.
void	recordVariableUpdate(VariableInstanceEntity variable, Date updateTime) Record a variable has been updated, if audit history is enabled.
void	updateActivity(ExecutionEntity executionEntity, String oldActivityId, org.flowable.bpmn.model.FlowElement newFlowElement, TaskEntity task, Date updateTime) Synchronize historic data with the current user task execution
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 java.lang.Object

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

Field Detail

historyManagers

protected final Collection<HistoryManager> historyManagers

Constructor Detail

CompositeHistoryManager

public CompositeHistoryManager(Collection<HistoryManager> historyManagers)

Method Detail

isHistoryLevelAtLeast

public boolean isHistoryLevelAtLeast(HistoryLevel level)

Specified by:

isHistoryLevelAtLeast in interface HistoryManager

Returns:

true, if the configured history-level is equal to OR set to a higher value than the given level.

isHistoryLevelAtLeast

public boolean isHistoryLevelAtLeast(HistoryLevel level,
                                     String processDefinitionId)

Specified by:

isHistoryLevelAtLeast in interface HistoryManager

Returns:

true, if the configured process definition history-level is equal to OR set to a higher value than the given level.

isHistoryEnabled

public boolean isHistoryEnabled()

Specified by:

isHistoryEnabled in interface HistoryManager

Returns:

true, if history-level is configured to level other than "none".

isHistoryEnabled

public boolean isHistoryEnabled(String processDefinitionId)

Specified by:

isHistoryEnabled in interface HistoryManager

Returns:

true, if process definition history-level is configured to level other than "none".

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.

Specified by:

recordProcessInstanceEnd in interface HistoryManager

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.

Specified by:

recordProcessInstanceStart in interface HistoryManager

recordProcessInstanceNameChange

public void recordProcessInstanceNameChange(ExecutionEntity processInstanceExecution,
                                            String newName)

Description copied from interface: HistoryManager

Record a process-instance name change.

Specified by:

recordProcessInstanceNameChange in interface HistoryManager

recordProcessInstanceDeleted

public void recordProcessInstanceDeleted(String processInstanceId,
                                         String processDefinitionId)

Description copied from interface: HistoryManager

Deletes a historic process instance and all historic data included

Specified by:

recordProcessInstanceDeleted in interface HistoryManager

recordDeleteHistoricProcessInstancesByProcessDefinitionId

public void recordDeleteHistoricProcessInstancesByProcessDefinitionId(String processDefinitionId)

Description copied from interface: HistoryManager

Deletes historic process instances for a provided process definition id

Specified by:

recordDeleteHistoricProcessInstancesByProcessDefinitionId in interface HistoryManager

recordActivityStart

public void recordActivityStart(ActivityInstance activityInstance)

Description copied from interface: HistoryManager

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

Specified by:

recordActivityStart in interface HistoryManager

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.

Specified by:

recordActivityEnd in interface HistoryManager

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.

Specified by:

recordActivityEnd in interface HistoryManager

findHistoricActivityInstance

public HistoricActivityInstanceEntity findHistoricActivityInstance(ExecutionEntity execution,
                                                                   boolean validateEndTimeNull)

Description copied from interface: HistoryManager

Finds the HistoricActivityInstanceEntity that is active in the given execution.

Specified by:

findHistoricActivityInstance in interface HistoryManager

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.

Specified by:

recordProcessDefinitionChange in interface HistoryManager

recordTaskCreated

public void recordTaskCreated(TaskEntity task,
                              ExecutionEntity execution)

Description copied from interface: HistoryManager

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

Specified by:

recordTaskCreated in interface HistoryManager

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.

Specified by:

recordTaskEnd in interface HistoryManager

recordTaskInfoChange

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

Description copied from interface: HistoryManager

Record task name change, if audit history is enabled.

Specified by:

recordTaskInfoChange in interface HistoryManager

recordVariableCreate

public void recordVariableCreate(VariableInstanceEntity variable,
                                 Date createTime)

Description copied from interface: HistoryManager

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

Specified by:

recordVariableCreate in interface HistoryManager

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.

Specified by:

recordHistoricDetailVariableCreate in interface HistoryManager

recordVariableUpdate

public void recordVariableUpdate(VariableInstanceEntity variable,
                                 Date updateTime)

Description copied from interface: HistoryManager

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

Specified by:

recordVariableUpdate in interface HistoryManager

recordVariableRemoved

public void recordVariableRemoved(VariableInstanceEntity variable)

Description copied from interface: HistoryManager

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

Specified by:

recordVariableRemoved in interface HistoryManager

createIdentityLinkComment

public void createIdentityLinkComment(TaskEntity task,
                                      String userId,
                                      String groupId,
                                      String type,
                                      boolean create)

Description copied from interface: HistoryManager

Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.

Specified by:

createIdentityLinkComment in interface HistoryManager

createUserIdentityLinkComment

public void createUserIdentityLinkComment(TaskEntity task,
                                          String userId,
                                          String type,
                                          boolean create)

Description copied from interface: HistoryManager

Creates a new comment to indicate a new user IdentityLink has been created or deleted, if history is enabled.

Specified by:

createUserIdentityLinkComment in interface HistoryManager

createGroupIdentityLinkComment

public void createGroupIdentityLinkComment(TaskEntity task,
                                           String groupId,
                                           String type,
                                           boolean create)

Description copied from interface: HistoryManager

Creates a new comment to indicate a new group IdentityLink has been created or deleted, if history is enabled.

Specified by:

createGroupIdentityLinkComment in interface HistoryManager

createIdentityLinkComment

public void createIdentityLinkComment(TaskEntity task,
                                      String userId,
                                      String groupId,
                                      String type,
                                      boolean create,
                                      boolean forceNullUserId)

Description copied from interface: HistoryManager

Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.

Specified by:

createIdentityLinkComment in interface HistoryManager

createUserIdentityLinkComment

public void createUserIdentityLinkComment(TaskEntity task,
                                          String userId,
                                          String type,
                                          boolean create,
                                          boolean forceNullUserId)

Description copied from interface: HistoryManager

Creates a new comment to indicate a new user IdentityLink has been created or deleted, if history is enabled.

Specified by:

createUserIdentityLinkComment in interface HistoryManager

createProcessInstanceIdentityLinkComment

public void createProcessInstanceIdentityLinkComment(ExecutionEntity processInstance,
                                                     String userId,
                                                     String groupId,
                                                     String type,
                                                     boolean create)

Description copied from interface: HistoryManager

Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.

Specified by:

createProcessInstanceIdentityLinkComment in interface HistoryManager

createProcessInstanceIdentityLinkComment

public void createProcessInstanceIdentityLinkComment(ExecutionEntity processInstance,
                                                     String userId,
                                                     String groupId,
                                                     String type,
                                                     boolean create,
                                                     boolean forceNullUserId)

Description copied from interface: HistoryManager

Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.

Specified by:

createProcessInstanceIdentityLinkComment in interface HistoryManager

createAttachmentComment

public void createAttachmentComment(TaskEntity task,
                                    ExecutionEntity processInstance,
                                    String attachmentName,
                                    boolean create)

Description copied from interface: HistoryManager

Creates a new comment to indicate a new attachment has been created or deleted, if history is enabled.

Specified by:

createAttachmentComment in interface HistoryManager

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.

Specified by:

recordFormPropertiesSubmitted in interface HistoryManager

recordIdentityLinkCreated

public void recordIdentityLinkCreated(IdentityLinkEntity identityLink)

Description copied from interface: HistoryManager

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

Specified by:

recordIdentityLinkCreated in interface HistoryManager

recordIdentityLinkDeleted

public void recordIdentityLinkDeleted(IdentityLinkEntity identityLink)

Description copied from interface: HistoryManager

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

Specified by:

recordIdentityLinkDeleted in interface HistoryManager

recordEntityLinkCreated

public void recordEntityLinkCreated(EntityLinkEntity entityLink)

Description copied from interface: HistoryManager

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

Specified by:

recordEntityLinkCreated in interface HistoryManager

recordEntityLinkDeleted

public void recordEntityLinkDeleted(EntityLinkEntity entityLink)

Description copied from interface: HistoryManager

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

Specified by:

recordEntityLinkDeleted in interface HistoryManager

updateProcessBusinessKeyInHistory

public void updateProcessBusinessKeyInHistory(ExecutionEntity processInstance)

Specified by:

updateProcessBusinessKeyInHistory in interface HistoryManager

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.

Specified by:

updateProcessDefinitionIdInHistory in interface HistoryManager

updateActivity

public void updateActivity(ExecutionEntity executionEntity,
                           String oldActivityId,
                           org.flowable.bpmn.model.FlowElement newFlowElement,
                           TaskEntity task,
                           Date updateTime)

Description copied from interface: HistoryManager

Synchronize historic data with the current user task execution

Specified by:

updateActivity in interface HistoryManager

Parameters:

executionEntity - entity which executes user task

oldActivityId - previous activityId

newFlowElement - new flowElement

task - new user task

updateHistoricActivityInstance

public void updateHistoricActivityInstance(ActivityInstance activityInstance)

Description copied from interface: HistoryManager

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

Specified by:

updateHistoricActivityInstance in interface HistoryManager

createHistoricActivityInstance

public void createHistoricActivityInstance(ActivityInstance activityInstance)

Description copied from interface: HistoryManager

Create new historic activity instance from runtime activity instance

Specified by:

createHistoricActivityInstance in interface HistoryManager

Parameters:

activityInstance - activity instance template

recordHistoricUserTaskLogEntry

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

Description copied from interface: HistoryManager

Record historic user task log entry

Specified by:

recordHistoricUserTaskLogEntry in interface HistoryManager

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

Specified by:

deleteHistoryUserTaskLog in interface HistoryManager

Parameters:

logNumber - log identifier