org.camunda.bpm.engine.impl

Class HistoryServiceImpl

java.lang.Object

org.camunda.bpm.engine.impl.ServiceImpl

org.camunda.bpm.engine.impl.HistoryServiceImpl

All Implemented Interfaces:

HistoryService

public class HistoryServiceImpl
extends ServiceImpl
implements HistoryService

Author:

Tom Baeyens, Bernd Ruecker (camunda), Christian Stettler

Field Summary

Fields inherited from class org.camunda.bpm.engine.impl.ServiceImpl

commandExecutor

Constructor Summary

Constructors

Constructor and Description
HistoryServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Job	cleanUpHistoryAsync() Schedules history cleanup job at batch window start time.
Job	cleanUpHistoryAsync(boolean immediatelyDue) Schedules history cleanup job.
HistoricActivityInstanceQuery	createHistoricActivityInstanceQuery() Creates a new programmatic query to search for HistoricActivityInstances.
HistoricActivityStatisticsQuery	createHistoricActivityStatisticsQuery(String processDefinitionId) Query for the number of historic activity instances aggregated by activities of a single process definition.
HistoricBatchQuery	createHistoricBatchQuery() Creates a query to search for HistoricBatch instances.
HistoricCaseActivityInstanceQuery	createHistoricCaseActivityInstanceQuery() Creates a new programmatic query to search for HistoricCaseActivityInstances.
HistoricCaseActivityStatisticsQuery	createHistoricCaseActivityStatisticsQuery(String caseDefinitionId) Query for the number of historic case activity instances aggregated by case activities of a single case definition.
HistoricCaseInstanceQuery	createHistoricCaseInstanceQuery() Creates a new programmatic query to search for HistoricCaseInstances.
HistoricDecisionInstanceQuery	createHistoricDecisionInstanceQuery() Creates a new programmatic query to search for HistoricDecisionInstances.
HistoricDecisionInstanceStatisticsQuery	createHistoricDecisionInstanceStatisticsQuery(String decisionRequirementsDefinitionId) Query for the statistics of DRD evaluation.
HistoricDetailQuery	createHistoricDetailQuery() Creates a new programmatic query to search for HistoricDetails.
HistoricExternalTaskLogQuery	createHistoricExternalTaskLogQuery() Creates a new programmatic query to search for historic external task logs.
HistoricIdentityLinkLogQueryImpl	createHistoricIdentityLinkLogQuery() Creates a new programmatic query to search for historic identity links.
HistoricIncidentQuery	createHistoricIncidentQuery() Creates a new programmatic query to search for historic incidents.
HistoricJobLogQuery	createHistoricJobLogQuery() Creates a new programmatic query to search for historic job logs.
HistoricProcessInstanceQuery	createHistoricProcessInstanceQuery() Creates a new programmatic query to search for HistoricProcessInstances.
HistoricProcessInstanceReport	createHistoricProcessInstanceReport() Creates a new programmatic query to create a historic process instance report.
HistoricTaskInstanceQuery	createHistoricTaskInstanceQuery() Creates a new programmatic query to search for HistoricTaskInstances.
HistoricTaskInstanceReport	createHistoricTaskInstanceReport() Creates a new programmatic query to create a historic task instance report.
HistoricVariableInstanceQuery	createHistoricVariableInstanceQuery() Creates a new programmatic query to search for HistoricVariableInstances.
NativeHistoricActivityInstanceQuery	createNativeHistoricActivityInstanceQuery() creates a native query to search for HistoricActivityInstances via SQL
NativeHistoricCaseActivityInstanceQuery	createNativeHistoricCaseActivityInstanceQuery() creates a native query to search for HistoricCaseActivityInstances via SQL
NativeHistoricCaseInstanceQuery	createNativeHistoricCaseInstanceQuery() creates a native query to search for HistoricCaseInstances via SQL
NativeHistoricDecisionInstanceQuery	createNativeHistoricDecisionInstanceQuery() creates a native query to search for HistoricDecisionInstances via SQL
NativeHistoricProcessInstanceQuery	createNativeHistoricProcessInstanceQuery() creates a native query to search for HistoricProcessInstances via SQL
NativeHistoricTaskInstanceQuery	createNativeHistoricTaskInstanceQuery() creates a native query to search for HistoricTaskInstances via SQL
UserOperationLogQuery	createUserOperationLogQuery() Creates a new programmatic query to search for UserOperationLogEntry instances.
void	deleteHistoricBatch(String batchId) Deletes a historic batch instance.
void	deleteHistoricCaseInstance(String caseInstanceId) Deletes historic case instance.
void	deleteHistoricCaseInstancesBulk(List<String> caseInstanceIds) Deletes historic case instances and all related historic data in bulk manner.
void	deleteHistoricDecisionInstance(String decisionDefinitionId) Deletes historic decision instances of a decision definition.
void	deleteHistoricDecisionInstanceByDefinitionId(String decisionDefinitionId) Deletes historic decision instances of a decision definition.
void	deleteHistoricDecisionInstanceByInstanceId(String historicDecisionInstanceId) Deletes historic decision instances by its id.
void	deleteHistoricDecisionInstancesBulk(List<String> decisionInstanceIds) Deletes decision instances and all related historic data in bulk manner.
void	deleteHistoricProcessInstance(String processInstanceId) Deletes historic process instance.
void	deleteHistoricProcessInstances(List<String> processInstanceIds) Deletes historic process instances.
Batch	deleteHistoricProcessInstancesAsync(HistoricProcessInstanceQuery query, String deleteReason) Deletes historic process instances asynchronously based on query.
Batch	deleteHistoricProcessInstancesAsync(List<String> processInstanceIds, HistoricProcessInstanceQuery query, String deleteReason) Deletes historic process instances asynchronously based on query and a list of process instances.
Batch	deleteHistoricProcessInstancesAsync(List<String> processInstanceIds, String deleteReason) Deletes historic process instances asynchronously.
void	deleteHistoricProcessInstancesBulk(List<String> processInstanceIds) Deletes historic process instances and all related historic data in bulk manner.
void	deleteHistoricTaskInstance(String taskId) Deletes historic task instance.
void	deleteUserOperationLogEntry(String entryId) Deletes a user operation log entry.
Job	findHistoryCleanupJob() Finds history cleanup job if present.
String	getHistoricExternalTaskLogErrorDetails(String historicExternalTaskLogId) Returns the full error details that occurs when the historic external task log with the given id was last executed.
String	getHistoricJobLogExceptionStacktrace(String historicJobLogId) Returns the full stacktrace of the exception that occurs when the historic job log with the given id was last executed.

