org.flowable.engine.impl.history

Class AbstractHistoryManager

java.lang.Object

org.flowable.engine.impl.persistence.AbstractManager

org.flowable.engine.impl.history.AbstractHistoryManager

All Implemented Interfaces:

HistoryManager

Direct Known Subclasses:

AsyncHistoryManager, DefaultHistoryManager

public abstract class AbstractHistoryManager
extends AbstractManager
implements HistoryManager

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	enableProcessDefinitionHistoryLevel
protected HistoryLevel	historyLevel
protected boolean	usePrefixId

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

processEngineConfiguration

Constructor Summary

Constructors

Constructor and Description
AbstractHistoryManager(ProcessEngineConfigurationImpl processEngineConfiguration, HistoryLevel historyLevel, boolean usePrefixId)

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 taskEntity, 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.
protected HistoricActivityInstanceEntity	createHistoricActivityInstanceEntity(ExecutionEntity execution)
void	createIdentityLinkComment(TaskEntity taskEntity, 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 taskEntity, 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 taskEntity, 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 taskEntity, 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.
HistoricActivityInstanceEntity	findActivityInstance(ExecutionEntity execution, boolean createOnNotFound, boolean endTimeMustBeNull) Finds the HistoricActivityInstanceEntity that is active in the given execution.
protected HistoricActivityInstanceEntity	findActivityInstance(ExecutionEntity execution, String activityId, boolean createOnNotFound, boolean endTimeMustBeNull)
protected String	getActivityIdForExecution(ExecutionEntity execution)
protected EntityCache	getEntityCache()
protected HistoricActivityInstanceEntity	getHistoricActivityInstanceFromCache(String executionId, String activityId, boolean endTimeMustBeNull)
HistoryLevel	getHistoryLevel()
protected HistoryLevel	getProcessDefinitionHistoryLevel(String processDefinitionId)
boolean	isHistoryEnabled()
boolean	isHistoryEnabled(String processDefinitionId)
boolean	isHistoryLevelAtLeast(HistoryLevel level)
boolean	isHistoryLevelAtLeast(HistoryLevel level, String processDefinitionId)
protected String	parseActivityType(org.flowable.bpmn.model.FlowElement element)
void	setHistoryLevel(HistoryLevel historyLevel)

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

getAsyncExecutor, getAttachmentEntityManager, getByteArrayEntityManager, getClock, getCommandContext, getCommandExecutor, getCommentEntityManager, getDeploymentEntityManager, getEventDispatcher, getEventSubscriptionEntityManager, 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

Methods inherited from interface org.flowable.engine.impl.history.HistoryManager

recordActivityEnd, recordActivityStart, recordDeleteHistoricProcessInstancesByProcessDefinitionId, recordFormPropertiesSubmitted, recordHistoricDetailVariableCreate, recordIdentityLinkCreated, recordIdentityLinkDeleted, recordProcessDefinitionChange, recordProcessInstanceDeleted, recordProcessInstanceEnd, recordProcessInstanceNameChange, recordProcessInstanceStart, recordSubProcessInstanceStart, recordTaskCreated, recordTaskEnd, recordTaskInfoChange, recordVariableCreate, recordVariableRemoved, recordVariableUpdate, updateProcessBusinessKeyInHistory, updateProcessDefinitionIdInHistory

Field Detail

historyLevel

protected HistoryLevel historyLevel

enableProcessDefinitionHistoryLevel

protected boolean enableProcessDefinitionHistoryLevel

usePrefixId

protected boolean usePrefixId

Constructor Detail

AbstractHistoryManager

public AbstractHistoryManager(ProcessEngineConfigurationImpl processEngineConfiguration,
                              HistoryLevel historyLevel,
                              boolean usePrefixId)

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".

createIdentityLinkComment

public void createIdentityLinkComment(TaskEntity taskEntity,
                                      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 taskEntity,
                                          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 taskEntity,
                                           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(TaskEntity taskEntity,
                                          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(TaskEntity taskEntity,
                                      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(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

getHistoricActivityInstanceFromCache

protected HistoricActivityInstanceEntity getHistoricActivityInstanceFromCache(String executionId,
                                                                              String activityId,
                                                                              boolean endTimeMustBeNull)

findActivityInstance

public HistoricActivityInstanceEntity findActivityInstance(ExecutionEntity execution,
                                                           boolean createOnNotFound,
                                                           boolean endTimeMustBeNull)

Description copied from interface: HistoryManager

Finds the HistoricActivityInstanceEntity that is active in the given execution.

Specified by:

findActivityInstance in interface HistoryManager

getActivityIdForExecution

protected String getActivityIdForExecution(ExecutionEntity execution)

findActivityInstance

protected HistoricActivityInstanceEntity findActivityInstance(ExecutionEntity execution,
                                                              String activityId,
                                                              boolean createOnNotFound,
                                                              boolean endTimeMustBeNull)

createHistoricActivityInstanceEntity

protected HistoricActivityInstanceEntity createHistoricActivityInstanceEntity(ExecutionEntity execution)

getProcessDefinitionHistoryLevel

protected HistoryLevel getProcessDefinitionHistoryLevel(String processDefinitionId)

parseActivityType

protected String parseActivityType(org.flowable.bpmn.model.FlowElement element)

getEntityCache

protected EntityCache getEntityCache()

getHistoryLevel

public HistoryLevel getHistoryLevel()

setHistoryLevel

public void setHistoryLevel(HistoryLevel historyLevel)