Interface AsyncExecutor
- All Known Subinterfaces:
TenantAwareAsyncExecutor
- All Known Implementing Classes:
AbstractAsyncExecutor,DefaultAsyncHistoryJobExecutor,DefaultAsyncJobExecutor,ExecutorPerTenantAsyncExecutor,ManagedAsyncJobExecutor,SharedExecutorServiceAsyncExecutor
public interface AsyncExecutor
- Author:
- Tijd Rademakers, Joram Barrez
-
Method Summary
Modifier and TypeMethodDescriptionbooleanexecuteAsyncJob(JobInfo job) Offers the providedJobInfoto thisAsyncExecutorinstance to execute.intintintintintintintintintDeprecated.no longer usedThe optional task executor for the async executorintbooleanisActive()booleanvoidsetAsyncJobLockTimeInMillis(int lockTimeInMillis) voidsetAutoActivate(boolean isAutoActivate) voidsetDefaultAsyncJobAcquireWaitTimeInMillis(int waitTimeInMillis) voidsetDefaultQueueSizeFullWaitTimeInMillis(int defaultQueueSizeFullWaitTimeInMillis) voidsetDefaultTimerJobAcquireWaitTimeInMillis(int waitTimeInMillis) voidsetJobServiceConfiguration(JobServiceConfiguration jobServiceConfiguration) voidsetMaxAsyncJobsDuePerAcquisition(int maxJobs) voidsetMaxTimerJobsPerAcquisition(int maxJobs) voidsetResetExpiredJobsInterval(int resetExpiredJobsInterval) voidsetResetExpiredJobsPageSize(int resetExpiredJobsPageSize) voidsetRetryWaitTimeInMillis(int retryWaitTimeInMillis) Deprecated.no longer usedvoidsetTaskExecutor(AsyncTaskExecutor taskExecutor) Set the task executor for this async executor.voidsetTimerLockTimeInMillis(int lockTimeInMillis) voidshutdown()Stops executing jobs.voidstart()Starts the Async Executor: jobs will be acquired and executed.
-
Method Details
-
start
void start()Starts the Async Executor: jobs will be acquired and executed. -
shutdown
void shutdown()Stops executing jobs. -
executeAsyncJob
Offers the providedJobInfoto thisAsyncExecutorinstance to execute. If the offering does not work for some reason, false will be returned (For example when the job queue is full in theDefaultAsyncJobExecutor). -
setJobServiceConfiguration
-
getJobServiceConfiguration
JobServiceConfiguration getJobServiceConfiguration() -
isAutoActivate
boolean isAutoActivate() -
setAutoActivate
void setAutoActivate(boolean isAutoActivate) -
isActive
boolean isActive() -
getLockOwner
String getLockOwner() -
getTimerLockTimeInMillis
int getTimerLockTimeInMillis() -
setTimerLockTimeInMillis
void setTimerLockTimeInMillis(int lockTimeInMillis) -
getAsyncJobLockTimeInMillis
int getAsyncJobLockTimeInMillis() -
setAsyncJobLockTimeInMillis
void setAsyncJobLockTimeInMillis(int lockTimeInMillis) -
getDefaultTimerJobAcquireWaitTimeInMillis
int getDefaultTimerJobAcquireWaitTimeInMillis() -
setDefaultTimerJobAcquireWaitTimeInMillis
void setDefaultTimerJobAcquireWaitTimeInMillis(int waitTimeInMillis) -
getDefaultAsyncJobAcquireWaitTimeInMillis
int getDefaultAsyncJobAcquireWaitTimeInMillis() -
setDefaultAsyncJobAcquireWaitTimeInMillis
void setDefaultAsyncJobAcquireWaitTimeInMillis(int waitTimeInMillis) -
getDefaultQueueSizeFullWaitTimeInMillis
int getDefaultQueueSizeFullWaitTimeInMillis() -
setDefaultQueueSizeFullWaitTimeInMillis
void setDefaultQueueSizeFullWaitTimeInMillis(int defaultQueueSizeFullWaitTimeInMillis) -
getMaxAsyncJobsDuePerAcquisition
int getMaxAsyncJobsDuePerAcquisition() -
setMaxAsyncJobsDuePerAcquisition
void setMaxAsyncJobsDuePerAcquisition(int maxJobs) -
getMaxTimerJobsPerAcquisition
int getMaxTimerJobsPerAcquisition() -
setMaxTimerJobsPerAcquisition
void setMaxTimerJobsPerAcquisition(int maxJobs) -
getRetryWaitTimeInMillis
Deprecated.no longer used -
setRetryWaitTimeInMillis
Deprecated.no longer used -
getResetExpiredJobsInterval
int getResetExpiredJobsInterval() -
setResetExpiredJobsInterval
void setResetExpiredJobsInterval(int resetExpiredJobsInterval) -
getResetExpiredJobsPageSize
int getResetExpiredJobsPageSize() -
setResetExpiredJobsPageSize
void setResetExpiredJobsPageSize(int resetExpiredJobsPageSize) -
getTaskExecutor
AsyncTaskExecutor getTaskExecutor()The optional task executor for the async executor- Returns:
- the task executor used by this async executor
-
setTaskExecutor
Set the task executor for this async executor.- Parameters:
taskExecutor-
-