Package fr.gouv.vitam.processing.management.core

Class StateMachine

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void cancel()
      Cancel as soon as possible the processWorkflow, To do that, the step pauseCancelAction is updated to be PauseOrCancelAction.ACTION_CANCEL Unlike pause, - The finally step should be executed, - PauseOrCancelAction.ACTION_CANCEL have no impact on the finally step - The finally step cannot be cancelled
      protected void doCompleted()
      Change the state of the process to completed Can be called only from running or pause state If running state, the next step will be completed
      protected void doPause​(PauseRecover pauseRecover)
      Change state of the process to pause Can be called only from running state If last step then change state to completed
      protected void doReplay​(WorkerParameters workerParameters, ProcessState targetState)
      Change state of the process to running Can be called only from pause state
      protected void doRunning​(WorkerParameters workerParameters, ProcessState targetState)
      Change state of the process to running Can be called only from pause state
      protected void executeFinallyStep​(WorkerParameters workerParameters)
      Execute the finally step of the workflow Update global status of the workflow Persist the process workflow
      protected void executeSteps​(WorkerParameters workerParameters, PauseRecover pauseRecover, boolean backwards)
      Execute steps of the workflow and manage index of the current step Call engine to execute the current step
      protected void finalizeLogbook​(WorkerParameters workParams)
      Create the final logbook entry for the corresponding process workflow This entry was created in ingest internal and as the process is full async we moved it to here
      java.lang.String getContextId()  
      LogbookTypeProcess getLogbookTypeProcess()  
      int getTenant()  
      java.lang.String getWorkflowId()  
      boolean isCompleted()
      Check if the state is completed
      boolean isDone()  
      protected boolean isLastStep()
      Check if the current step is the last one
      protected boolean isPause()
      Check if the state is pause
      boolean isRecover()  
      protected boolean isRunning()
      Check if the state is running
      boolean isStepByStep()  
      void next​(WorkerParameters workerParameters)
      Like a resume but pause at the next step
      void onComplete​(ItemStatus itemStatus, WorkerParameters workerParameters)
      The ProcessEngine callback on complete step (for any status code)
      void onError​(java.lang.Throwable throwable)
      The ProcessEngine callback on system error occurred
      void onPauseOrCancel​(PauseOrCancelAction pauseCancelAction, WorkerParameters workerParameters)
      The ProcessEngine callback onPauseOrCancel when the step is paused or cancelled
      void onUpdate​(StatusCode statusCode)
      Update the current step status code
      void onUpdate​(java.lang.String messageIdentifier, java.lang.String originatingAgency)  
      void pause()
      Pause the processWorkflow, If the last step the just wait the finally step Else pause the processWorkflow as soon as possible Do not wait all elements of the current step to be executed The step pauseCancelAction will be updated to PauseOrCancelAction.ACTION_PAUSE If all elements of the current step are executed then stop correctly and step pauseCancelAction will be updated to PauseOrCancelAction.ACTION_COMPLETE After next or resume occurs on paused processWorkflow, It will starts from the step pauseCancelAction equals to PauseOrCancelAction.ACTION_PAUSE if exists and update pauseCancelAction to be PauseOrCancelAction.ACTION_RECOVER Else starts normally from the next step
      protected boolean persistProcessWorkflow()
      Persist the process workflow in the workspace
      void replay​(WorkerParameters workerParameters)
      Replay the last executed step, or if it s stated, the step passed as a parameter
      void resume​(WorkerParameters workerParameters)
      Do an evaluation of the State RUNNING If the state is not permitted a StateNotAllowedException is thrown Else call doRunning method
      void shutdown()
      Should used only when server is shutting down To prevent deadlock, this method is not synchronized, Because onComplete and onPauseOrCancel are synchronized and called from ProcessEngine

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • pause

        public void pause()
           throws StateNotAllowedException
        Description copied from interface: IEventsState
        Pause the processWorkflow, If the last step the just wait the finally step Else pause the processWorkflow as soon as possible Do not wait all elements of the current step to be executed The step pauseCancelAction will be updated to PauseOrCancelAction.ACTION_PAUSE If all elements of the current step are executed then stop correctly and step pauseCancelAction will be updated to PauseOrCancelAction.ACTION_COMPLETE After next or resume occurs on paused processWorkflow, It will starts from the step pauseCancelAction equals to PauseOrCancelAction.ACTION_PAUSE if exists and update pauseCancelAction to be PauseOrCancelAction.ACTION_RECOVER Else starts normally from the next step
        Specified by:
        pause in interface IEventsState
        Throws:
        StateNotAllowedException

      • shutdown

        public void shutdown()
        Description copied from interface: IEventsState
        Should used only when server is shutting down To prevent deadlock, this method is not synchronized, Because onComplete and onPauseOrCancel are synchronized and called from ProcessEngine
        Specified by:
        shutdown in interface IEventsState

      • cancel

        public void cancel()
            throws StateNotAllowedException
        Description copied from interface: IEventsState
        Cancel as soon as possible the processWorkflow, To do that, the step pauseCancelAction is updated to be PauseOrCancelAction.ACTION_CANCEL Unlike pause, - The finally step should be executed, - PauseOrCancelAction.ACTION_CANCEL have no impact on the finally step - The finally step cannot be cancelled
        Specified by:
        cancel in interface IEventsState
        Throws:
        StateNotAllowedException

      • isDone

        public boolean isDone()
        Specified by:
        isDone in interface IEventsState
        Returns:
        true is processWorkflow is completed or Pause

      • getTenant

        public int getTenant()
        Specified by:
        getTenant in interface IEventsState
        Returns:
        The tenantId of the processWorkflow

      • getWorkflowId

        public java.lang.String getWorkflowId()
        Specified by:
        getWorkflowId in interface IEventsState
        Returns:
        The workflow Id

      • isStepByStep

        public boolean isStepByStep()
        Specified by:
        isStepByStep in interface IEventsState
        Returns:
        true if processWorkflow is running in stepByStep (next) mode or in continue mode (resume)

      • doPause

        protected void doPause​(PauseRecover pauseRecover)
        Change state of the process to pause Can be called only from running state If last step then change state to completed
        Parameters:
        pauseRecover - if RECOVER_FROM_SERVER_PAUSE then wait until pause is done

      • doCompleted

        protected void doCompleted()
        Change the state of the process to completed Can be called only from running or pause state If running state, the next step will be completed

      • executeFinallyStep

        protected void executeFinallyStep​(WorkerParameters workerParameters)
        Execute the finally step of the workflow Update global status of the workflow Persist the process workflow
        Parameters:
        workerParameters -

      • onUpdate

        public void onUpdate​(java.lang.String messageIdentifier,
                     java.lang.String originatingAgency)
        Specified by:
        onUpdate in interface IEventsProcessEngine

      • isRunning

        protected boolean isRunning()
        Check if the state is running
        Returns:
        true if the current state is running

      • isPause

        protected boolean isPause()
        Check if the state is pause
        Returns:
        true if the current state is pause

      • isCompleted

        public boolean isCompleted()
        Check if the state is completed
        Returns:
        true if the current state is completed

      • isRecover

        public boolean isRecover()
        Specified by:
        isRecover in interface IEventsState
        Returns:
        true is processWorkflow is Pause

      • isLastStep

        protected boolean isLastStep()
        Check if the current step is the last one
        Returns:
        true if the current step is the last one

      • persistProcessWorkflow

        protected boolean persistProcessWorkflow()
        Persist the process workflow in the workspace
        Returns:
        true is success, false else

      • finalizeLogbook

        protected void finalizeLogbook​(WorkerParameters workParams)
        Create the final logbook entry for the corresponding process workflow This entry was created in ingest internal and as the process is full async we moved it to here