org.activiti.engine.impl.asyncexecutor

Class DefaultJobManager

java.lang.Object

org.activiti.engine.impl.asyncexecutor.DefaultJobManager

All Implemented Interfaces:

JobManager

public class DefaultJobManager
extends Object
implements JobManager

Field Summary

Fields

Modifier and Type	Field and Description
protected ProcessEngineConfigurationImpl	processEngineConfiguration

Constructor Summary

Constructors

Constructor and Description
DefaultJobManager()
DefaultJobManager(ProcessEngineConfigurationImpl processEngineConfiguration)

Method Summary

Modifier and Type	Method and Description
AbstractJobEntity	activateSuspendedJob(SuspendedJobEntity job) Transforms a SuspendedJobEntity back to an AbstractJobEntity (i.e.
protected int	calculateMaxIterationsValue(String originalExpression)
protected AbstractJobEntity	copyJobInfo(AbstractJobEntity copyToJob, AbstractJobEntity copyFromJob)
JobEntity	createAsyncJob(ExecutionEntity execution, boolean exclusive) Creates an async job for the provided ExecutionEntity, so that it can be continued later in a background thread.
protected DeadLetterJobEntity	createDeadLetterJobFromOtherJob(AbstractJobEntity otherJob)
protected JobEntity	createExecutableJobFromOtherJob(AbstractJobEntity job)
protected SuspendedJobEntity	createSuspendedJobFromOtherJob(AbstractJobEntity otherJob)
TimerJobEntity	createTimerJob(TimerEventDefinition timerEventDefinition, boolean interrupting, ExecutionEntity execution, String timerEventType, String jobHandlerConfiguration) Creates a TimerJobEntity based on the current ExecutionEntity and the configuration in the TimerEventDefinition.
protected TimerJobEntity	createTimerJobFromOtherJob(AbstractJobEntity otherJob)
void	execute(Job 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.
protected void	executeJobHandler(JobEntity jobEntity)
protected void	executeMessageJob(JobEntity jobEntity)
protected void	executeTimerJob(JobEntity timerEntity)
protected void	fillDefaultAsyncJobInfo(JobEntity jobEntity, ExecutionEntity execution, boolean exclusive)
protected AsyncExecutor	getAsyncExecutor()
protected String	getBusinessCalendarName(String calendarName, VariableScope variableScope)
protected CommandContext	getCommandContext()
protected ExecutionEntityManager	getExecutionEntityManager()
protected int	getMaxIterations(Process process, String activityId)
ProcessEngineConfigurationImpl	getProcessEngineConfiguration()
protected void	hintAsyncExecutor(JobEntity job)
protected JobEntity	internalCreateAsyncJob(ExecutionEntity execution, boolean exclusive)
protected JobEntity	internalCreateLockedAsyncJob(ExecutionEntity execution, boolean exclusive)
protected boolean	isAsyncExecutorActive()
protected boolean	isValidTime(JobEntity timerEntity, Date newTimerDate, VariableScope variableScope)
JobEntity	moveDeadLetterJobToExecutableJob(DeadLetterJobEntity deadLetterJobEntity, int retries) Transforms a DeadLetterJobEntity to a JobEntity, thus making it executable again.
DeadLetterJobEntity	moveJobToDeadLetterJob(AbstractJobEntity job) Transforms an AbstractJobEntity to a DeadLetterJobEntity.
SuspendedJobEntity	moveJobToSuspendedJob(AbstractJobEntity job) Moves an AbstractJobEntity to become a SuspendedJobEntity, such that the AsyncExecutor won't pick it up anymore for execution.
TimerJobEntity	moveJobToTimerJob(AbstractJobEntity job) Moves an AbstractJobEntity to become a TimerJobEntity.
JobEntity	moveTimerJobToExecutableJob(TimerJobEntity timerJob) Moves a TimerJobEntity to become an async JobEntity.
protected void	restoreExtraData(JobEntity timerEntity, VariableScope variableScope)
void	scheduleAsyncJob(JobEntity jobEntity) Schedules and async job.
void	scheduleTimerJob(TimerJobEntity timerJob) Schedules a timer, meaning it will be inserted in the datastore.
void	setProcessEngineConfiguration(ProcessEngineConfigurationImpl processEngineConfiguration) The ProcessEngineCongiguration instance will be passed when the ProcessEngine is built.
protected void	triggerExecutorIfNeeded(JobEntity jobEntity)
void	unacquire(Job job) Unacquires a job, meaning that this job was previously locked, and it is now freed to be acquired by other executor nodes.

Methods inherited from class java.lang.Object

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

Field Detail

processEngineConfiguration

protected ProcessEngineConfigurationImpl processEngineConfiguration

Constructor Detail

DefaultJobManager

public DefaultJobManager()

DefaultJobManager

public DefaultJobManager(ProcessEngineConfigurationImpl processEngineConfiguration)

Method Detail

createAsyncJob

public JobEntity createAsyncJob(ExecutionEntity execution,
                                boolean exclusive)

Description copied from interface: JobManager

Creates an async job for the provided ExecutionEntity, so that it can be continued later in a background thread.

Specified by:

createAsyncJob in interface JobManager

scheduleAsyncJob

public void scheduleAsyncJob(JobEntity jobEntity)

Description copied from interface: JobManager

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.

Specified by:

scheduleAsyncJob in interface JobManager

triggerExecutorIfNeeded

protected void triggerExecutorIfNeeded(JobEntity jobEntity)

createTimerJob

public TimerJobEntity createTimerJob(TimerEventDefinition timerEventDefinition,
                                     boolean interrupting,
                                     ExecutionEntity execution,
                                     String timerEventType,
                                     String jobHandlerConfiguration)

Description copied from interface: JobManager

Creates a TimerJobEntity based on the current ExecutionEntity and the configuration in the TimerEventDefinition.

Specified by:

createTimerJob in interface JobManager

scheduleTimerJob

public void scheduleTimerJob(TimerJobEntity timerJob)

Description copied from interface: JobManager

Schedules a timer, meaning it will be inserted in the datastore.

Specified by:

scheduleTimerJob in interface JobManager

moveTimerJobToExecutableJob

public JobEntity moveTimerJobToExecutableJob(TimerJobEntity timerJob)

Description copied from interface: JobManager

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.

Specified by:

moveTimerJobToExecutableJob in interface JobManager

moveJobToTimerJob

public TimerJobEntity moveJobToTimerJob(AbstractJobEntity job)

Description copied from interface: JobManager

Moves an AbstractJobEntity 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.

Specified by:

moveJobToTimerJob in interface JobManager

moveJobToSuspendedJob

public SuspendedJobEntity moveJobToSuspendedJob(AbstractJobEntity job)

Description copied from interface: JobManager

Moves an AbstractJobEntity to become a SuspendedJobEntity, such that the AsyncExecutor won't pick it up anymore for execution.

Specified by:

moveJobToSuspendedJob in interface JobManager

activateSuspendedJob

public AbstractJobEntity activateSuspendedJob(SuspendedJobEntity job)

Description copied from interface: JobManager

Transforms a SuspendedJobEntity back to an AbstractJobEntity (i.e. to what it was originally). The job will now again be able to picked up by the AsyncExecutor.

Specified by:

activateSuspendedJob in interface JobManager

moveJobToDeadLetterJob

public DeadLetterJobEntity moveJobToDeadLetterJob(AbstractJobEntity job)

Description copied from interface: JobManager

Transforms an AbstractJobEntity to a DeadLetterJobEntity. This means that the job has been tried a configurable amount of times, but kept failing.

Specified by:

moveJobToDeadLetterJob in interface JobManager

moveDeadLetterJobToExecutableJob

public JobEntity moveDeadLetterJobToExecutableJob(DeadLetterJobEntity deadLetterJobEntity,
                                                  int retries)

Description copied from interface: JobManager

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.

Specified by:

moveDeadLetterJobToExecutableJob in interface JobManager

execute

public void execute(Job job)

Description copied from interface: JobManager

Execute a job, which means that the logic (async logic, timer that fires, etc) is executed, typically by a background thread of an executor.

Specified by:

execute in interface JobManager

unacquire

public void unacquire(Job job)

Description copied from interface: JobManager

Unacquires a job, meaning that this job was previously locked, and it is now freed to be acquired by other executor nodes.

Specified by:

unacquire in interface JobManager

executeMessageJob

protected void executeMessageJob(JobEntity jobEntity)

executeTimerJob

protected void executeTimerJob(JobEntity timerEntity)

executeJobHandler

protected void executeJobHandler(JobEntity jobEntity)

restoreExtraData

protected void restoreExtraData(JobEntity timerEntity,
                                VariableScope variableScope)

getMaxIterations

protected int getMaxIterations(Process process,
                               String activityId)

calculateMaxIterationsValue

protected int calculateMaxIterationsValue(String originalExpression)

isValidTime

protected boolean isValidTime(JobEntity timerEntity,
                              Date newTimerDate,
                              VariableScope variableScope)

getBusinessCalendarName

protected String getBusinessCalendarName(String calendarName,
                                         VariableScope variableScope)

hintAsyncExecutor

protected void hintAsyncExecutor(JobEntity job)

internalCreateAsyncJob

protected JobEntity internalCreateAsyncJob(ExecutionEntity execution,
                                           boolean exclusive)

internalCreateLockedAsyncJob

protected JobEntity internalCreateLockedAsyncJob(ExecutionEntity execution,
                                                 boolean exclusive)

fillDefaultAsyncJobInfo

protected void fillDefaultAsyncJobInfo(JobEntity jobEntity,
                                       ExecutionEntity execution,
                                       boolean exclusive)

createExecutableJobFromOtherJob

protected JobEntity createExecutableJobFromOtherJob(AbstractJobEntity job)

createTimerJobFromOtherJob

protected TimerJobEntity createTimerJobFromOtherJob(AbstractJobEntity otherJob)

createSuspendedJobFromOtherJob

protected SuspendedJobEntity createSuspendedJobFromOtherJob(AbstractJobEntity otherJob)

createDeadLetterJobFromOtherJob

protected DeadLetterJobEntity createDeadLetterJobFromOtherJob(AbstractJobEntity otherJob)

copyJobInfo

protected AbstractJobEntity copyJobInfo(AbstractJobEntity copyToJob,
                                        AbstractJobEntity copyFromJob)

getProcessEngineConfiguration

public ProcessEngineConfigurationImpl getProcessEngineConfiguration()

setProcessEngineConfiguration

public void setProcessEngineConfiguration(ProcessEngineConfigurationImpl processEngineConfiguration)

Description copied from interface: JobManager

The ProcessEngineCongiguration instance will be passed when the ProcessEngine is built.

Specified by:

setProcessEngineConfiguration in interface JobManager

isAsyncExecutorActive

protected boolean isAsyncExecutorActive()

getCommandContext

protected CommandContext getCommandContext()

getAsyncExecutor

protected AsyncExecutor getAsyncExecutor()

getExecutionEntityManager

protected ExecutionEntityManager getExecutionEntityManager()