spring-context

org.springframework.scheduling.concurrent
Class ScheduledExecutorFactoryBean

java.lang.Object
  extended by org.springframework.util.CustomizableThreadCreator
      extended by org.springframework.scheduling.concurrent.CustomizableThreadFactory
          extended by org.springframework.scheduling.concurrent.ExecutorConfigurationSupport
              extended by org.springframework.scheduling.concurrent.ScheduledExecutorFactoryBean
All Implemented Interfaces:
java.io.Serializable, java.util.concurrent.ThreadFactory, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<java.util.concurrent.ScheduledExecutorService>, org.springframework.beans.factory.InitializingBean

public class ScheduledExecutorFactoryBean
extends ExecutorConfigurationSupport
implements org.springframework.beans.factory.FactoryBean<java.util.concurrent.ScheduledExecutorService>

FactoryBean that sets up a JDK 1.5 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 just require static registration of tasks at startup, there is no need to access the ScheduledExecutorService instance itself in application code.

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".

Since:
2.0
Author:
Juergen Hoeller
See Also:
setPoolSize(int), ExecutorConfigurationSupport.setThreadFactory(java.util.concurrent.ThreadFactory), ScheduledExecutorTask, ScheduledExecutorService, ScheduledThreadPoolExecutor, Serialized Form

Field Summary
 
Fields inherited from class org.springframework.scheduling.concurrent.ExecutorConfigurationSupport
logger
 
Constructor Summary
ScheduledExecutorFactoryBean()
           
 
Method Summary
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 setScheduledExecutorTasks(ScheduledExecutorTask[] scheduledExecutorTasks)
          Register a list of ScheduledExecutorTask objects with the ScheduledExecutorService that this FactoryBean creates.
 
Methods inherited from class org.springframework.scheduling.concurrent.ExecutorConfigurationSupport
afterPropertiesSet, destroy, initialize, setBeanName, setRejectedExecutionHandler, setThreadFactory, setThreadNamePrefix, setWaitForTasksToCompleteOnShutdown, shutdown
 
Methods inherited from class org.springframework.scheduling.concurrent.CustomizableThreadFactory
newThread
 
Methods inherited from class org.springframework.util.CustomizableThreadCreator
createThread, getDefaultThreadNamePrefix, getThreadGroup, getThreadNamePrefix, getThreadPriority, isDaemon, nextThreadName, setDaemon, setThreadGroup, setThreadGroupName, setThreadPriority
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ScheduledExecutorFactoryBean

public ScheduledExecutorFactoryBean()
Method Detail

setPoolSize

public void setPoolSize(int poolSize)
Set the ScheduledExecutorService's pool size. Default is 1.


setScheduledExecutorTasks

public void setScheduledExecutorTasks(ScheduledExecutorTask[] scheduledExecutorTasks)
Register a list of ScheduledExecutorTask objects with the ScheduledExecutorService that this FactoryBean creates. Depending on each ScheduledExecutorTask's settings, it will be registered via one of ScheduledExecutorService's schedule methods.

See Also:
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)

setContinueScheduledExecutionAfterException

public void setContinueScheduledExecutionAfterException(boolean continueScheduledExecutionAfterException)
Specify whether to continue the execution of a scheduled task after it threw an exception.

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.

See Also:
ScheduledExecutorService.scheduleAtFixedRate(java.lang.Runnable, long, long, java.util.concurrent.TimeUnit)

setExposeUnconfigurableExecutor

public void setExposeUnconfigurableExecutor(boolean exposeUnconfigurableExecutor)
Specify whether this FactoryBean should expose an unconfigurable decorator for the created executor.

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.

See Also:
Executors.unconfigurableScheduledExecutorService(java.util.concurrent.ScheduledExecutorService)

initializeExecutor

protected java.util.concurrent.ExecutorService initializeExecutor(java.util.concurrent.ThreadFactory threadFactory,
                                                                  java.util.concurrent.RejectedExecutionHandler rejectedExecutionHandler)
Description copied from class: ExecutorConfigurationSupport
Create the target ExecutorService instance. Called by afterPropertiesSet.

Specified by:
initializeExecutor in class ExecutorConfigurationSupport
Parameters:
threadFactory - the ThreadFactory to use
rejectedExecutionHandler - the RejectedExecutionHandler to use
Returns:
a new ExecutorService instance
See Also:
ExecutorConfigurationSupport.afterPropertiesSet()

createExecutor

protected java.util.concurrent.ScheduledExecutorService createExecutor(int poolSize,
                                                                       java.util.concurrent.ThreadFactory threadFactory,
                                                                       java.util.concurrent.RejectedExecutionHandler rejectedExecutionHandler)
Create a new ScheduledExecutorService instance.

The default implementation creates a ScheduledThreadPoolExecutor. Can be overridden in subclasses to provide custom ScheduledExecutorService instances.

Parameters:
poolSize - the specified pool size
threadFactory - the ThreadFactory to use
rejectedExecutionHandler - the RejectedExecutionHandler to use
Returns:
a new ScheduledExecutorService instance
See Also:
ExecutorConfigurationSupport.afterPropertiesSet(), ScheduledThreadPoolExecutor

registerTasks

protected void registerTasks(ScheduledExecutorTask[] tasks,
                             java.util.concurrent.ScheduledExecutorService executor)
Register the specified ScheduledExecutorTasks on the given ScheduledExecutorService.

Parameters:
tasks - the specified ScheduledExecutorTasks (never empty)
executor - the ScheduledExecutorService to register the tasks on.

getRunnableToSchedule

protected java.lang.Runnable getRunnableToSchedule(ScheduledExecutorTask task)
Determine the actual Runnable to schedule for the given 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.

Parameters:
task - the ScheduledExecutorTask to schedule
Returns:
the actual Runnable to schedule (may be a decorator)

getObject

public java.util.concurrent.ScheduledExecutorService getObject()
Specified by:
getObject in interface org.springframework.beans.factory.FactoryBean<java.util.concurrent.ScheduledExecutorService>

getObjectType

public java.lang.Class<? extends java.util.concurrent.ScheduledExecutorService> getObjectType()
Specified by:
getObjectType in interface org.springframework.beans.factory.FactoryBean<java.util.concurrent.ScheduledExecutorService>

isSingleton

public boolean isSingleton()
Specified by:
isSingleton in interface org.springframework.beans.factory.FactoryBean<java.util.concurrent.ScheduledExecutorService>

spring-context