Package org.flowable.engine.impl.history

Class DefaultHistoryManager

  • All Implemented Interfaces:
    HistoryManager
    public class DefaultHistoryManager
extends AbstractHistoryManager
    Manager class that centralises recording of all history-related operations that are originated from inside the engine.
    Author:
    Frederik Heremans, Joram Barrez

    • Field Detail

      • MAX_SUB_PROCESS_INSTANCES

        public static final int MAX_SUB_PROCESS_INSTANCES
        See Also:
        Constant Field Values

    • Method Detail

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

      • recordProcessInstanceNameChange

        public void recordProcessInstanceNameChange​(ExecutionEntity processInstanceExecution,
                                            String newName)
        Description copied from interface: HistoryManager
        Record a process-instance name change.

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

      • recordProcessInstanceDeleted

        public void recordProcessInstanceDeleted​(String processInstanceId,
                                         String processDefinitionId,
                                         String processTenantId)
        Description copied from interface: HistoryManager
        Deletes a historic process instance and all historic data included

      • recordDeleteHistoricProcessInstancesByProcessDefinitionId

        public void recordDeleteHistoricProcessInstancesByProcessDefinitionId​(String processDefinitionId)
        Description copied from interface: HistoryManager
        Deletes historic process instances for a provided process definition id

      • recordBulkDeleteProcessInstances

        public void recordBulkDeleteProcessInstances​(Collection<String> processInstanceIds)
        Description copied from interface: HistoryManager
        Bulk delete historic process instances by id

      • recordActivityStart

        public void recordActivityStart​(ActivityInstance activityInstance)
        Description copied from interface: HistoryManager
        Record the start of an activity, if activity history is enabled.
        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.
        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.

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

      • recordTaskCreated

        public void recordTaskCreated​(TaskEntity task,
                              ExecutionEntity execution)
        Description copied from interface: HistoryManager
        Record the creation of a task, if audit history is enabled.

      • recordTaskInfoChange

        public void recordTaskInfoChange​(TaskEntity taskEntity,
                                 String activityInstanceId,
                                 Date changeTime)
        Description copied from interface: HistoryManager
        Record task name change, if audit history is enabled.

      • recordHistoricTaskDeleted

        public void recordHistoricTaskDeleted​(org.flowable.task.api.history.HistoricTaskInstance task)
        Description copied from interface: HistoryManager
        Record historic task deleted, if audit history is enabled.

      • recordVariableCreate

        public void recordVariableCreate​(VariableInstanceEntity variable,
                                 Date createTime)
        Description copied from interface: HistoryManager
        Record a variable has been created, if audit history is enabled.

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

      • recordVariableUpdate

        public void recordVariableUpdate​(VariableInstanceEntity variableInstanceEntity,
                                 Date updateTime)
        Description copied from interface: HistoryManager
        Record a variable has been updated, if audit history is enabled.

      • recordVariableRemoved

        public void recordVariableRemoved​(VariableInstanceEntity variableInstanceEntity)
        Description copied from interface: HistoryManager
        Record a variable has been deleted, if audit history is enabled.

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

      • recordIdentityLinkCreated

        public void recordIdentityLinkCreated​(IdentityLinkEntity identityLink)
        Description copied from interface: HistoryManager
        Record the creation of a new IdentityLink, if audit history is enabled.

      • recordIdentityLinkDeleted

        public void recordIdentityLinkDeleted​(IdentityLinkEntity identityLink)
        Description copied from interface: HistoryManager
        Record the deletion of a IdentityLink, if audit history is enabled

      • recordEntityLinkCreated

        public void recordEntityLinkCreated​(EntityLinkEntity entityLink)
        Description copied from interface: HistoryManager
        Record the creation of a new EntityLink, if audit history is enabled.

      • recordEntityLinkDeleted

        public void recordEntityLinkDeleted​(EntityLinkEntity entityLink)
        Description copied from interface: HistoryManager
        Record the deletion of a EntityLink, if audit history is enabled

      • updateProcessBusinessKeyInHistory

        public void updateProcessBusinessKeyInHistory​(ExecutionEntity processInstance)

      • updateProcessBusinessStatusInHistory

        public void updateProcessBusinessStatusInHistory​(ExecutionEntity processInstance)

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

      • updateHistoricActivityInstance

        public void updateHistoricActivityInstance​(ActivityInstance activityInstance)
        Description copied from interface: HistoryManager
        Update historic activity instance according to changes done in the runtime activity

      • recordHistoricUserTaskLogEntry

        public void recordHistoricUserTaskLogEntry​(org.flowable.task.api.history.HistoricTaskLogEntryBuilder taskLogEntryBuilder)
        Description copied from interface: HistoryManager
        Record historic user task log entry
        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
        Parameters:
        logNumber - log identifier

      • createHistoricActivityInstance

        public void createHistoricActivityInstance​(ActivityInstance activityInstance)
        Description copied from interface: HistoryManager
        Create new historic activity instance from runtime activity instance
        Parameters:
        activityInstance - activity instance template