Package com.flowable.agent.api.management

Interface AgentManagementService

public interface AgentManagementService

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    bulkMoveDeadLetterJobs(Collection<String> jobIds, int retries)
    Moves a bulk of jobs that are in the dead letter job table back to the executable job table, and resets the retries (as the retries was 0 when it was put into the dead letter job table).
    org.flowable.job.api.DeadLetterJobQuery
    createDeadLetterJobQuery()
    Returns a new DeadLetterJobQuery implementation, that can be used to query the dead letter jobs.
    org.flowable.job.api.JobQuery
    createJobQuery()
    Returns a new JobQuery implementation, that can be used to query the jobs.
    org.flowable.job.api.TimerJobQuery
    createTimerJobQuery()
    Returns a new TimerJobQuery implementation, that can be used to query the timer jobs.
    void
    deleteDeadLetterJob(String jobId)
    Delete the dead letter job with the provided id.
    void
    deleteJob(String jobId)
    Delete the job with the provided id.
    void
    deleteTimerJob(String jobId)
    Delete the timer job with the provided id.
    void
    executeJob(String jobId)
    Forced synchronous execution of a job (eg. for administration or testing).
    String
    getDeadLetterJobExceptionStacktrace(String jobId)
    Returns the full stacktrace of the exception that occurs when the deadletter job with the given id was last executed.
    String
    getJobExceptionStacktrace(String jobId)
    Returns the full stacktrace of the exception that occurs when the job with the given id was last executed.
    String
    getTimerJobExceptionStacktrace(String jobId)
    Returns the full stacktrace of the exception that occurs when the timer job with the given id was last executed.
    org.flowable.job.api.Job
    moveDeadLetterJobToExecutableJob(String jobId, int retries)
    Moves a job that is in the dead letter job table back to be an executable job, and resetting the retries (as the retries were probably 0 when it was put into the dead letter job table).
    org.flowable.job.api.Job
    moveJobToDeadLetterJob(String jobId)
    Moves a job to the dead letter job table (eg. for administration or testing).
    org.flowable.job.api.Job
    moveTimerToExecutableJob(String jobId)
    Moves a timer job to the executable job table (eg. for administration or testing).
    org.flowable.job.api.Job
    rescheduleTimeDateJob(String jobId, Date timeDate)
    Reschedule a timer job with a new date value.
    org.flowable.job.api.Job
    rescheduleTimeDateValueJob(String jobId, String timeDateValue)
    Reschedule a timer job with a time date value.
    void
    setJobRetries(String jobId, int retries)
    Sets the number of retries that a job has left.
    void
    setTimerJobRetries(String jobId, int retries)
    Sets the number of retries that a timer job has left.

  • Method Details

    • createJobQuery

      org.flowable.job.api.JobQuery createJobQuery()
      Returns a new JobQuery implementation, that can be used to query the jobs.

    • createTimerJobQuery

      org.flowable.job.api.TimerJobQuery createTimerJobQuery()
      Returns a new TimerJobQuery implementation, that can be used to query the timer jobs.

    • createDeadLetterJobQuery

      org.flowable.job.api.DeadLetterJobQuery createDeadLetterJobQuery()
      Returns a new DeadLetterJobQuery implementation, that can be used to query the dead letter jobs.

    • executeJob

      void executeJob(String jobId)
      Forced synchronous execution of a job (eg. for administration or testing). The job will be executed, even if the case instance is suspended.
      Parameters:
      jobId - id of the job to execute, cannot be null.
      Throws:
      org.flowable.common.engine.api.FlowableObjectNotFoundException - when there is no job with the given id.

    • moveTimerToExecutableJob

      org.flowable.job.api.Job moveTimerToExecutableJob(String jobId)
      Moves a timer job to the executable job table (eg. for administration or testing). The timer job will be moved, even if the case instance is suspended.
      Parameters:
      jobId - id of the timer job to move, cannot be null.
      Throws:
      org.flowable.common.engine.api.FlowableObjectNotFoundException - when there is no job with the given id.

    • moveJobToDeadLetterJob

      org.flowable.job.api.Job moveJobToDeadLetterJob(String jobId)
      Moves a job to the dead letter job table (eg. for administration or testing). The job will be moved, even if the case instance is suspended or there are retries left.
      Parameters:
      jobId - id of the job to move, cannot be null.
      Throws:
      org.flowable.common.engine.api.FlowableObjectNotFoundException - when there is no job with the given id.

    • bulkMoveDeadLetterJobs

      void bulkMoveDeadLetterJobs(Collection<String> jobIds, int retries)
      Moves a bulk of jobs that are in the dead letter job table back to the executable job table, and resets the retries (as the retries was 0 when it was put into the dead letter job table).
      Parameters:
      jobIds - ids of the jobs to move, cannot be null.
      retries - the number of retries (value greater than 0) which will be set on the jobs.
      Throws:
      org.flowable.common.engine.api.FlowableObjectNotFoundException - when there is no job with any of the given ids.

    • moveDeadLetterJobToExecutableJob

      org.flowable.job.api.Job moveDeadLetterJobToExecutableJob(String jobId, int retries)
      Moves a job that is in the dead letter job table back to be an executable job, and resetting the retries (as the retries were probably 0 when it was put into the dead letter job table).
      Parameters:
      jobId - id of the job to move, cannot be null.
      retries - the number of retries (value greater than 0) which will be set on the job.
      Throws:
      org.flowable.common.engine.api.FlowableObjectNotFoundException - when there is no job with the given id.

    • deleteJob

      void deleteJob(String jobId)
      Delete the job with the provided id.
      Parameters:
      jobId - id of the job to delete, cannot be null.
      Throws:
      org.flowable.common.engine.api.FlowableObjectNotFoundException - when there is no job with the given id.

    • deleteTimerJob

      void deleteTimerJob(String jobId)
      Delete the timer job with the provided id.
      Parameters:
      jobId - id of the timer job to delete, cannot be null.
      Throws:
      org.flowable.common.engine.api.FlowableObjectNotFoundException - when there is no job with the given id.

    • deleteDeadLetterJob

      void deleteDeadLetterJob(String jobId)
      Delete the dead letter job with the provided id.
      Parameters:
      jobId - id of the dead letter job to delete, cannot be null.
      Throws:
      org.flowable.common.engine.api.FlowableObjectNotFoundException - when there is no job with the given id.

    • setJobRetries

      void setJobRetries(String jobId, int retries)
      Sets the number of retries that a job has left. Whenever the JobExecutor fails to execute a job, this value is decremented. When it hits zero, the job is supposed to be dead and not retried again. In that case, this method can be used to increase the number of retries.
      Parameters:
      jobId - id of the job to modify, cannot be null.
      retries - number of retries.

    • setTimerJobRetries

      void setTimerJobRetries(String jobId, int retries)
      Sets the number of retries that a timer job has left. Whenever the JobExecutor fails to execute a timer job, this value is decremented. When it hits zero, the job is supposed to be dead and not retried again. In that case, this method can be used to increase the number of retries.
      Parameters:
      jobId - id of the timer job to modify, cannot be null.
      retries - number of retries.

    • rescheduleTimeDateJob

      org.flowable.job.api.Job rescheduleTimeDateJob(String jobId, Date timeDate)
      Reschedule a timer job with a new date value.
      Parameters:
      jobId - id of the timer job to reschedule, cannot be null.
      timeDate - A fixed date

    • rescheduleTimeDateValueJob

      org.flowable.job.api.Job rescheduleTimeDateValueJob(String jobId, String timeDateValue)
      Reschedule a timer job with a time date value.
      Parameters:
      jobId - id of the timer job to reschedule, cannot be null.
      timeDateValue - A fixed date in ISO 8601 format, when job will be fired

    • getJobExceptionStacktrace

      String getJobExceptionStacktrace(String jobId)
      Returns the full stacktrace of the exception that occurs when the job with the given id was last executed. Returns null when the job has no exception stacktrace.
      Parameters:
      jobId - id of the job, cannot be null.
      Throws:
      org.flowable.common.engine.api.FlowableObjectNotFoundException - when no job exists with the given id.

    • getTimerJobExceptionStacktrace

      String getTimerJobExceptionStacktrace(String jobId)
      Returns the full stacktrace of the exception that occurs when the timer job with the given id was last executed. Returns null when the job has no exception stacktrace.
      Parameters:
      jobId - id of the job, cannot be null.
      Throws:
      org.flowable.common.engine.api.FlowableObjectNotFoundException - when no job exists with the given id.

    • getDeadLetterJobExceptionStacktrace

      String getDeadLetterJobExceptionStacktrace(String jobId)
      Returns the full stacktrace of the exception that occurs when the deadletter job with the given id was last executed. Returns null when the job has no exception stacktrace.
      Parameters:
      jobId - id of the job, cannot be null.
      Throws:
      org.flowable.common.engine.api.FlowableObjectNotFoundException - when no job exists with the given id.