Package oracle.as.scheduler

Class JobHelper

java.lang.Object
oracle.as.scheduler.JobHelper
public class JobHelper extends Object

  • Constructor Details

    • JobHelper

      public JobHelper()

  • Method Details

    • isQuiesceState

      public boolean isQuiesceState()

    • getState

      public State getState(Long requestId) throws RequestNotFoundException, RuntimeServiceException
      Throws:
      RequestNotFoundException
      RuntimeServiceException

    • isExecutionInterrupted

      public boolean isExecutionInterrupted(RequestExecutionContext requestExecutionContext)
      Unified API to check if job execution should be interrupted for sync java jobs.

      This API checks for request cancel and server Quiesce: Cancel and quiesce checks are 'efficient' and 'in-memory' checks. Cancel check does not require job to implement Cancellable interface, so it can be used by jobs not implementing Cancellable interface as well.

      If either server is in Quiesce state or if the request cancel has been initiated, this API will return true. This allows the sync java job to cleanup and exit. The getExitCondition API below can be used to figure out which exit condition has occurred. The handleExecutionInterruption API below can be used by the job to raise appropriate SchedulerException.

      Parameters:
      requestExecutionContext - the execution context of the running request that is being checked.
      Returns:
      true if job execution needs to be interrupted for this request, false otherwise.

    • getExitCondition

      public JobHelper.ExitCondition getExitCondition(RequestExecutionContext requestExecutionContext)
      Unified API to determine if job execution has been interrupted and return the appropriate exit condition for sync java jobs.

      This API checks for request cancel and server Quiesce, similar to the isExecutionInterrupted API and returns appropriate exit condition. If request cancel has been initiated, it returns Cancel exit condition. Else if server is in Quiesce state, it returns Suspend exit condition.

      Parameters:
      requestExecutionContext - the execution context of the running request that is being checked.
      Returns:
      ExitCondition enum

    • handleExecutionInterruption

      public void handleExecutionInterruption(RequestExecutionContext requestExecutionContext) throws ExecutionCancelledException, ExecutionSuspendException
      Unified API to determine if job execution has been interrupted and raise appropriate scheduler exception for sync java jobs.

      This API checks for request cancel and server Quiesce, similar to the isExecutionInterrupted API. If request cancel has been initiated, it will throw ExecutionCancelledException. Else if server is in Quiesce state, it will throw ExecutionSuspendException.

      Parameters:
      requestExecutionContext - the execution context of the running request that is being checked.
      Throws:
      ExecutionCancelledException - if request is cancelled
      ExecutionSuspendException - if server in Quiesce state

    • releaseExitCondition

      public void releaseExitCondition(RequestExecutionContext requestExecutionContext)
      Unified API to release a locked exit condition for a request.

      Normally a job is expected to cleanup and exit as soon as an exit condition is detected. If there are cases, where a job may not exit despite an exit condition being found, then the releaseExitCondition can be called to release the locked exit condition, to ensure the exit conditions are examined afresh next time. It does not affect the exit conditions for the request.

      Parameters:
      requestExecutionContext - the execution context of the running request that is being checked.