JobManager (Flowable - Job Service 6.4.0 API)

All Known Implementing Classes:

AbstractMessageBasedJobManager, DefaultJobManager
```
public interface JobManager
```
Contains methods that are not tied to any specific job type (async, timer, suspended or deadletter), but which are generally applicable or are about going from one type to another.

Author:

Tijs Rademakers, Joram Barrez

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AbstractRuntimeJobEntity`	`activateSuspendedJob(SuspendedJobEntity job)` Transforms a `SuspendedJobEntity` back to an `AbstractRuntimeJobEntity` (i.e.
`AbstractRuntimeJobEntity`	`copyJobInfo(AbstractRuntimeJobEntity copyToJob, AbstractRuntimeJobEntity copyFromJob)` Copy job info from one job to the other
`void`	`createAsyncJob(JobEntity jobEntity, boolean exclusive)` Creates an async job so that it can be continued later in a background thread.
`DeadLetterJobEntity`	`createDeadLetterJobFromOtherJob(AbstractRuntimeJobEntity otherJob)` Create a dead letter job from another job
`JobEntity`	`createExecutableJobFromOtherJob(AbstractRuntimeJobEntity job)` Create an executable job from another job
`SuspendedJobEntity`	`createSuspendedJobFromOtherJob(AbstractRuntimeJobEntity otherJob)` Create a suspended job from another job
`TimerJobEntity`	`createTimerJobFromOtherJob(AbstractRuntimeJobEntity otherJob)` Create a timer job from another job
`void`	`execute(JobInfo job)` Execute a job, which means that the logic (async logic, timer that fires, etc) is executed, typically by a background thread of an executor.
`String`	`getBusinessCalendarName(JobEntity timerEntity, org.flowable.variable.api.delegate.VariableScope variableScope)` Get the business calendar name of the job configuration
`JobEntity`	`moveDeadLetterJobToExecutableJob(DeadLetterJobEntity deadLetterJobEntity, int retries)` Transforms a `DeadLetterJobEntity` to a `JobEntity`, thus making it executable again.
`DeadLetterJobEntity`	`moveJobToDeadLetterJob(AbstractRuntimeJobEntity job)` Transforms an `AbstractRuntimeJobEntity` to a `DeadLetterJobEntity`.
`SuspendedJobEntity`	`moveJobToSuspendedJob(AbstractRuntimeJobEntity job)` Moves an `AbstractRuntimeJobEntity` to become a `SuspendedJobEntity`, such that the `AsyncExecutor` won't pick it up anymore for execution.
`TimerJobEntity`	`moveJobToTimerJob(AbstractRuntimeJobEntity job)` Moves an `AbstractRuntimeJobEntity` to become a `TimerJobEntity`.
`JobEntity`	`moveTimerJobToExecutableJob(TimerJobEntity timerJob)` Moves a `TimerJobEntity` to become an async `JobEntity`.
`void`	`scheduleAsyncJob(JobEntity job)` Schedules and async job.
`HistoryJobEntity`	`scheduleHistoryJob(HistoryJobEntity historyJobEntity)` schedules a `HistoryJobEntity`, meaning it will be scheduled (inserted in the database/put on a queue/...) to be executed at a later point in time.
`void`	`scheduleTimerJob(TimerJobEntity timerJob)` Schedules a timer, meaning it will be inserted in the datastore.
`void`	`setJobServiceConfiguration(JobServiceConfiguration jobServiceConfiguration)` The ProcessEngineConfiguration instance will be passed when the ProcessEngine is built.
`void`	`unacquire(JobInfo job)` Unacquires a job, meaning that this job was previously locked, and it is now freed to be acquired by other executor nodes.
`void`	`unacquireWithDecrementRetries(JobInfo job)` Unacquires a job, meaning that this job was previously locked, and it is now freed to be acquired by other executor nodes.

- Method Detail
  - execute
```
void execute(JobInfo job)
```
    Execute a job, which means that the logic (async logic, timer that fires, etc) is executed, typically by a background thread of an executor.
  - unacquire
```
void unacquire(JobInfo job)
```
    Unacquires a job, meaning that this job was previously locked, and it is now freed to be acquired by other executor nodes.
  - unacquireWithDecrementRetries
```
void unacquireWithDecrementRetries(JobInfo job)
```
    Unacquires a job, meaning that this job was previously locked, and it is now freed to be acquired by other executor nodes.
  - createAsyncJob
```
void createAsyncJob(JobEntity jobEntity,
                    boolean exclusive)
```
    Creates an async job so that it can be continued later in a background thread.
  - scheduleAsyncJob
```
void scheduleAsyncJob(JobEntity job)
```
    Schedules and async job. If the AsyncExecutor is running, it can be executed immediately after the transaction. Otherwise it can be picked up by other executors.
  - scheduleTimerJob
```
void scheduleTimerJob(TimerJobEntity timerJob)
```
    Schedules a timer, meaning it will be inserted in the datastore.
  - getBusinessCalendarName
```
String getBusinessCalendarName(JobEntity timerEntity,
                               org.flowable.variable.api.delegate.VariableScope variableScope)
```
    Get the business calendar name of the job configuration
  - moveTimerJobToExecutableJob
```
JobEntity moveTimerJobToExecutableJob(TimerJobEntity timerJob)
```
    Moves a TimerJobEntity to become an async JobEntity. This happens for example when the due date of a timer is reached, the timer entity then becomes a 'regular' async job that can be picked up by the AsyncExecutor.
  - moveJobToTimerJob
```
TimerJobEntity moveJobToTimerJob(AbstractRuntimeJobEntity job)
```
    Moves an AbstractRuntimeJobEntity to become a TimerJobEntity. This happens for example when an async job is executed and fails. It then becomes a timer, as it needs to be retried later.
  - moveJobToSuspendedJob
```
SuspendedJobEntity moveJobToSuspendedJob(AbstractRuntimeJobEntity job)
```
    Moves an AbstractRuntimeJobEntity to become a SuspendedJobEntity, such that the AsyncExecutor won't pick it up anymore for execution.
  - activateSuspendedJob
```
AbstractRuntimeJobEntity activateSuspendedJob(SuspendedJobEntity job)
```
    Transforms a SuspendedJobEntity back to an AbstractRuntimeJobEntity (i.e. to what it was originally). The job will now again be able to picked up by the AsyncExecutor.
  - moveJobToDeadLetterJob
```
DeadLetterJobEntity moveJobToDeadLetterJob(AbstractRuntimeJobEntity job)
```
    Transforms an AbstractRuntimeJobEntity to a DeadLetterJobEntity. This means that the job has been tried a configurable amount of times, but kept failing.
  - moveDeadLetterJobToExecutableJob
```
JobEntity moveDeadLetterJobToExecutableJob(DeadLetterJobEntity deadLetterJobEntity,
                                           int retries)
```
    Transforms a DeadLetterJobEntity to a JobEntity, thus making it executable again. Note that a 'retries' parameter needs to be passed, as the job got into the deadletter table because of it failed and retries became 0.
  - scheduleHistoryJob
```
HistoryJobEntity scheduleHistoryJob(HistoryJobEntity historyJobEntity)
```
    schedules a HistoryJobEntity, meaning it will be scheduled (inserted in the database/put on a queue/...) to be executed at a later point in time.
  - setJobServiceConfiguration
```
void setJobServiceConfiguration(JobServiceConfiguration jobServiceConfiguration)
```
    The ProcessEngineConfiguration instance will be passed when the ProcessEngine is built.
  - createExecutableJobFromOtherJob
```
JobEntity createExecutableJobFromOtherJob(AbstractRuntimeJobEntity job)
```
    Create an executable job from another job
  - createTimerJobFromOtherJob
```
TimerJobEntity createTimerJobFromOtherJob(AbstractRuntimeJobEntity otherJob)
```
    Create a timer job from another job
  - createSuspendedJobFromOtherJob
```
SuspendedJobEntity createSuspendedJobFromOtherJob(AbstractRuntimeJobEntity otherJob)
```
    Create a suspended job from another job
  - createDeadLetterJobFromOtherJob
```
DeadLetterJobEntity createDeadLetterJobFromOtherJob(AbstractRuntimeJobEntity otherJob)
```
    Create a dead letter job from another job
  - copyJobInfo
```
AbstractRuntimeJobEntity copyJobInfo(AbstractRuntimeJobEntity copyToJob,
                                     AbstractRuntimeJobEntity copyFromJob)
```
    Copy job info from one job to the other

Interface JobManager

Method Summary

Method Detail

execute

unacquire

unacquireWithDecrementRetries

createAsyncJob

scheduleAsyncJob

scheduleTimerJob

getBusinessCalendarName

moveTimerJobToExecutableJob

moveJobToTimerJob

moveJobToSuspendedJob

activateSuspendedJob

moveJobToDeadLetterJob

moveDeadLetterJobToExecutableJob

scheduleHistoryJob

setJobServiceConfiguration

createExecutableJobFromOtherJob

createTimerJobFromOtherJob

createSuspendedJobFromOtherJob

createDeadLetterJobFromOtherJob

copyJobInfo