|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.camunda.bpm.engine.impl.ServiceImpl
org.camunda.bpm.engine.impl.HistoryServiceImpl
public class HistoryServiceImpl
Field Summary |
---|
Fields inherited from class org.camunda.bpm.engine.impl.ServiceImpl |
---|
commandExecutor |
Constructor Summary | |
---|---|
HistoryServiceImpl()
|
Method Summary | |
---|---|
Job |
cleanUpHistoryAsync()
Schedules history cleanup job at batch window start time. |
Job |
cleanUpHistoryAsync(boolean immediatelyDue)
Schedules history cleanup job at batch window start time. |
CleanableHistoricBatchReport |
createCleanableHistoricBatchReport()
Creates a new programmatic query to create a cleanable historic batch report. |
CleanableHistoricCaseInstanceReport |
createCleanableHistoricCaseInstanceReport()
Creates a new programmatic query to create a cleanable historic case instance report. |
CleanableHistoricDecisionInstanceReport |
createCleanableHistoricDecisionInstanceReport()
Creates a new programmatic query to create a cleanable historic decision instance report. |
CleanableHistoricProcessInstanceReport |
createCleanableHistoricProcessInstanceReport()
Creates a new programmatic query to create a cleanable historic process instance report. |
HistoricActivityInstanceQuery |
createHistoricActivityInstanceQuery()
Creates a new programmatic query to search for HistoricActivityInstance s. |
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 HistoricCaseActivityInstance s. |
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 HistoricCaseInstance s. |
HistoricDecisionInstanceQuery |
createHistoricDecisionInstanceQuery()
Creates a new programmatic query to search for HistoricDecisionInstance s. |
HistoricDecisionInstanceStatisticsQuery |
createHistoricDecisionInstanceStatisticsQuery(String decisionRequirementsDefinitionId)
Query for the statistics of DRD evaluation. |
HistoricDetailQuery |
createHistoricDetailQuery()
Creates a new programmatic query to search for HistoricDetail s. |
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 HistoricProcessInstance s. |
HistoricProcessInstanceReport |
createHistoricProcessInstanceReport()
Creates a new programmatic query to create a historic process instance report. |
HistoricTaskInstanceQuery |
createHistoricTaskInstanceQuery()
Creates a new programmatic query to search for HistoricTaskInstance s. |
HistoricTaskInstanceReport |
createHistoricTaskInstanceReport()
Creates a new programmatic query to create a historic task instance report. |
HistoricVariableInstanceQuery |
createHistoricVariableInstanceQuery()
Creates a new programmatic query to search for HistoricVariableInstance s. |
NativeHistoricActivityInstanceQuery |
createNativeHistoricActivityInstanceQuery()
creates a native query to search for HistoricActivityInstance s via SQL |
NativeHistoricCaseActivityInstanceQuery |
createNativeHistoricCaseActivityInstanceQuery()
creates a native query to search for HistoricCaseActivityInstance s via SQL |
NativeHistoricCaseInstanceQuery |
createNativeHistoricCaseInstanceQuery()
creates a native query to search for HistoricCaseInstance s via SQL |
NativeHistoricDecisionInstanceQuery |
createNativeHistoricDecisionInstanceQuery()
creates a native query to search for HistoricDecisionInstance s via SQL |
NativeHistoricProcessInstanceQuery |
createNativeHistoricProcessInstanceQuery()
creates a native query to search for HistoricProcessInstance s via SQL |
NativeHistoricTaskInstanceQuery |
createNativeHistoricTaskInstanceQuery()
creates a native query to search for HistoricTaskInstance s via SQL |
NativeHistoricVariableInstanceQuery |
createNativeHistoricVariableInstanceQuery()
creates a native query to search for HistoricVariableInstance s 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 |
---|
public HistoryServiceImpl()
Method Detail |
---|
public HistoricProcessInstanceQuery createHistoricProcessInstanceQuery()
HistoryService
HistoricProcessInstance
s.
createHistoricProcessInstanceQuery
in interface HistoryService
public HistoricActivityInstanceQuery createHistoricActivityInstanceQuery()
HistoryService
HistoricActivityInstance
s.
createHistoricActivityInstanceQuery
in interface HistoryService
public HistoricActivityStatisticsQuery createHistoricActivityStatisticsQuery(String processDefinitionId)
HistoryService
createHistoricActivityStatisticsQuery
in interface HistoryService
public HistoricCaseActivityStatisticsQuery createHistoricCaseActivityStatisticsQuery(String caseDefinitionId)
HistoryService
createHistoricCaseActivityStatisticsQuery
in interface HistoryService
public HistoricTaskInstanceQuery createHistoricTaskInstanceQuery()
HistoryService
HistoricTaskInstance
s.
createHistoricTaskInstanceQuery
in interface HistoryService
public HistoricDetailQuery createHistoricDetailQuery()
HistoryService
HistoricDetail
s.
createHistoricDetailQuery
in interface HistoryService
public UserOperationLogQuery createUserOperationLogQuery()
HistoryService
UserOperationLogEntry
instances.
createUserOperationLogQuery
in interface HistoryService
public HistoricVariableInstanceQuery createHistoricVariableInstanceQuery()
HistoryService
HistoricVariableInstance
s.
createHistoricVariableInstanceQuery
in interface HistoryService
public HistoricIncidentQuery createHistoricIncidentQuery()
HistoryService
historic incidents
.
createHistoricIncidentQuery
in interface HistoryService
public HistoricIdentityLinkLogQueryImpl createHistoricIdentityLinkLogQuery()
HistoryService
historic identity links
.
createHistoricIdentityLinkLogQuery
in interface HistoryService
public HistoricCaseInstanceQuery createHistoricCaseInstanceQuery()
HistoryService
HistoricCaseInstance
s.
createHistoricCaseInstanceQuery
in interface HistoryService
public HistoricCaseActivityInstanceQuery createHistoricCaseActivityInstanceQuery()
HistoryService
HistoricCaseActivityInstance
s.
createHistoricCaseActivityInstanceQuery
in interface HistoryService
public HistoricDecisionInstanceQuery createHistoricDecisionInstanceQuery()
HistoryService
HistoricDecisionInstance
s.
If the user has no Permissions.READ_HISTORY
permission on Resources.DECISION_DEFINITION
then the result of the query is empty.
createHistoricDecisionInstanceQuery
in interface HistoryService
public void deleteHistoricTaskInstance(String taskId)
HistoryService
dynamically created
and then completed
.
If the historic task instance doesn't exist, no exception is thrown and the
method returns normal.
deleteHistoricTaskInstance
in interface HistoryService
public void deleteHistoricProcessInstance(String processInstanceId)
HistoryService
deleteHistoricProcessInstance
in interface HistoryService
public void deleteHistoricProcessInstances(List<String> processInstanceIds)
HistoryService
deleteHistoricProcessInstances
in interface HistoryService
public void deleteHistoricProcessInstancesBulk(List<String> processInstanceIds)
HistoryService
deleteHistoricProcessInstancesBulk
in interface HistoryService
processInstanceIds
- list of process instance ids for removalpublic Job cleanUpHistoryAsync()
HistoryService
ResourceDefinition.getHistoryTimeToLive()
,
DecisionDefinition#getHistoryTimeToLive()
, CaseDefinition#getHistoryTimeToLive()
, ProcessEngineConfigurationImpl#getBatchOperationHistoryTimeToLive()
and ProcessEngineConfigurationImpl#getBatchOperationsForHistoryCleanup()
values.
cleanUpHistoryAsync
in interface HistoryService
public Job cleanUpHistoryAsync(boolean immediatelyDue)
HistoryService
ResourceDefinition.getHistoryTimeToLive()
,
DecisionDefinition#getHistoryTimeToLive()
, CaseDefinition#getHistoryTimeToLive()
, ProcessEngineConfigurationImpl#getBatchOperationHistoryTimeToLive()
and ProcessEngineConfigurationImpl#getBatchOperationsForHistoryCleanup()
values.
cleanUpHistoryAsync
in interface HistoryService
immediatelyDue
- must be true if cleanup must be scheduled at once, otherwise is will be scheduled according to configured batch window
public Job findHistoryCleanupJob()
HistoryService
findHistoryCleanupJob
in interface HistoryService
public Batch deleteHistoricProcessInstancesAsync(List<String> processInstanceIds, String deleteReason)
HistoryService
deleteHistoricProcessInstancesAsync
in interface HistoryService
public Batch deleteHistoricProcessInstancesAsync(HistoricProcessInstanceQuery query, String deleteReason)
HistoryService
deleteHistoricProcessInstancesAsync
in interface HistoryService
public Batch deleteHistoricProcessInstancesAsync(List<String> processInstanceIds, HistoricProcessInstanceQuery query, String deleteReason)
HistoryService
deleteHistoricProcessInstancesAsync
in interface HistoryService
public void deleteUserOperationLogEntry(String entryId)
HistoryService
deleteUserOperationLogEntry
in interface HistoryService
public void deleteHistoricCaseInstance(String caseInstanceId)
HistoryService
deleteHistoricCaseInstance
in interface HistoryService
public void deleteHistoricCaseInstancesBulk(List<String> caseInstanceIds)
HistoryService
deleteHistoricCaseInstancesBulk
in interface HistoryService
caseInstanceIds
- list of case instance ids for removalpublic void deleteHistoricDecisionInstance(String decisionDefinitionId)
HistoryService
deleteHistoricDecisionInstance
in interface HistoryService
decisionDefinitionId
- the id of the decision definitionpublic void deleteHistoricDecisionInstancesBulk(List<String> decisionInstanceIds)
HistoryService
deleteHistoricDecisionInstancesBulk
in interface HistoryService
decisionInstanceIds
- list of decision instance ids for removal.public void deleteHistoricDecisionInstanceByDefinitionId(String decisionDefinitionId)
HistoryService
deleteHistoricDecisionInstanceByDefinitionId
in interface HistoryService
decisionDefinitionId
- the id of the decision definitionpublic void deleteHistoricDecisionInstanceByInstanceId(String historicDecisionInstanceId)
HistoryService
deleteHistoricDecisionInstanceByInstanceId
in interface HistoryService
historicDecisionInstanceId
- the id of the historic decision instancepublic NativeHistoricProcessInstanceQuery createNativeHistoricProcessInstanceQuery()
HistoryService
HistoricProcessInstance
s via SQL
createNativeHistoricProcessInstanceQuery
in interface HistoryService
public NativeHistoricTaskInstanceQuery createNativeHistoricTaskInstanceQuery()
HistoryService
HistoricTaskInstance
s via SQL
createNativeHistoricTaskInstanceQuery
in interface HistoryService
public NativeHistoricActivityInstanceQuery createNativeHistoricActivityInstanceQuery()
HistoryService
HistoricActivityInstance
s via SQL
createNativeHistoricActivityInstanceQuery
in interface HistoryService
public NativeHistoricCaseInstanceQuery createNativeHistoricCaseInstanceQuery()
HistoryService
HistoricCaseInstance
s via SQL
createNativeHistoricCaseInstanceQuery
in interface HistoryService
public NativeHistoricCaseActivityInstanceQuery createNativeHistoricCaseActivityInstanceQuery()
HistoryService
HistoricCaseActivityInstance
s via SQL
createNativeHistoricCaseActivityInstanceQuery
in interface HistoryService
public NativeHistoricDecisionInstanceQuery createNativeHistoricDecisionInstanceQuery()
HistoryService
HistoricDecisionInstance
s via SQL
createNativeHistoricDecisionInstanceQuery
in interface HistoryService
public NativeHistoricVariableInstanceQuery createNativeHistoricVariableInstanceQuery()
HistoryService
HistoricVariableInstance
s via SQL
createNativeHistoricVariableInstanceQuery
in interface HistoryService
public HistoricJobLogQuery createHistoricJobLogQuery()
HistoryService
historic job logs
.
createHistoricJobLogQuery
in interface HistoryService
public String getHistoricJobLogExceptionStacktrace(String historicJobLogId)
HistoryService
getHistoricJobLogExceptionStacktrace
in interface HistoryService
historicJobLogId
- id of the historic job log, cannot be null.public HistoricProcessInstanceReport createHistoricProcessInstanceReport()
HistoryService
createHistoricProcessInstanceReport
in interface HistoryService
public HistoricTaskInstanceReport createHistoricTaskInstanceReport()
HistoryService
createHistoricTaskInstanceReport
in interface HistoryService
public CleanableHistoricProcessInstanceReport createCleanableHistoricProcessInstanceReport()
HistoryService
createCleanableHistoricProcessInstanceReport
in interface HistoryService
public CleanableHistoricDecisionInstanceReport createCleanableHistoricDecisionInstanceReport()
HistoryService
createCleanableHistoricDecisionInstanceReport
in interface HistoryService
public CleanableHistoricCaseInstanceReport createCleanableHistoricCaseInstanceReport()
HistoryService
createCleanableHistoricCaseInstanceReport
in interface HistoryService
public CleanableHistoricBatchReport createCleanableHistoricBatchReport()
HistoryService
createCleanableHistoricBatchReport
in interface HistoryService
public HistoricBatchQuery createHistoricBatchQuery()
HistoryService
HistoricBatch
instances.
createHistoricBatchQuery
in interface HistoryService
public void deleteHistoricBatch(String batchId)
HistoryService
deleteHistoricBatch
in interface HistoryService
public HistoricDecisionInstanceStatisticsQuery createHistoricDecisionInstanceStatisticsQuery(String decisionRequirementsDefinitionId)
HistoryService
createHistoricDecisionInstanceStatisticsQuery
in interface HistoryService
decisionRequirementsDefinitionId
- - id of decision requirement definitionpublic HistoricExternalTaskLogQuery createHistoricExternalTaskLogQuery()
HistoryService
historic external task logs
.
createHistoricExternalTaskLogQuery
in interface HistoryService
public String getHistoricExternalTaskLogErrorDetails(String historicExternalTaskLogId)
HistoryService
getHistoricExternalTaskLogErrorDetails
in interface HistoryService
historicExternalTaskLogId
- id of the historic external task log, cannot be null.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |