org.flowable.job.service.impl.asyncexecutor

Class DefaultAsyncJobExecutor

java.lang.Object

org.flowable.job.service.impl.asyncexecutor.AbstractAsyncExecutor

org.flowable.job.service.impl.asyncexecutor.DefaultAsyncJobExecutor

All Implemented Interfaces:

AsyncExecutor

Direct Known Subclasses:

DefaultAsyncHistoryJobExecutor, ManagedAsyncJobExecutor, SharedExecutorServiceAsyncExecutor

public class DefaultAsyncJobExecutor
extends AbstractAsyncExecutor

Author:

Joram Barrez, Tijs Rademakers

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowCoreThreadTimeout Whether or not core threads can time out (which is needed to scale down the threads)
protected Thread	asyncJobAcquisitionThread Thread responsible for async job acquisition.
protected int	corePoolSize The minimal number of threads that are kept alive in the threadpool for job execution
protected ExecutorService	executorService The executor service used for job execution
protected boolean	isAsyncJobAcquisitionEnabled If true (default), the thread for acquiring async jobs will be started.
protected boolean	isResetExpiredJobEnabled If true (default), the thread for acquiring expired jobs will be started.
protected boolean	isTimerJobAcquisitionEnabled If true (default), the thread for acquiring timer jobs will be started.
protected long	keepAliveTime The time (in milliseconds) a thread used for job execution must be kept alive before it is destroyed.
protected int	maxPoolSize The maximum number of threads that are kept alive in the threadpool for job execution
protected int	queueSize The size of the queue on which jobs to be executed are placed
protected Thread	resetExpiredJobThread Thread responsible for resetting the expired jobs.
protected long	secondsToWaitOnShutdown The time (in seconds) that is waited to gracefully shut down the threadpool used for job execution
protected String	threadPoolNamingPattern
protected BlockingQueue<Runnable>	threadPoolQueue The queue used for job execution work
protected Thread	timerJobAcquisitionThread Thread responsible for timer job acquisition.
protected boolean	unlockOwnedJobs Whether to unlock jobs that are owned by this executor (have the same lockOwner) at startup

Fields inherited from class org.flowable.job.service.impl.asyncexecutor.AbstractAsyncExecutor

acquireRunnableThreadName, asyncJobLockTimeInMillis, asyncJobsDueRunnable, asyncRunnableExecutionExceptionHandler, defaultAsyncJobAcquireWaitTimeInMillis, defaultQueueSizeFullWaitTime, defaultTimerJobAcquireWaitTimeInMillis, executeAsyncRunnableFactory, isActive, isAutoActivate, isMessageQueueMode, jobEntityManager, jobServiceConfiguration, lockOwner, maxAsyncJobsDuePerAcquisition, maxTimerJobsPerAcquisition, resetExpiredJobsInterval, resetExpiredJobsPageSize, resetExpiredJobsRunnable, resetExpiredRunnableName, retryWaitTimeInMillis, temporaryJobQueue, timerJobRunnable, timerLockTimeInMillis, timerRunnableNeeded

Constructor Summary

Constructors

Constructor and Description
DefaultAsyncJobExecutor()

Method Summary

Modifier and Type	Method and Description
protected boolean	executeAsyncJob(JobInfo job, Runnable runnable)
Thread	getAsyncJobAcquisitionThread()
int	getCorePoolSize()
ExecutorService	getExecutorService()
long	getKeepAliveTime()
int	getMaxPoolSize()
int	getQueueSize()
int	getRemainingCapacity()
Thread	getResetExpiredJobThread()
long	getSecondsToWaitOnShutdown()
String	getThreadPoolNamingPattern()
BlockingQueue<Runnable>	getThreadPoolQueue()
Thread	getTimerJobAcquisitionThread()
protected void	initAsyncJobExecutionThreadPool()
boolean	isAllowCoreThreadTimeout()
boolean	isAsyncJobAcquisitionEnabled()
boolean	isResetExpiredJobEnabled()
boolean	isTimerJobAcquisitionEnabled()
boolean	isUnlockOwnedJobs()
void	setAllowCoreThreadTimeout(boolean allowCoreThreadTimeout)
void	setAsyncJobAcquisitionEnabled(boolean isAsyncJobAcquisitionEnabled)
void	setAsyncJobAcquisitionThread(Thread asyncJobAcquisitionThread)
void	setCorePoolSize(int corePoolSize)
void	setExecutorService(ExecutorService executorService)
void	setKeepAliveTime(long keepAliveTime)
void	setMaxPoolSize(int maxPoolSize)
void	setQueueSize(int queueSize)
void	setResetExpiredJobEnabled(boolean isResetExpiredJobEnabled)
void	setResetExpiredJobThread(Thread resetExpiredJobThread)
void	setSecondsToWaitOnShutdown(long secondsToWaitOnShutdown)
void	setThreadPoolNamingPattern(String threadPoolNamingPattern)
void	setThreadPoolQueue(BlockingQueue<Runnable> threadPoolQueue)
void	setTimerJobAcquisitionEnabled(boolean isTimerJobAcquisitionEnabled)
void	setTimerJobAcquisitionThread(Thread timerJobAcquisitionThread)
void	setUnlockOwnedJobs(boolean unlockOwnedJobs)
protected void	shutdownAdditionalComponents()
protected void	startAdditionalComponents()
protected void	startJobAcquisitionThread() Starts the acquisition thread
protected void	startResetExpiredJobsThread() Starts the reset expired jobs thread
protected void	startTimerAcquisitionThread()
protected void	stopExecutingAsyncJobs()
protected void	stopJobAcquisitionThread() Stops the acquisition thread
protected void	stopResetExpiredJobsThread() Stops the reset expired jobs thread
protected void	stopTimerAcquisitionThread()
protected void	unacquireJobAfterRejection(JobInfo job)

