DefaultAsyncJobExecutor (Activiti

java.lang.Object
- org.activiti.engine.impl.asyncexecutor.DefaultAsyncJobExecutor

All Implemented Interfaces:

AsyncExecutor

Direct Known Subclasses:

ManagedAsyncJobExecutor
```
public class DefaultAsyncJobExecutor
extends Object
implements AsyncExecutor
```
Author:

Joram Barrez, Tijs Rademakers

Field Summary

Fields
Modifier and Type	Field and Description
`protected Thread`	`asyncJobAcquisitionThread`
`protected int`	`asyncJobLockTimeInMillis`
`protected AcquireAsyncJobsDueRunnable`	`asyncJobsDueRunnable`
`protected CommandExecutor`	`commandExecutor`
`protected int`	`corePoolSize` The minimal number of threads that are kept alive in the threadpool for job execution
`protected int`	`defaultAsyncJobAcquireWaitTimeInMillis`
`protected int`	`defaultTimerJobAcquireWaitTimeInMillis`
`protected ExecutorService`	`executorService` The executor service used for job execution
`protected boolean`	`isActive`
`protected boolean`	`isAutoActivate`
`protected long`	`keepAliveTime` The time (in milliseconds) a thread used for job execution must be kept alive before it is destroyed.
`protected String`	`lockOwner`
`protected int`	`maxAsyncJobsDuePerAcquisition`
`protected int`	`maxPoolSize` The maximum number of threads that are kept alive in the threadpool for job execution
`protected int`	`maxTimerJobsPerAcquisition`
`protected int`	`queueSize` The size of the queue on which jobs to be executed are placed
`protected int`	`retryWaitTimeInMillis`
`protected long`	`secondsToWaitOnShutdown` The time (in seconds) that is waited to gracefully shut down the threadpool used for job execution
`protected LinkedList<JobEntity>`	`temporaryJobQueue`
`protected BlockingQueue<Runnable>`	`threadPoolQueue` The queue used for job execution work
`protected Thread`	`timerJobAcquisitionThread`
`protected AcquireTimerJobsRunnable`	`timerJobRunnable`
`protected int`	`timerLockTimeInMillis`

Constructor Summary

Constructors
Constructor and Description

DefaultAsyncJobExecutor()

Constructors
Constructor and Description
`DefaultAsyncJobExecutor()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`executeAsyncJob(JobEntity job)`
`int`	`getAsyncJobLockTimeInMillis()`
`CommandExecutor`	`getCommandExecutor()`
`int`	`getCorePoolSize()`
`int`	`getDefaultAsyncJobAcquireWaitTimeInMillis()`
`int`	`getDefaultTimerJobAcquireWaitTimeInMillis()`
`ExecutorService`	`getExecutorService()`
`long`	`getKeepAliveTime()`
`String`	`getLockOwner()`
`int`	`getMaxAsyncJobsDuePerAcquisition()`
`int`	`getMaxPoolSize()`
`int`	`getMaxTimerJobsPerAcquisition()`
`int`	`getQueueSize()`
`int`	`getRetryWaitTimeInMillis()`
`long`	`getSecondsToWaitOnShutdown()`
`BlockingQueue<Runnable>`	`getThreadPoolQueue()`
`int`	`getTimerLockTimeInMillis()`
`boolean`	`isActive()`
`boolean`	`isAutoActivate()`
`void`	`setAsyncJobLockTimeInMillis(int asyncJobLockTimeInMillis)`
`void`	`setAsyncJobsDueRunnable(AcquireAsyncJobsDueRunnable asyncJobsDueRunnable)`
`void`	`setAutoActivate(boolean isAutoActivate)`
`void`	`setCommandExecutor(CommandExecutor commandExecutor)`
`void`	`setCorePoolSize(int corePoolSize)`
`void`	`setDefaultAsyncJobAcquireWaitTimeInMillis(int defaultAsyncJobAcquireWaitTimeInMillis)`
`void`	`setDefaultTimerJobAcquireWaitTimeInMillis(int defaultTimerJobAcquireWaitTimeInMillis)`
`void`	`setExecutorService(ExecutorService executorService)`
`void`	`setKeepAliveTime(long keepAliveTime)`
`void`	`setLockOwner(String lockOwner)`
`void`	`setMaxAsyncJobsDuePerAcquisition(int maxAsyncJobsDuePerAcquisition)`
`void`	`setMaxPoolSize(int maxPoolSize)`
`void`	`setMaxTimerJobsPerAcquisition(int maxTimerJobsPerAcquisition)`
`void`	`setQueueSize(int queueSize)`
`void`	`setRetryWaitTimeInMillis(int retryWaitTimeInMillis)`
`void`	`setSecondsToWaitOnShutdown(long secondsToWaitOnShutdown)`
`void`	`setThreadPoolQueue(BlockingQueue<Runnable> threadPoolQueue)`
`void`	`setTimerJobRunnable(AcquireTimerJobsRunnable timerJobRunnable)`
`void`	`setTimerLockTimeInMillis(int timerLockTimeInMillis)`
`void`	`shutdown()` Shuts down the whole job executor
`void`	`start()` Starts the async executor
`protected void`	`startExecutingAsyncJobs()`
`protected void`	`startJobAcquisitionThread()` Starts the acquisition thread
`protected void`	`stopExecutingAsyncJobs()`
`protected void`	`stopJobAcquisitionThread()` Stops the acquisition thread

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - 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
  - 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
  - timerJobAcquisitionThread
```
protected Thread timerJobAcquisitionThread
```
  - asyncJobAcquisitionThread
```
protected Thread asyncJobAcquisitionThread
```
  - timerJobRunnable
```
protected AcquireTimerJobsRunnable timerJobRunnable
```
  - asyncJobsDueRunnable
```
protected AcquireAsyncJobsDueRunnable asyncJobsDueRunnable
```
  - isAutoActivate
```
protected boolean isAutoActivate
```
  - isActive
```
protected boolean isActive
```
  - maxTimerJobsPerAcquisition
```
protected int maxTimerJobsPerAcquisition
```
  - maxAsyncJobsDuePerAcquisition
```
protected int maxAsyncJobsDuePerAcquisition
```
  - defaultTimerJobAcquireWaitTimeInMillis
```
protected int defaultTimerJobAcquireWaitTimeInMillis
```
  - defaultAsyncJobAcquireWaitTimeInMillis
```
protected int defaultAsyncJobAcquireWaitTimeInMillis
```
  - lockOwner
```
protected String lockOwner
```
  - timerLockTimeInMillis
```
protected int timerLockTimeInMillis
```
  - asyncJobLockTimeInMillis
```
protected int asyncJobLockTimeInMillis
```
  - retryWaitTimeInMillis
```
protected int retryWaitTimeInMillis
```
  - temporaryJobQueue
```
protected LinkedList<JobEntity> temporaryJobQueue
```
  - commandExecutor
```
protected CommandExecutor commandExecutor
```
- Constructor Detail
  - DefaultAsyncJobExecutor
```
public DefaultAsyncJobExecutor()
```
- Method Detail
  - executeAsyncJob
```
public void executeAsyncJob(JobEntity job)
```
    Specified by:
    
    executeAsyncJob in interface AsyncExecutor
  - start
```
public void start()
```
    Starts the async executor
    
    Specified by:
    
    start in interface AsyncExecutor
  - shutdown
```
public void shutdown()
```
    Shuts down the whole job executor
    
    Specified by:
    
    shutdown in interface AsyncExecutor
  - startExecutingAsyncJobs
```
protected void startExecutingAsyncJobs()
```
  - stopExecutingAsyncJobs
```
protected void stopExecutingAsyncJobs()
```
  - startJobAcquisitionThread
```
protected void startJobAcquisitionThread()
```
    Starts the acquisition thread
  - stopJobAcquisitionThread
```
protected void stopJobAcquisitionThread()
```
    Stops the acquisition thread
  - getCommandExecutor
```
public CommandExecutor getCommandExecutor()
```
    Specified by:
    
    getCommandExecutor in interface AsyncExecutor
  - setCommandExecutor
```
public void setCommandExecutor(CommandExecutor commandExecutor)
```
    Specified by:
    
    setCommandExecutor 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
  - getQueueSize
```
public int getQueueSize()
```
  - 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)
```
  - getThreadPoolQueue
```
public BlockingQueue<Runnable> getThreadPoolQueue()
```
  - setThreadPoolQueue
```
public void setThreadPoolQueue(BlockingQueue<Runnable> threadPoolQueue)
```
  - getExecutorService
```
public ExecutorService getExecutorService()
```
  - setExecutorService
```
public void setExecutorService(ExecutorService executorService)
```
  - 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
  - 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)