Methods inherited from class org.camunda.bpm.engine.impl.ServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryServiceImpl

public HistoryServiceImpl()

Method Detail

createHistoricProcessInstanceQuery

public HistoricProcessInstanceQuery createHistoricProcessInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricProcessInstances.

Specified by:

createHistoricProcessInstanceQuery in interface HistoryService

createHistoricActivityInstanceQuery

public HistoricActivityInstanceQuery createHistoricActivityInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricActivityInstances.

Specified by:

createHistoricActivityInstanceQuery in interface HistoryService

createHistoricActivityStatisticsQuery

public HistoricActivityStatisticsQuery createHistoricActivityStatisticsQuery(String processDefinitionId)

Description copied from interface: HistoryService

Query for the number of historic activity instances aggregated by activities of a single process definition.

Specified by:

createHistoricActivityStatisticsQuery in interface HistoryService

createHistoricCaseActivityStatisticsQuery

public HistoricCaseActivityStatisticsQuery createHistoricCaseActivityStatisticsQuery(String caseDefinitionId)

Description copied from interface: HistoryService

Query for the number of historic case activity instances aggregated by case activities of a single case definition.

Specified by:

createHistoricCaseActivityStatisticsQuery in interface HistoryService

createHistoricTaskInstanceQuery

public HistoricTaskInstanceQuery createHistoricTaskInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricTaskInstances.

Specified by:

createHistoricTaskInstanceQuery in interface HistoryService

createHistoricDetailQuery

public HistoricDetailQuery createHistoricDetailQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricDetails.

Specified by:

createHistoricDetailQuery in interface HistoryService