Methods inherited from class org.flowable.job.service.impl.asyncexecutor.AbstractAsyncExecutor

createRunnableForJob, executeAsyncJob, executeTemporaryJobs, getAsyncJobLockTimeInMillis, getAsyncJobsDueRunnable, getAsyncRunnableExecutionExceptionHandler, getDefaultAsyncJobAcquireWaitTimeInMillis, getDefaultQueueSizeFullWaitTimeInMillis, getDefaultTimerJobAcquireWaitTimeInMillis, getExecuteAsyncRunnableFactory, getJobServiceConfiguration, getLockOwner, getMaxAsyncJobsDuePerAcquisition, getMaxTimerJobsPerAcquisition, getResetExpiredJobsInterval, getResetExpiredJobsPageSize, getResetExpiredJobsRunnable, getRetryWaitTimeInMillis, getTimerJobRunnable, getTimerLockTimeInMillis, initializeJobEntityManager, initializeRunnables, isActive, isAutoActivate, isMessageQueueMode, setAcquireRunnableThreadName, setAsyncJobLockTimeInMillis, setAsyncJobsDueRunnable, setAsyncRunnableExecutionExceptionHandler, setAutoActivate, setDefaultAsyncJobAcquireWaitTimeInMillis, setDefaultQueueSizeFullWaitTimeInMillis, setDefaultTimerJobAcquireWaitTimeInMillis, setExecuteAsyncRunnableFactory, setJobEntityManager, setJobServiceConfiguration, setLockOwner, setMaxAsyncJobsDuePerAcquisition, setMaxTimerJobsPerAcquisition, setMessageQueueMode, setResetExpiredJobsInterval, setResetExpiredJobsPageSize, setResetExpiredJobsRunnable, setResetExpiredRunnableName, setRetryWaitTimeInMillis, setTenantId, setTimerJobRunnable, setTimerLockTimeInMillis, setTimerRunnableNeeded, shutdown, start, stopRunnables, unlockOwnedJobs

Methods inherited from class java.lang.Object

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

Field Detail

isAsyncJobAcquisitionEnabled

protected boolean isAsyncJobAcquisitionEnabled

If true (default), the thread for acquiring async jobs will be started.

isTimerJobAcquisitionEnabled

protected boolean isTimerJobAcquisitionEnabled

If true (default), the thread for acquiring timer jobs will be started.

isResetExpiredJobEnabled

protected boolean isResetExpiredJobEnabled

If true (default), the thread for acquiring expired jobs will be started.

asyncJobAcquisitionThread

protected Thread asyncJobAcquisitionThread

Thread responsible for async job acquisition.

timerJobAcquisitionThread

protected Thread timerJobAcquisitionThread

Thread responsible for timer job acquisition.

resetExpiredJobThread

protected Thread resetExpiredJobThread

Thread responsible for resetting the expired jobs.

corePoolSize

protected int corePoolSize

The minimal number of threads that are kept alive in the threadpool for job execution

maxPoolSize

protected int maxPoolSize

The maximum number of threads that are kept alive in the threadpool for job execution

keepAliveTime

protected long keepAliveTime

The time (in milliseconds) a thread used for job execution must be kept alive before it is destroyed. Default setting is 0. Having a non-default setting of 0 takes resources, but in the case of many job executions it avoids creating new threads all the time.

queueSize

protected int queueSize

The size of the queue on which jobs to be executed are placed

allowCoreThreadTimeout

protected boolean allowCoreThreadTimeout

Whether or not core threads can time out (which is needed to scale down the threads)

unlockOwnedJobs

protected boolean unlockOwnedJobs

Whether to unlock jobs that are owned by this executor (have the same lockOwner) at startup

threadPoolQueue

protected BlockingQueue<Runnable> threadPoolQueue