```
  - setAsyncJobsDueRunnable
```
public void setAsyncJobsDueRunnable(AcquireAsyncJobsDueRunnable asyncJobsDueRunnable)
```
  - getRetryWaitTimeInMillis
```
public int getRetryWaitTimeInMillis()
```
    Specified by:
    
    getRetryWaitTimeInMillis in interface AsyncExecutor
  - setRetryWaitTimeInMillis
```
public void setRetryWaitTimeInMillis(int retryWaitTimeInMillis)
```
    Specified by:
    
    setRetryWaitTimeInMillis in interface AsyncExecutor

Class DefaultAsyncJobExecutor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

corePoolSize

maxPoolSize

keepAliveTime

queueSize

threadPoolQueue

executorService

secondsToWaitOnShutdown

timerJobAcquisitionThread

asyncJobAcquisitionThread

timerJobRunnable

asyncJobsDueRunnable

isAutoActivate

isActive

maxTimerJobsPerAcquisition

maxAsyncJobsDuePerAcquisition

defaultTimerJobAcquireWaitTimeInMillis

defaultAsyncJobAcquireWaitTimeInMillis

lockOwner

timerLockTimeInMillis

asyncJobLockTimeInMillis

retryWaitTimeInMillis

temporaryJobQueue

commandExecutor

Constructor Detail

DefaultAsyncJobExecutor

Method Detail

executeAsyncJob

start

shutdown

startExecutingAsyncJobs

stopExecutingAsyncJobs

startJobAcquisitionThread

stopJobAcquisitionThread

getCommandExecutor

setCommandExecutor

isAutoActivate

setAutoActivate

isActive

getQueueSize

setQueueSize

getCorePoolSize

setCorePoolSize

getMaxPoolSize

setMaxPoolSize

getKeepAliveTime

setKeepAliveTime

getSecondsToWaitOnShutdown

setSecondsToWaitOnShutdown

getThreadPoolQueue

setThreadPoolQueue

getExecutorService

setExecutorService

getLockOwner

setLockOwner

getTimerLockTimeInMillis

setTimerLockTimeInMillis

getAsyncJobLockTimeInMillis

setAsyncJobLockTimeInMillis

getMaxTimerJobsPerAcquisition

setMaxTimerJobsPerAcquisition

getMaxAsyncJobsDuePerAcquisition

setMaxAsyncJobsDuePerAcquisition

getDefaultTimerJobAcquireWaitTimeInMillis

setDefaultTimerJobAcquireWaitTimeInMillis

getDefaultAsyncJobAcquireWaitTimeInMillis

setDefaultAsyncJobAcquireWaitTimeInMillis

setTimerJobRunnable

setAsyncJobsDueRunnable

getRetryWaitTimeInMillis

setRetryWaitTimeInMillis