Package org.flowable.job.service.impl.asyncexecutor

Class AbstractAsyncExecutor

java.lang.Object

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

All Implemented Interfaces:

AsyncExecutor

Direct Known Subclasses:

DefaultAsyncJobExecutor

public abstract class AbstractAsyncExecutor
extends Object
implements AsyncExecutor

Author:

Joram Barrez, Tijs Rademakers, Marcus Klimstra

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AbstractAsyncExecutor.AcquireAsyncJobsDueRunnableConfiguration
class	AbstractAsyncExecutor.AcquireTimerRunnableConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
protected AcquireAsyncJobsDueLifecycleListener	asyncJobsDueLifecycleListener
protected AcquireAsyncJobsDueRunnable	asyncJobsDueRunnable
protected AsyncRunnableExecutionExceptionHandler	asyncRunnableExecutionExceptionHandler
protected AsyncJobExecutorConfiguration	configuration
protected ExecuteAsyncRunnableFactory	executeAsyncRunnableFactory
protected boolean	isActive
protected boolean	isAutoActivate
protected boolean	isMessageQueueMode
protected JobInfoEntityManager<? extends JobInfoEntity>	jobEntityManager
protected JobServiceConfiguration	jobServiceConfiguration
protected ResetExpiredJobsRunnable	resetExpiredJobsRunnable
protected LinkedList<JobInfo>	temporaryJobQueue
protected AcquireTimerJobsRunnable	timerJobRunnable
protected AcquireTimerLifecycleListener	timerLifecycleListener

Constructor Summary

Constructors

Constructor	Description
AbstractAsyncExecutor()
AbstractAsyncExecutor(AsyncJobExecutorConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
protected abstract ResetExpiredJobsRunnable	createResetExpiredJobsRunnable(String resetRunnableName)
protected Runnable	createRunnableForJob(JobInfo job)
boolean	executeAsyncJob(JobInfo job)	Offers the provided JobInfo to this AsyncExecutor instance to execute.
protected abstract boolean	executeAsyncJob(JobInfo job, Runnable runnable)
protected void	executeTemporaryJobs()
int	getAsyncJobLockTimeInMillis()
AcquireAsyncJobsDueLifecycleListener	getAsyncJobsDueLifecycleListener()
AcquireAsyncJobsDueRunnable	getAsyncJobsDueRunnable()
Duration	getAsyncJobsGlobalLockPollRate()
Duration	getAsyncJobsGlobalLockWaitTime()
AsyncRunnableExecutionExceptionHandler	getAsyncRunnableExecutionExceptionHandler()
AsyncJobExecutorConfiguration	getConfiguration()
int	getDefaultAsyncJobAcquireWaitTimeInMillis()
int	getDefaultQueueSizeFullWaitTimeInMillis()
int	getDefaultTimerJobAcquireWaitTimeInMillis()
ExecuteAsyncRunnableFactory	getExecuteAsyncRunnableFactory()
String	getGlobalAcquireLockPrefix()
JobServiceConfiguration	getJobServiceConfiguration()
String	getLockOwner()
int	getMaxAsyncJobsDuePerAcquisition()
int	getMaxTimerJobsPerAcquisition()
int	getMoveTimerExecutorPoolSize()
int	getResetExpiredJobsInterval()
int	getResetExpiredJobsPageSize()
ResetExpiredJobsRunnable	getResetExpiredJobsRunnable()
int	getRetryWaitTimeInMillis()	Deprecated.
String	getTenantId()
AcquireTimerJobsRunnable	getTimerJobRunnable()
AcquireTimerLifecycleListener	getTimerLifecycleListener()
Duration	getTimerLockPollRate()
int	getTimerLockTimeInMillis()
Duration	getTimerLockWaitTime()
protected void	initializeJobEntityManager()
protected void	initializeRunnables()
boolean	isActive()
boolean	isAutoActivate()
boolean	isGlobalAcquireLockEnabled()
boolean	isMessageQueueMode()
boolean	isTimerRunnableNeeded()
void	setAcquireRunnableThreadName(String acquireRunnableThreadName)
void	setAsyncJobLockTimeInMillis(int asyncJobLockTimeInMillis)
void	setAsyncJobsDueLifecycleListener(AcquireAsyncJobsDueLifecycleListener asyncJobsDueLifecycleListener)
void	setAsyncJobsDueRunnable(AcquireAsyncJobsDueRunnable asyncJobsDueRunnable)
void	setAsyncJobsGlobalLockPollRate(Duration asyncJobsGlobalLockPollRate)
void	setAsyncJobsGlobalLockWaitTime(Duration asyncJobsGlobalLockWaitTime)
void	setAsyncRunnableExecutionExceptionHandler(AsyncRunnableExecutionExceptionHandler asyncRunnableExecutionExceptionHandler)
void	setAutoActivate(boolean isAutoActivate)
void	setConfiguration(AsyncJobExecutorConfiguration configuration)
void	setDefaultAsyncJobAcquireWaitTimeInMillis(int defaultAsyncJobAcquireWaitTimeInMillis)
void	setDefaultQueueSizeFullWaitTimeInMillis(int defaultQueueSizeFullWaitTime)
void	setDefaultTimerJobAcquireWaitTimeInMillis(int defaultTimerJobAcquireWaitTimeInMillis)
void	setExecuteAsyncRunnableFactory(ExecuteAsyncRunnableFactory executeAsyncRunnableFactory)
void	setGlobalAcquireLockEnabled(boolean globalAcquireLockEnabled)
void	setGlobalAcquireLockPrefix(String globalAcquireLockPrefix)
void	setJobEntityManager(JobInfoEntityManager<? extends JobInfoEntity> jobEntityManager)
void	setJobServiceConfiguration(JobServiceConfiguration jobServiceConfiguration)
void	setLockOwner(String lockOwner)
void	setMaxAsyncJobsDuePerAcquisition(int maxAsyncJobsDuePerAcquisition)
void	setMaxTimerJobsPerAcquisition(int maxTimerJobsPerAcquisition)
void	setMessageQueueMode(boolean isMessageQueueMode)
void	setMoveTimerExecutorPoolSize(int moveTimerExecutorPoolSize)
void	setResetExpiredJobsInterval(int resetExpiredJobsInterval)
void	setResetExpiredJobsPageSize(int resetExpiredJobsPageSize)
void	setResetExpiredJobsRunnable(ResetExpiredJobsRunnable resetExpiredJobsRunnable)
void	setResetExpiredRunnableName(String resetExpiredRunnableName)
void	setRetryWaitTimeInMillis(int retryWaitTimeInMillis)	Deprecated.
void	setTenantId(String tenantId)
void	setTimerJobRunnable(AcquireTimerJobsRunnable timerJobRunnable)
void	setTimerLifecycleListener(AcquireTimerLifecycleListener timerLifecycleListener)
void	setTimerLockPollRate(Duration timerLockPollRate)
void	setTimerLockTimeInMillis(int timerLockTimeInMillis)
void	setTimerLockWaitTime(Duration timerLockWaitTime)
void	setTimerRunnableNeeded(boolean timerRunnableNeeded)
void	shutdown()	Shuts down the whole job executor
protected abstract void	shutdownAdditionalComponents()
void	start()	Starts the async executor
protected abstract void	startAdditionalComponents()
protected void	stopRunnables()
protected void	unlockOwnedJobs()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.flowable.job.service.impl.asyncexecutor.AsyncExecutor

getTaskExecutor, setTaskExecutor

Field Detail

configuration

protected AsyncJobExecutorConfiguration configuration

timerJobRunnable

protected AcquireTimerJobsRunnable timerJobRunnable

timerLifecycleListener

protected AcquireTimerLifecycleListener timerLifecycleListener

jobEntityManager

protected JobInfoEntityManager<? extends JobInfoEntity> jobEntityManager

asyncJobsDueRunnable

protected AcquireAsyncJobsDueRunnable asyncJobsDueRunnable

asyncJobsDueLifecycleListener

protected AcquireAsyncJobsDueLifecycleListener asyncJobsDueLifecycleListener

resetExpiredJobsRunnable

protected ResetExpiredJobsRunnable resetExpiredJobsRunnable

executeAsyncRunnableFactory

protected ExecuteAsyncRunnableFactory executeAsyncRunnableFactory

asyncRunnableExecutionExceptionHandler

protected AsyncRunnableExecutionExceptionHandler asyncRunnableExecutionExceptionHandler

isAutoActivate

protected boolean isAutoActivate

isActive

protected boolean isActive

isMessageQueueMode

protected boolean isMessageQueueMode

temporaryJobQueue

protected LinkedList<JobInfo> temporaryJobQueue

jobServiceConfiguration

protected JobServiceConfiguration jobServiceConfiguration

Constructor Detail

AbstractAsyncExecutor

public AbstractAsyncExecutor()

AbstractAsyncExecutor

public AbstractAsyncExecutor(AsyncJobExecutorConfiguration configuration)

Method Detail

executeAsyncJob

public boolean executeAsyncJob(JobInfo job)

Description copied from interface: AsyncExecutor

Offers the provided JobInfo to this AsyncExecutor instance to execute. If the offering does not work for some reason, false will be returned (For example when the job queue is full in the DefaultAsyncJobExecutor).

Specified by:

executeAsyncJob in interface AsyncExecutor

executeAsyncJob

protected abstract boolean executeAsyncJob(JobInfo job,
                                           Runnable runnable)

unlockOwnedJobs

protected void unlockOwnedJobs()

createRunnableForJob

protected Runnable createRunnableForJob(JobInfo job)

start

public void start()

Starts the async executor

Specified by:

start in interface AsyncExecutor

initializeJobEntityManager

protected void initializeJobEntityManager()

initializeRunnables

protected void initializeRunnables()

createResetExpiredJobsRunnable

protected abstract ResetExpiredJobsRunnable createResetExpiredJobsRunnable(String resetRunnableName)

startAdditionalComponents

protected abstract void startAdditionalComponents()

executeTemporaryJobs

protected void executeTemporaryJobs()

shutdown

public void shutdown()

Shuts down the whole job executor

Specified by:

shutdown in interface AsyncExecutor

stopRunnables

protected void stopRunnables()

shutdownAdditionalComponents

protected abstract void shutdownAdditionalComponents()

getJobServiceConfiguration

public JobServiceConfiguration getJobServiceConfiguration()

Specified by:

getJobServiceConfiguration in interface AsyncExecutor

setJobServiceConfiguration

public void setJobServiceConfiguration(JobServiceConfiguration jobServiceConfiguration)

Specified by:

setJobServiceConfiguration in interface AsyncExecutor

isAutoActivate

public boolean isAutoActivate()

Specified by:

isAutoActivate in interface AsyncExecutor

setAutoActivate

public void setAutoActivate(boolean isAutoActivate)

Specified by:

setAutoActivate in interface AsyncExecutor

isActive

public boolean isActive()

Specified by:

isActive in interface AsyncExecutor

isMessageQueueMode

public boolean isMessageQueueMode()

setMessageQueueMode

public void setMessageQueueMode(boolean isMessageQueueMode)

getLockOwner

public String getLockOwner()

Specified by:

getLockOwner in interface AsyncExecutor

setLockOwner

public void setLockOwner(String lockOwner)

getTimerLockTimeInMillis

public int getTimerLockTimeInMillis()

Specified by:

getTimerLockTimeInMillis in interface AsyncExecutor

setTimerLockTimeInMillis

public void setTimerLockTimeInMillis(int timerLockTimeInMillis)

Specified by:

setTimerLockTimeInMillis in interface AsyncExecutor

getAsyncJobLockTimeInMillis

public int getAsyncJobLockTimeInMillis()

Specified by:

getAsyncJobLockTimeInMillis in interface AsyncExecutor

setAsyncJobLockTimeInMillis

public void setAsyncJobLockTimeInMillis(int asyncJobLockTimeInMillis)

Specified by:

setAsyncJobLockTimeInMillis in interface AsyncExecutor

getMoveTimerExecutorPoolSize

public int getMoveTimerExecutorPoolSize()

setMoveTimerExecutorPoolSize

public void setMoveTimerExecutorPoolSize(int moveTimerExecutorPoolSize)

getMaxTimerJobsPerAcquisition

public int getMaxTimerJobsPerAcquisition()

Specified by:

getMaxTimerJobsPerAcquisition in interface AsyncExecutor

setMaxTimerJobsPerAcquisition

public void setMaxTimerJobsPerAcquisition(int maxTimerJobsPerAcquisition)

Specified by:

setMaxTimerJobsPerAcquisition in interface AsyncExecutor

getMaxAsyncJobsDuePerAcquisition

public int getMaxAsyncJobsDuePerAcquisition()

Specified by:

getMaxAsyncJobsDuePerAcquisition in interface AsyncExecutor

setMaxAsyncJobsDuePerAcquisition

public void setMaxAsyncJobsDuePerAcquisition(int maxAsyncJobsDuePerAcquisition)

Specified by:

setMaxAsyncJobsDuePerAcquisition in interface AsyncExecutor

getDefaultTimerJobAcquireWaitTimeInMillis

public int getDefaultTimerJobAcquireWaitTimeInMillis()

Specified by:

getDefaultTimerJobAcquireWaitTimeInMillis in interface AsyncExecutor

setDefaultTimerJobAcquireWaitTimeInMillis

public void setDefaultTimerJobAcquireWaitTimeInMillis(int defaultTimerJobAcquireWaitTimeInMillis)

Specified by:

setDefaultTimerJobAcquireWaitTimeInMillis in interface AsyncExecutor

getDefaultAsyncJobAcquireWaitTimeInMillis

public int getDefaultAsyncJobAcquireWaitTimeInMillis()

Specified by:

getDefaultAsyncJobAcquireWaitTimeInMillis in interface AsyncExecutor

setDefaultAsyncJobAcquireWaitTimeInMillis

public void setDefaultAsyncJobAcquireWaitTimeInMillis(int defaultAsyncJobAcquireWaitTimeInMillis)

Specified by:

setDefaultAsyncJobAcquireWaitTimeInMillis in interface AsyncExecutor

setTimerJobRunnable

public void setTimerJobRunnable(AcquireTimerJobsRunnable timerJobRunnable)

getDefaultQueueSizeFullWaitTimeInMillis

public int getDefaultQueueSizeFullWaitTimeInMillis()

Specified by:

getDefaultQueueSizeFullWaitTimeInMillis in interface AsyncExecutor

setDefaultQueueSizeFullWaitTimeInMillis

public void setDefaultQueueSizeFullWaitTimeInMillis(int defaultQueueSizeFullWaitTime)

Specified by:

setDefaultQueueSizeFullWaitTimeInMillis in interface AsyncExecutor

setAsyncJobsDueRunnable

public void setAsyncJobsDueRunnable(AcquireAsyncJobsDueRunnable asyncJobsDueRunnable)

getAsyncJobsDueLifecycleListener

public AcquireAsyncJobsDueLifecycleListener getAsyncJobsDueLifecycleListener()

setAsyncJobsDueLifecycleListener

public void setAsyncJobsDueLifecycleListener(AcquireAsyncJobsDueLifecycleListener asyncJobsDueLifecycleListener)

isTimerRunnableNeeded

public boolean isTimerRunnableNeeded()

setTimerRunnableNeeded

public void setTimerRunnableNeeded(boolean timerRunnableNeeded)

getTimerLifecycleListener

public AcquireTimerLifecycleListener getTimerLifecycleListener()

setTimerLifecycleListener

public void setTimerLifecycleListener(AcquireTimerLifecycleListener timerLifecycleListener)

isGlobalAcquireLockEnabled

public boolean isGlobalAcquireLockEnabled()

setGlobalAcquireLockEnabled

public void setGlobalAcquireLockEnabled(boolean globalAcquireLockEnabled)

getGlobalAcquireLockPrefix

public String getGlobalAcquireLockPrefix()

setGlobalAcquireLockPrefix

public void setGlobalAcquireLockPrefix(String globalAcquireLockPrefix)

getAsyncJobsGlobalLockWaitTime

public Duration getAsyncJobsGlobalLockWaitTime()

setAsyncJobsGlobalLockWaitTime

public void setAsyncJobsGlobalLockWaitTime(Duration asyncJobsGlobalLockWaitTime)

getAsyncJobsGlobalLockPollRate

public Duration getAsyncJobsGlobalLockPollRate()

setAsyncJobsGlobalLockPollRate

public void setAsyncJobsGlobalLockPollRate(Duration asyncJobsGlobalLockPollRate)

getTimerLockWaitTime

public Duration getTimerLockWaitTime()

setTimerLockWaitTime

public void setTimerLockWaitTime(Duration timerLockWaitTime)

getTimerLockPollRate

public Duration getTimerLockPollRate()

setTimerLockPollRate

public void setTimerLockPollRate(Duration timerLockPollRate)

setAcquireRunnableThreadName

public void setAcquireRunnableThreadName(String acquireRunnableThreadName)

setJobEntityManager

public void setJobEntityManager(JobInfoEntityManager<? extends JobInfoEntity> jobEntityManager)

setResetExpiredRunnableName

public void setResetExpiredRunnableName(String resetExpiredRunnableName)

setResetExpiredJobsRunnable

public void setResetExpiredJobsRunnable(ResetExpiredJobsRunnable resetExpiredJobsRunnable)

getRetryWaitTimeInMillis

@Deprecated
public int getRetryWaitTimeInMillis()

Deprecated.

Specified by:

getRetryWaitTimeInMillis in interface AsyncExecutor

setRetryWaitTimeInMillis

@Deprecated
public void setRetryWaitTimeInMillis(int retryWaitTimeInMillis)

Deprecated.

Specified by:

setRetryWaitTimeInMillis in interface AsyncExecutor

getResetExpiredJobsInterval

public int getResetExpiredJobsInterval()

Specified by:

getResetExpiredJobsInterval in interface AsyncExecutor

setResetExpiredJobsInterval

public void setResetExpiredJobsInterval(int resetExpiredJobsInterval)

Specified by:

setResetExpiredJobsInterval in interface AsyncExecutor

getResetExpiredJobsPageSize

public int getResetExpiredJobsPageSize()

Specified by:

getResetExpiredJobsPageSize in interface AsyncExecutor

setResetExpiredJobsPageSize

public void setResetExpiredJobsPageSize(int resetExpiredJobsPageSize)

Specified by:

setResetExpiredJobsPageSize in interface AsyncExecutor

getExecuteAsyncRunnableFactory

public ExecuteAsyncRunnableFactory getExecuteAsyncRunnableFactory()

setExecuteAsyncRunnableFactory

public void setExecuteAsyncRunnableFactory(ExecuteAsyncRunnableFactory executeAsyncRunnableFactory)

getAsyncRunnableExecutionExceptionHandler

public AsyncRunnableExecutionExceptionHandler getAsyncRunnableExecutionExceptionHandler()

setAsyncRunnableExecutionExceptionHandler

public void setAsyncRunnableExecutionExceptionHandler(AsyncRunnableExecutionExceptionHandler asyncRunnableExecutionExceptionHandler)

getTimerJobRunnable

public AcquireTimerJobsRunnable getTimerJobRunnable()

getAsyncJobsDueRunnable

public AcquireAsyncJobsDueRunnable getAsyncJobsDueRunnable()

getResetExpiredJobsRunnable

public ResetExpiredJobsRunnable getResetExpiredJobsRunnable()

getTenantId

public String getTenantId()

setTenantId

public void setTenantId(String tenantId)

getConfiguration

public AsyncJobExecutorConfiguration getConfiguration()

setConfiguration

public void setConfiguration(AsyncJobExecutorConfiguration configuration)