createUserOperationLogQuery

public UserOperationLogQuery createUserOperationLogQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for UserOperationLogEntry instances.

Specified by:

createUserOperationLogQuery in interface HistoryService

createHistoricVariableInstanceQuery

public HistoricVariableInstanceQuery createHistoricVariableInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricVariableInstances.

Specified by:

createHistoricVariableInstanceQuery in interface HistoryService

createHistoricIncidentQuery

public HistoricIncidentQuery createHistoricIncidentQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for historic incidents.

Specified by:

createHistoricIncidentQuery in interface HistoryService

createHistoricIdentityLinkLogQuery

public HistoricIdentityLinkLogQueryImpl createHistoricIdentityLinkLogQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for historic identity links.

Specified by:

createHistoricIdentityLinkLogQuery in interface HistoryService

createHistoricCaseInstanceQuery

public HistoricCaseInstanceQuery createHistoricCaseInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricCaseInstances.

Specified by:

createHistoricCaseInstanceQuery in interface HistoryService

createHistoricCaseActivityInstanceQuery

public HistoricCaseActivityInstanceQuery createHistoricCaseActivityInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricCaseActivityInstances.

Specified by:

createHistoricCaseActivityInstanceQuery in interface HistoryService

createHistoricDecisionInstanceQuery

public HistoricDecisionInstanceQuery createHistoricDecisionInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricDecisionInstances. If the user has no Permissions.READ_HISTORY permission on Resources.DECISION_DEFINITION then the result of the query is empty.

Specified by:

createHistoricDecisionInstanceQuery in interface HistoryService

deleteHistoricTaskInstance

public void deleteHistoricTaskInstance(String taskId)

Description copied from interface: HistoryService

Deletes historic task instance. This might be useful for tasks that are dynamically created and then completed. If the historic task instance doesn't exist, no exception is thrown and the method returns normal.

Specified by:

deleteHistoricTaskInstance in interface HistoryService

deleteHistoricProcessInstance

public void deleteHistoricProcessInstance(String processInstanceId)

Description copied from interface: HistoryService

Deletes historic process instance. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well.

Specified by:

deleteHistoricProcessInstance in interface HistoryService

deleteHistoricProcessInstances

public void deleteHistoricProcessInstances(List<String> processInstanceIds)

Description copied from interface: HistoryService

Deletes historic process instances. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well.

Specified by:

deleteHistoricProcessInstances in interface HistoryService

deleteHistoricProcessInstancesBulk

public void deleteHistoricProcessInstancesBulk(List<String> processInstanceIds)

Description copied from interface: HistoryService

Deletes historic process instances and all related historic data in bulk manner. DELETE SQL statement will be created for each entity type. They will have list of given process instance ids in IN clause. Therefore, DB limitation for number of values in IN clause must be taken into account.

Specified by:

deleteHistoricProcessInstancesBulk in interface HistoryService

Parameters:

processInstanceIds - list of process instance ids for removal

cleanUpHistoryAsync

public Job cleanUpHistoryAsync()

Description copied from interface: HistoryService

Schedules history cleanup job at batch window start time. The job will delete historic data for finished processes taking into account ResourceDefinition.getHistoryTimeToLive() value.

Specified by:

cleanUpHistoryAsync in interface HistoryService

Returns:

history cleanup job. Job id can be used to check job logs, incident etc.

cleanUpHistoryAsync

public Job cleanUpHistoryAsync(boolean immediatelyDue)

Description copied from interface: HistoryService

Schedules history cleanup job. The job will delete historic data for finished processes taking into account ResourceDefinition.getHistoryTimeToLive() value.

Specified by:

cleanUpHistoryAsync in interface HistoryService

Parameters:

immediatelyDue - must be true if cleanup must be scheduled at once, otherwise is will be scheduled according to configured batch window

Returns:

history cleanup job. Job id can be used to check job logs, incident etc.

findHistoryCleanupJob

public Job findHistoryCleanupJob()

Description copied from interface: HistoryService

Finds history cleanup job if present.

Specified by:

findHistoryCleanupJob in interface HistoryService

Returns:

job entity