The queue used for job execution work

executorService

protected ExecutorService executorService

The executor service used for job execution

secondsToWaitOnShutdown

protected long secondsToWaitOnShutdown

The time (in seconds) that is waited to gracefully shut down the threadpool used for job execution

threadPoolNamingPattern

protected String threadPoolNamingPattern

Constructor Detail

DefaultAsyncJobExecutor

public DefaultAsyncJobExecutor()

Method Detail

executeAsyncJob

protected boolean executeAsyncJob(JobInfo job,
                                  Runnable runnable)

Specified by:

executeAsyncJob in class AbstractAsyncExecutor

unacquireJobAfterRejection

protected void unacquireJobAfterRejection(JobInfo job)

startAdditionalComponents

protected void startAdditionalComponents()

Specified by:

startAdditionalComponents in class AbstractAsyncExecutor

shutdownAdditionalComponents

protected void shutdownAdditionalComponents()

Specified by:

shutdownAdditionalComponents in class AbstractAsyncExecutor

initAsyncJobExecutionThreadPool

protected void initAsyncJobExecutionThreadPool()

stopExecutingAsyncJobs

protected void stopExecutingAsyncJobs()

startJobAcquisitionThread

protected void startJobAcquisitionThread()

Starts the acquisition thread

startTimerAcquisitionThread

protected void startTimerAcquisitionThread()

stopJobAcquisitionThread

protected void stopJobAcquisitionThread()

Stops the acquisition thread

stopTimerAcquisitionThread

protected void stopTimerAcquisitionThread()

startResetExpiredJobsThread

protected void startResetExpiredJobsThread()

Starts the reset expired jobs thread

stopResetExpiredJobsThread

protected void stopResetExpiredJobsThread()

Stops the reset expired jobs thread

isAsyncJobAcquisitionEnabled

public boolean isAsyncJobAcquisitionEnabled()

setAsyncJobAcquisitionEnabled

public void setAsyncJobAcquisitionEnabled(boolean isAsyncJobAcquisitionEnabled)

isTimerJobAcquisitionEnabled

public boolean isTimerJobAcquisitionEnabled()

setTimerJobAcquisitionEnabled

public void setTimerJobAcquisitionEnabled(boolean isTimerJobAcquisitionEnabled)

isResetExpiredJobEnabled

public boolean isResetExpiredJobEnabled()

setResetExpiredJobEnabled

public void setResetExpiredJobEnabled(boolean isResetExpiredJobEnabled)

getTimerJobAcquisitionThread

public Thread getTimerJobAcquisitionThread()

setTimerJobAcquisitionThread

public void setTimerJobAcquisitionThread(Thread timerJobAcquisitionThread)

getAsyncJobAcquisitionThread

public Thread getAsyncJobAcquisitionThread()

setAsyncJobAcquisitionThread

public void setAsyncJobAcquisitionThread(Thread asyncJobAcquisitionThread)

getResetExpiredJobThread

public Thread getResetExpiredJobThread()

setResetExpiredJobThread

public void setResetExpiredJobThread(Thread resetExpiredJobThread)

getQueueSize

public int getQueueSize()

isAllowCoreThreadTimeout

public boolean isAllowCoreThreadTimeout()

setAllowCoreThreadTimeout

public void setAllowCoreThreadTimeout(boolean allowCoreThreadTimeout)

getRemainingCapacity

public int getRemainingCapacity()

setQueueSize

public void setQueueSize(int queueSize)

getCorePoolSize

public int getCorePoolSize()

setCorePoolSize

public void setCorePoolSize(int corePoolSize)

getMaxPoolSize

public int getMaxPoolSize()

setMaxPoolSize

public void setMaxPoolSize(int maxPoolSize)

getKeepAliveTime

public long getKeepAliveTime()

setKeepAliveTime

public void setKeepAliveTime(long keepAliveTime)

getSecondsToWaitOnShutdown

public long getSecondsToWaitOnShutdown()

setSecondsToWaitOnShutdown

public void setSecondsToWaitOnShutdown(long secondsToWaitOnShutdown)

isUnlockOwnedJobs

public boolean isUnlockOwnedJobs()

setUnlockOwnedJobs

public void setUnlockOwnedJobs(boolean unlockOwnedJobs)

getThreadPoolQueue

public BlockingQueue<Runnable> getThreadPoolQueue()

setThreadPoolQueue

public void setThreadPoolQueue(BlockingQueue<Runnable> threadPoolQueue)

getExecutorService

public ExecutorService getExecutorService()

setExecutorService

public void setExecutorService(ExecutorService executorService)

getThreadPoolNamingPattern

public String getThreadPoolNamingPattern()

setThreadPoolNamingPattern

public void setThreadPoolNamingPattern(String threadPoolNamingPattern)