org.activiti5.engine.impl.history

Class DefaultHistoryManager

java.lang.Object

org.activiti5.engine.impl.persistence.AbstractManager

org.activiti5.engine.impl.history.DefaultHistoryManager

All Implemented Interfaces:

HistoryManager, Session

public class DefaultHistoryManager
extends AbstractManager
implements HistoryManager

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

Author:

Frederik Heremans, Joram Barrez

Constructor Summary

Constructors

Constructor and Description
DefaultHistoryManager()

Method Summary

Modifier and Type	Method and Description
void	createAttachmentComment(String taskId, String processInstanceId, String attachmentName, boolean create) Creates a new comment to indicate a new attachment has been created or deleted, if history is enabled.
void	createGroupIdentityLinkComment(String taskId, 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	createIdentityLinkComment(String taskId, 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(String taskId, 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(String processInstanceId, 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(String processInstanceId, 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(String taskId, 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(String taskId, 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	deleteHistoricIdentityLink(String id)
protected void	endHistoricActivityInstance(HistoricActivityInstanceEntity historicActivityInstance)
HistoricActivityInstanceEntity	findActivityInstance(ExecutionEntity execution) Finds the HistoricActivityInstanceEntity that is active in the given execution.
protected HistoricActivityInstanceEntity	findActivityInstance(ExecutionEntity execution, String activityId, boolean checkPersistentStore)
boolean	isHistoryEnabled()
boolean	isHistoryLevelAtLeast(HistoryLevel level)
void	recordActivityEnd(ExecutionEntity executionEntity) Record the end of an activitiy, if activity history is enabled.
void	recordActivityStart(ExecutionEntity executionEntity) Record the start of an activitiy, if activity history is enabled.
void	recordExecutionReplacedBy(ExecutionEntity execution, InterpretableExecution replacedBy) Replaces any open historic activityInstances' execution-id's to the id of the replaced execution, if activity history is enabled.
void	recordHistoricDetailVariableCreate(VariableInstanceEntity variable, ExecutionEntity sourceActivityExecution, boolean useActivityId) Record a variable has been created, if audit history is enabled.
void	recordIdentityLinkCreated(IdentityLinkEntity identityLink) Record the creation of a new 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	recordProcessInstanceEnd(String processInstanceId, String deleteReason, String activityId) Record a process-instance ended.
void	recordProcessInstanceNameChange(String processInstanceId, 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	recordStartEventEnded(ExecutionEntity execution, String activityId) Record the end of a start-task, if activity history is enabled.
void	recordSubProcessInstanceStart(ExecutionEntity parentExecution, ExecutionEntity subProcessInstance) Record a sub-process-instance started and alters the calledProcessinstanceId on the current active activity's historic counterpart.
void	recordTaskAssigneeChange(String taskId, String assignee) Record task assignee change, if audit history is enabled.
void	recordTaskAssignment(TaskEntity task) Record the assignment of task, if activity history is enabled.
void	recordTaskCategoryChange(String taskId, String category) Record task category change, if audit history is enabled.
void	recordTaskClaim(String taskId) record task instance claim time, if audit history is enabled
void	recordTaskCreated(TaskEntity task, ExecutionEntity execution) Record the creation of a task, if audit history is enabled.
void	recordTaskDefinitionKeyChange(TaskEntity task, String taskDefinitionKey) Record task definition key change, if audit history is enabled.
void	recordTaskDescriptionChange(String taskId, String description) Record task description change, if audit history is enabled.
void	recordTaskDueDateChange(String taskId, Date dueDate) Record task due date change, if audit history is enabled.
void	recordTaskEnd(String taskId, String deleteReason) Record task as ended, if audit history is enabled.
void	recordTaskExecutionIdChange(String taskId, String executionId) Record task execution id change, if audit history is enabled.
void	recordTaskFormKeyChange(String taskId, String formKey) Record task form key change, if audit history is enabled.
void	recordTaskId(TaskEntity task) Record the id of a the task associated with a historic activity, if activity history is enabled.
void	recordTaskNameChange(String taskId, String taskName) Record task name change, if audit history is enabled.
void	recordTaskOwnerChange(String taskId, String owner) Record task owner change, if audit history is enabled.
void	recordTaskParentTaskIdChange(String taskId, String parentTaskId) Record task parent task id change, if audit history is enabled.
void	recordTaskPriorityChange(String taskId, int priority) Record task priority change, if audit history is enabled.
void	recordTaskProcessDefinitionChange(String taskId, String processDefinitionId) Record a change of the process-definition id of a task instance, if activity history is enabled.
void	recordVariableCreate(VariableInstanceEntity variable) 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) Record a variable has been updated, if audit history is enabled.
void	reportFormPropertiesSubmitted(ExecutionEntity processInstance, Map<String,String> properties, String taskId) Report form properties submitted, if audit history is enabled.
void	updateProcessBusinessKeyInHistory(ExecutionEntity processInstance)

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

close, delete, flush, getAttachmentManager, getByteArrayManager, getDbSqlSession, getDeploymentManager, getEventSubscriptionManager, getGroupIdentityManager, getHistoricActivityInstanceManager, getHistoricDetailManager, getHistoricIdentityLinkEntityManager, getHistoricProcessInstanceManager, getHistoricTaskInstanceManager, getHistoricVariableInstanceManager, getHistoryManager, getIdentityInfoManager, getIdentityLinkManager, getMembershipIdentityManager, getModelManager, getProcessDefinitionInfoManager, getProcessDefinitionManager, getProcessEngineConfiguration, getProcessInstanceManager, getResourceManager, getSession, getTaskManager, getUserIdentityManager, getVariableInstanceManager, insert

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.activiti5.engine.impl.interceptor.Session

close, flush

Constructor Detail

DefaultHistoryManager

public DefaultHistoryManager()

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.

isHistoryEnabled

public boolean isHistoryEnabled()

Specified by:

isHistoryEnabled in interface HistoryManager

Returns:

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

recordProcessInstanceEnd

public void recordProcessInstanceEnd(String processInstanceId,
                                     String deleteReason,
                                     String activityId)

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

recordProcessInstanceNameChange

public void recordProcessInstanceNameChange(String processInstanceId,
                                            String newName)

Description copied from interface: HistoryManager

Record a process-instance name change.

Specified by:

recordProcessInstanceNameChange 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

recordSubProcessInstanceStart

public void recordSubProcessInstanceStart(ExecutionEntity parentExecution,
                                          ExecutionEntity subProcessInstance)

Description copied from interface: HistoryManager

Record a sub-process-instance started and alters the calledProcessinstanceId on the current active activity's historic counterpart. Only effective when activity history is enabled.

Specified by:

recordSubProcessInstanceStart in interface HistoryManager

recordActivityStart

public void recordActivityStart(ExecutionEntity executionEntity)

Description copied from interface: HistoryManager

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

Specified by:

recordActivityStart in interface HistoryManager

recordActivityEnd

public void recordActivityEnd(ExecutionEntity executionEntity)

Description copied from interface: HistoryManager

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

Specified by:

recordActivityEnd in interface HistoryManager

endHistoricActivityInstance

protected void endHistoricActivityInstance(HistoricActivityInstanceEntity historicActivityInstance)

recordStartEventEnded

public void recordStartEventEnded(ExecutionEntity execution,
                                  String activityId)

Description copied from interface: HistoryManager

Record the end of a start-task, if activity history is enabled.

Specified by:

recordStartEventEnded in interface HistoryManager

findActivityInstance

public HistoricActivityInstanceEntity findActivityInstance(ExecutionEntity execution)

Description copied from interface: HistoryManager

Finds the HistoricActivityInstanceEntity that is active in the given execution. Uses the DbSqlSession cache to make sure the right instance is returned, regardless of whether or not entities have already been flushed to DB.

Specified by:

findActivityInstance in interface HistoryManager

findActivityInstance

protected HistoricActivityInstanceEntity findActivityInstance(ExecutionEntity execution,
                                                              String activityId,
                                                              boolean checkPersistentStore)

recordExecutionReplacedBy

public void recordExecutionReplacedBy(ExecutionEntity execution,
                                      InterpretableExecution replacedBy)

Description copied from interface: HistoryManager

Replaces any open historic activityInstances' execution-id's to the id of the replaced execution, if activity history is enabled.

Specified by:

recordExecutionReplacedBy 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

recordTaskAssignment

public void recordTaskAssignment(TaskEntity task)

Description copied from interface: HistoryManager

Record the assignment of task, if activity history is enabled.

Specified by:

recordTaskAssignment in interface HistoryManager

recordTaskClaim

public void recordTaskClaim(String taskId)

Description copied from interface: HistoryManager

record task instance claim time, if audit history is enabled

Specified by:

recordTaskClaim in interface HistoryManager

recordTaskId

public void recordTaskId(TaskEntity task)

Description copied from interface: HistoryManager

Record the id of a the task associated with a historic activity, if activity history is enabled.

Specified by:

recordTaskId in interface HistoryManager

recordTaskEnd

public void recordTaskEnd(String taskId,
                          String deleteReason)

Description copied from interface: HistoryManager

Record task as ended, if audit history is enabled.

Specified by:

recordTaskEnd in interface HistoryManager

recordTaskAssigneeChange

public void recordTaskAssigneeChange(String taskId,
                                     String assignee)

Description copied from interface: HistoryManager

Record task assignee change, if audit history is enabled.

Specified by:

recordTaskAssigneeChange in interface HistoryManager

recordTaskOwnerChange

public void recordTaskOwnerChange(String taskId,
                                  String owner)

Description copied from interface: HistoryManager

Record task owner change, if audit history is enabled.

Specified by:

recordTaskOwnerChange in interface HistoryManager

recordTaskNameChange

public void recordTaskNameChange(String taskId,
                                 String taskName)

Description copied from interface: HistoryManager

Record task name change, if audit history is enabled.

Specified by:

recordTaskNameChange in interface HistoryManager

recordTaskDescriptionChange

public void recordTaskDescriptionChange(String taskId,
                                        String description)

Description copied from interface: HistoryManager

Record task description change, if audit history is enabled.

Specified by:

recordTaskDescriptionChange in interface HistoryManager

recordTaskDueDateChange

public void recordTaskDueDateChange(String taskId,
                                    Date dueDate)

Description copied from interface: HistoryManager

Record task due date change, if audit history is enabled.

Specified by:

recordTaskDueDateChange in interface HistoryManager

recordTaskPriorityChange

public void recordTaskPriorityChange(String taskId,
                                     int priority)

Description copied from interface: HistoryManager

Record task priority change, if audit history is enabled.

Specified by:

recordTaskPriorityChange in interface HistoryManager

recordTaskCategoryChange

public void recordTaskCategoryChange(String taskId,
                                     String category)

Description copied from interface: HistoryManager

Record task category change, if audit history is enabled.

Specified by:

recordTaskCategoryChange in interface HistoryManager

recordTaskFormKeyChange

public void recordTaskFormKeyChange(String taskId,
                                    String formKey)

Description copied from interface: HistoryManager

Record task form key change, if audit history is enabled.

Specified by:

recordTaskFormKeyChange in interface HistoryManager

recordTaskParentTaskIdChange

public void recordTaskParentTaskIdChange(String taskId,
                                         String parentTaskId)

Description copied from interface: HistoryManager

Record task parent task id change, if audit history is enabled.

Specified by:

recordTaskParentTaskIdChange in interface HistoryManager

recordTaskExecutionIdChange

public void recordTaskExecutionIdChange(String taskId,
                                        String executionId)

Description copied from interface: HistoryManager

Record task execution id change, if audit history is enabled.

Specified by:

recordTaskExecutionIdChange in interface HistoryManager

recordTaskDefinitionKeyChange

public void recordTaskDefinitionKeyChange(TaskEntity task,
                                          String taskDefinitionKey)

Description copied from interface: HistoryManager

Record task definition key change, if audit history is enabled.

Specified by:

recordTaskDefinitionKeyChange in interface HistoryManager

recordTaskProcessDefinitionChange

public void recordTaskProcessDefinitionChange(String taskId,
                                              String processDefinitionId)

Description copied from interface: HistoryManager

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

Specified by:

recordTaskProcessDefinitionChange in interface HistoryManager

recordVariableCreate

public void recordVariableCreate(VariableInstanceEntity variable)

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)

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)

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(String taskId,
                                      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(String taskId,
                                          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(String taskId,
                                           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

createUserIdentityLinkComment

public void createUserIdentityLinkComment(String taskId,
                                          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

createIdentityLinkComment

public void createIdentityLinkComment(String taskId,
                                      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

createProcessInstanceIdentityLinkComment

public void createProcessInstanceIdentityLinkComment(String processInstanceId,
                                                     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(String processInstanceId,
                                                     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(String taskId,
                                    String processInstanceId,
                                    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

reportFormPropertiesSubmitted

public void reportFormPropertiesSubmitted(ExecutionEntity processInstance,
                                          Map<String,String> properties,
                                          String taskId)

Description copied from interface: HistoryManager

Report form properties submitted, if audit history is enabled.

Specified by:

reportFormPropertiesSubmitted 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

deleteHistoricIdentityLink

public void deleteHistoricIdentityLink(String id)

Specified by:

deleteHistoricIdentityLink in interface HistoryManager

updateProcessBusinessKeyInHistory

public void updateProcessBusinessKeyInHistory(ExecutionEntity processInstance)

Specified by:

updateProcessBusinessKeyInHistory in interface HistoryManager