public class ScheduledExecutorFactoryBean extends ExecutorConfigurationSupport implements org.springframework.beans.factory.FactoryBean<java.util.concurrent.ScheduledExecutorService>
FactoryBean that sets up
a ScheduledExecutorService
(by default: a ScheduledThreadPoolExecutor)
and exposes it for bean references.
Allows for registration of ScheduledExecutorTasks,
automatically starting the ScheduledExecutorService on initialization and
cancelling it on destruction of the context. In scenarios that only require static
registration of tasks at startup, there is no need to access the
ScheduledExecutorService instance itself in application code at all;
ScheduledExecutorFactoryBean is then just being used for lifecycle integration.
For an alternative, you may set up a ScheduledThreadPoolExecutor instance
directly using constructor injection, or use a factory method definition that points
to the Executors class.
This is strongly recommended in particular for common @Bean methods in
configuration classes, where this FactoryBean variant would force you to
return the FactoryBean type instead of ScheduledExecutorService.
Note that ScheduledExecutorService
uses a Runnable instance that is shared between repeated executions,
in contrast to Quartz which instantiates a new Job for each execution.
WARNING: Runnables submitted via a native
ScheduledExecutorService are removed from
the execution schedule once they throw an exception. If you would prefer
to continue execution after such an exception, switch this FactoryBean's
"continueScheduledExecutionAfterException"
property to "true".
setPoolSize(int),
setRemoveOnCancelPolicy(boolean),
ExecutorConfigurationSupport.setThreadFactory(java.util.concurrent.ThreadFactory),
ScheduledExecutorTask,
ScheduledExecutorService,
ScheduledThreadPoolExecutor,
Serialized Formlogger| Constructor and Description |
|---|
ScheduledExecutorFactoryBean() |
| Modifier and Type | Method and Description |
|---|---|
protected java.util.concurrent.ScheduledExecutorService |
createExecutor(int poolSize,
java.util.concurrent.ThreadFactory threadFactory,
java.util.concurrent.RejectedExecutionHandler rejectedExecutionHandler)
Create a new
ScheduledExecutorService instance. |
java.util.concurrent.ScheduledExecutorService |
getObject() |
java.lang.Class<? extends java.util.concurrent.ScheduledExecutorService> |
getObjectType() |
protected java.lang.Runnable |
getRunnableToSchedule(ScheduledExecutorTask task)
Determine the actual Runnable to schedule for the given task.
|
protected java.util.concurrent.ExecutorService |
initializeExecutor(java.util.concurrent.ThreadFactory threadFactory,
java.util.concurrent.RejectedExecutionHandler rejectedExecutionHandler)
Create the target
ExecutorService instance. |
boolean |
isSingleton() |
protected void |
registerTasks(ScheduledExecutorTask[] tasks,
java.util.concurrent.ScheduledExecutorService executor)
Register the specified
ScheduledExecutorTasks
on the given ScheduledExecutorService. |
void |
setContinueScheduledExecutionAfterException(boolean continueScheduledExecutionAfterException)
Specify whether to continue the execution of a scheduled task
after it threw an exception.
|
void |
setExposeUnconfigurableExecutor(boolean exposeUnconfigurableExecutor)
Specify whether this FactoryBean should expose an unconfigurable
decorator for the created executor.
|
void |
setPoolSize(int poolSize)
Set the ScheduledExecutorService's pool size.
|
void |
setRemoveOnCancelPolicy(boolean removeOnCancelPolicy)
Set the remove-on-cancel mode on
ScheduledThreadPoolExecutor (JDK 7+). |
void |
setScheduledExecutorTasks(ScheduledExecutorTask... scheduledExecutorTasks)
Register a list of ScheduledExecutorTask objects with the ScheduledExecutorService
that this FactoryBean creates.
|
afterPropertiesSet, destroy, initialize, setAwaitTerminationSeconds, setBeanName, setRejectedExecutionHandler, setThreadFactory, setThreadNamePrefix, setWaitForTasksToCompleteOnShutdown, shutdownnewThreadpublic void setPoolSize(int poolSize)
public void setScheduledExecutorTasks(ScheduledExecutorTask... scheduledExecutorTasks)
ScheduledExecutorService.schedule(java.lang.Runnable, long, java.util.concurrent.TimeUnit),
ScheduledExecutorService.scheduleWithFixedDelay(java.lang.Runnable, long, long, java.util.concurrent.TimeUnit),
ScheduledExecutorService.scheduleAtFixedRate(java.lang.Runnable, long, long, java.util.concurrent.TimeUnit)public void setRemoveOnCancelPolicy(boolean removeOnCancelPolicy)
ScheduledThreadPoolExecutor (JDK 7+).
Default is false. If set to true, the target executor will be
switched into remove-on-cancel mode (if possible, with a soft fallback otherwise).
public void setContinueScheduledExecutionAfterException(boolean continueScheduledExecutionAfterException)
Default is "false", matching the native behavior of a
ScheduledExecutorService.
Switch this flag to "true" for exception-proof execution of each task,
continuing scheduled execution as in the case of successful execution.
ScheduledExecutorService.scheduleAtFixedRate(java.lang.Runnable, long, long, java.util.concurrent.TimeUnit)public void setExposeUnconfigurableExecutor(boolean exposeUnconfigurableExecutor)
Default is "false", exposing the raw executor as bean reference. Switch this flag to "true" to strictly prevent clients from modifying the executor's configuration.
Executors.unconfigurableScheduledExecutorService(java.util.concurrent.ScheduledExecutorService)@UsesJava7
protected java.util.concurrent.ExecutorService initializeExecutor(java.util.concurrent.ThreadFactory threadFactory,
java.util.concurrent.RejectedExecutionHandler rejectedExecutionHandler)
ExecutorConfigurationSupportExecutorService instance.
Called by afterPropertiesSet.initializeExecutor in class ExecutorConfigurationSupportthreadFactory - the ThreadFactory to userejectedExecutionHandler - the RejectedExecutionHandler to useExecutorConfigurationSupport.afterPropertiesSet()protected java.util.concurrent.ScheduledExecutorService createExecutor(int poolSize,
java.util.concurrent.ThreadFactory threadFactory,
java.util.concurrent.RejectedExecutionHandler rejectedExecutionHandler)
ScheduledExecutorService instance.
The default implementation creates a ScheduledThreadPoolExecutor.
Can be overridden in subclasses to provide custom ScheduledExecutorService instances.
poolSize - the specified pool sizethreadFactory - the ThreadFactory to userejectedExecutionHandler - the RejectedExecutionHandler to useExecutorConfigurationSupport.afterPropertiesSet(),
ScheduledThreadPoolExecutorprotected void registerTasks(ScheduledExecutorTask[] tasks, java.util.concurrent.ScheduledExecutorService executor)
ScheduledExecutorTasks
on the given ScheduledExecutorService.tasks - the specified ScheduledExecutorTasks (never empty)executor - the ScheduledExecutorService to register the tasks on.protected java.lang.Runnable getRunnableToSchedule(ScheduledExecutorTask task)
Wraps the task's Runnable in a
DelegatingErrorHandlingRunnable
that will catch and log the Exception. If necessary, it will suppress the
Exception according to the
"continueScheduledExecutionAfterException"
flag.
task - the ScheduledExecutorTask to schedulepublic java.util.concurrent.ScheduledExecutorService getObject()
getObject in interface org.springframework.beans.factory.FactoryBean<java.util.concurrent.ScheduledExecutorService>public java.lang.Class<? extends java.util.concurrent.ScheduledExecutorService> getObjectType()
getObjectType in interface org.springframework.beans.factory.FactoryBean<java.util.concurrent.ScheduledExecutorService>public boolean isSingleton()
isSingleton in interface org.springframework.beans.factory.FactoryBean<java.util.concurrent.ScheduledExecutorService>