deleteHistoricProcessInstancesAsync

public Batch deleteHistoricProcessInstancesAsync(List<String> processInstanceIds,
                                        String deleteReason)

Description copied from interface: HistoryService

Deletes historic process instances asynchronously. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well.

Specified by:

deleteHistoricProcessInstancesAsync in interface HistoryService

deleteHistoricProcessInstancesAsync

public Batch deleteHistoricProcessInstancesAsync(HistoricProcessInstanceQuery query,
                                        String deleteReason)

Description copied from interface: HistoryService

Deletes historic process instances asynchronously based on query. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well.

Specified by:

deleteHistoricProcessInstancesAsync in interface HistoryService

deleteHistoricProcessInstancesAsync

public Batch deleteHistoricProcessInstancesAsync(List<String> processInstanceIds,
                                        HistoricProcessInstanceQuery query,
                                        String deleteReason)

Description copied from interface: HistoryService

Deletes historic process instances asynchronously based on query and a list of process instances. Query result and list of ids will be merged. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well.

Specified by:

deleteHistoricProcessInstancesAsync in interface HistoryService

deleteUserOperationLogEntry

public void deleteUserOperationLogEntry(String entryId)

Description copied from interface: HistoryService

Deletes a user operation log entry. Does not cascade to any related entities.

Specified by:

deleteUserOperationLogEntry in interface HistoryService

deleteHistoricCaseInstance

public void deleteHistoricCaseInstance(String caseInstanceId)

Description copied from interface: HistoryService

Deletes historic case instance. All historic case activities, historic task and historic details are deleted as well.

Specified by:

deleteHistoricCaseInstance in interface HistoryService

deleteHistoricCaseInstancesBulk

public void deleteHistoricCaseInstancesBulk(List<String> caseInstanceIds)

Description copied from interface: HistoryService

Deletes historic case instances and all related historic data in bulk manner. DELETE SQL statement will be created for each entity type. They will have list of given case instance ids in IN clause. Therefore, DB limitation for number of values in IN clause must be taken into account.

Specified by:

deleteHistoricCaseInstancesBulk in interface HistoryService

Parameters:

caseInstanceIds - list of case instance ids for removal

deleteHistoricDecisionInstance

public void deleteHistoricDecisionInstance(String decisionDefinitionId)

Description copied from interface: HistoryService

Deletes historic decision instances of a decision definition. All historic decision inputs and outputs are deleted as well.

Specified by:

deleteHistoricDecisionInstance in interface HistoryService

Parameters:

decisionDefinitionId - the id of the decision definition

deleteHistoricDecisionInstancesBulk

public void deleteHistoricDecisionInstancesBulk(List<String> decisionInstanceIds)

Description copied from interface: HistoryService

Deletes decision instances and all related historic data in bulk manner. DELETE SQL statement will be created for each entity type. They will have list of given decision instance ids in IN clause. Therefore, DB limitation for number of values in IN clause must be taken into account.

Specified by:

deleteHistoricDecisionInstancesBulk in interface HistoryService

Parameters:

decisionInstanceIds - list of decision instance ids for removal.

deleteHistoricDecisionInstanceByDefinitionId

public void deleteHistoricDecisionInstanceByDefinitionId(String decisionDefinitionId)

Description copied from interface: HistoryService

Deletes historic decision instances of a decision definition. All historic decision inputs and outputs are deleted as well.

Specified by:

deleteHistoricDecisionInstanceByDefinitionId in interface HistoryService

Parameters:

decisionDefinitionId - the id of the decision definition

deleteHistoricDecisionInstanceByInstanceId

public void deleteHistoricDecisionInstanceByInstanceId(String historicDecisionInstanceId)

Description copied from interface: HistoryService

Deletes historic decision instances by its id. All historic decision inputs and outputs are deleted as well.

Specified by:

deleteHistoricDecisionInstanceByInstanceId in interface HistoryService

Parameters:

historicDecisionInstanceId - the id of the historic decision instance

createNativeHistoricProcessInstanceQuery

public NativeHistoricProcessInstanceQuery createNativeHistoricProcessInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricProcessInstances via SQL

Specified by:

createNativeHistoricProcessInstanceQuery in interface HistoryService

createNativeHistoricTaskInstanceQuery

public NativeHistoricTaskInstanceQuery createNativeHistoricTaskInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricTaskInstances via SQL

Specified by:

createNativeHistoricTaskInstanceQuery in interface HistoryService

createNativeHistoricActivityInstanceQuery

public NativeHistoricActivityInstanceQuery createNativeHistoricActivityInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricActivityInstances via SQL

Specified by:

createNativeHistoricActivityInstanceQuery in interface HistoryService

createNativeHistoricCaseInstanceQuery

public NativeHistoricCaseInstanceQuery createNativeHistoricCaseInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricCaseInstances via SQL

Specified by:

createNativeHistoricCaseInstanceQuery in interface HistoryService

createNativeHistoricCaseActivityInstanceQuery

public NativeHistoricCaseActivityInstanceQuery createNativeHistoricCaseActivityInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricCaseActivityInstances via SQL

Specified by:

createNativeHistoricCaseActivityInstanceQuery in interface HistoryService

createNativeHistoricDecisionInstanceQuery

public NativeHistoricDecisionInstanceQuery createNativeHistoricDecisionInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricDecisionInstances via SQL

Specified by:

createNativeHistoricDecisionInstanceQuery in interface HistoryService

createHistoricJobLogQuery

public HistoricJobLogQuery createHistoricJobLogQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for historic job logs.

Specified by:

createHistoricJobLogQuery in interface HistoryService

getHistoricJobLogExceptionStacktrace

public String getHistoricJobLogExceptionStacktrace(String historicJobLogId)

Description copied from interface: HistoryService

Returns the full stacktrace of the exception that occurs when the historic job log with the given id was last executed. Returns null when the historic job log has no exception stacktrace.

Specified by:

getHistoricJobLogExceptionStacktrace in interface HistoryService

Parameters:

historicJobLogId - id of the historic job log, cannot be null.

createHistoricProcessInstanceReport

public HistoricProcessInstanceReport createHistoricProcessInstanceReport()

Description copied from interface: HistoryService

Creates a new programmatic query to create a historic process instance report.

Specified by:

createHistoricProcessInstanceReport in interface HistoryService

createHistoricTaskInstanceReport

public HistoricTaskInstanceReport createHistoricTaskInstanceReport()

Description copied from interface: HistoryService

Creates a new programmatic query to create a historic task instance report.

Specified by:

createHistoricTaskInstanceReport in interface HistoryService

createHistoricBatchQuery

public HistoricBatchQuery createHistoricBatchQuery()

Description copied from interface: HistoryService

Creates a query to search for HistoricBatch instances.

Specified by:

createHistoricBatchQuery in interface HistoryService

deleteHistoricBatch

public void deleteHistoricBatch(String batchId)

Description copied from interface: HistoryService

Deletes a historic batch instance. All corresponding historic job logs are deleted as well;

Specified by:

deleteHistoricBatch in interface HistoryService

createHistoricDecisionInstanceStatisticsQuery

public HistoricDecisionInstanceStatisticsQuery createHistoricDecisionInstanceStatisticsQuery(String decisionRequirementsDefinitionId)

Description copied from interface: HistoryService

Query for the statistics of DRD evaluation.

Specified by:

createHistoricDecisionInstanceStatisticsQuery in interface HistoryService

Parameters:

decisionRequirementsDefinitionId - - id of decision requirement definition

createHistoricExternalTaskLogQuery

public HistoricExternalTaskLogQuery createHistoricExternalTaskLogQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for historic external task logs.

Specified by:

createHistoricExternalTaskLogQuery in interface HistoryService

getHistoricExternalTaskLogErrorDetails

public String getHistoricExternalTaskLogErrorDetails(String historicExternalTaskLogId)

Description copied from interface: HistoryService

Returns the full error details that occurs when the historic external task log with the given id was last executed. Returns null when the historic external task log contains no error details.

Specified by:

getHistoricExternalTaskLogErrorDetails in interface HistoryService

Parameters:

historicExternalTaskLogId - id of the historic external task log, cannot be null.