java.lang.Object
- org.springframework.util.CustomizableThreadCreator
- - org.springframework.scheduling.concurrent.CustomizableThreadFactory
  - - org.springframework.scheduling.concurrent.ExecutorConfigurationSupport
    - - org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler

All Implemented Interfaces:
Serializable, Executor, ThreadFactory, Aware, BeanNameAware, DisposableBean, InitializingBean, AsyncListenableTaskExecutor, AsyncTaskExecutor, TaskExecutor, SchedulingTaskExecutor, TaskScheduler
```
public class ThreadPoolTaskScheduler
extends ExecutorConfigurationSupport
implements AsyncListenableTaskExecutor, SchedulingTaskExecutor, TaskScheduler
```
Implementation of Spring's TaskScheduler interface, wrapping a native ScheduledThreadPoolExecutor.
Since:
3.0
Author:
Juergen Hoeller, Mark Fisher
See Also:
setPoolSize(int), setRemoveOnCancelPolicy(boolean), ExecutorConfigurationSupport.setThreadFactory(java.util.concurrent.ThreadFactory), setErrorHandler(org.springframework.util.ErrorHandler), Serialized Form

Field Summary
- Fields inherited from class org.springframework.scheduling.concurrent.ExecutorConfigurationSupport
  logger
- Fields inherited from interface org.springframework.core.task.AsyncTaskExecutor
  TIMEOUT_IMMEDIATE, TIMEOUT_INDEFINITE

Constructor Summary
Constructors
Constructor Description
ThreadPoolTaskScheduler()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`cancelRemainingTask(Runnable task)`	Cancel the given remaining task which never commended execution, as returned from `ExecutorService.shutdownNow()`.
`protected ScheduledExecutorService`	`createExecutor(int poolSize, ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler)`	Create a new `ScheduledExecutorService` instance.
`void`	`execute(Runnable task)`	Execute the given `task`.
`void`	`execute(Runnable task, long startTimeout)`	Execute the given `task`.
`int`	`getActiveCount()`	Return the number of currently active threads.
`int`	`getPoolSize()`	Return the current pool size.
`ScheduledExecutorService`	`getScheduledExecutor()`	Return the underlying ScheduledExecutorService for native access.
`ScheduledThreadPoolExecutor`	`getScheduledThreadPoolExecutor()`	Return the underlying ScheduledThreadPoolExecutor, if available.
`protected ExecutorService`	`initializeExecutor(ThreadFactory threadFactory, RejectedExecutionHandler rejectedExecutionHandler)`	Create the target `ExecutorService` instance.
`boolean`	`isRemoveOnCancelPolicy()`	Return the current setting for the remove-on-cancel mode.
`ScheduledFuture<?>`	`schedule(Runnable task, Date startTime)`	Schedule the given `Runnable`, invoking it at the specified execution time.
`ScheduledFuture<?>`	`schedule(Runnable task, Trigger trigger)`	Schedule the given `Runnable`, invoking it whenever the trigger indicates a next execution time.
`ScheduledFuture<?>`	`scheduleAtFixedRate(Runnable task, long period)`	Schedule the given `Runnable`, starting as soon as possible and invoking it with the given period.
`ScheduledFuture<?>`	`scheduleAtFixedRate(Runnable task, Date startTime, long period)`	Schedule the given `Runnable`, invoking it at the specified execution time and subsequently with the given period.
`ScheduledFuture<?>`	`scheduleWithFixedDelay(Runnable task, long delay)`	Schedule the given `Runnable`, starting as soon as possible and invoking it with the given delay between the completion of one execution and the start of the next.
`ScheduledFuture<?>`	`scheduleWithFixedDelay(Runnable task, Date startTime, long delay)`	Schedule the given `Runnable`, invoking it at the specified execution time and subsequently with the given delay between the completion of one execution and the start of the next.
`void`	`setErrorHandler(ErrorHandler errorHandler)`	Set a custom `ErrorHandler` strategy.
`void`	`setPoolSize(int poolSize)`	Set the ScheduledExecutorService's pool size.
`void`	`setRemoveOnCancelPolicy(boolean removeOnCancelPolicy)`	Set the remove-on-cancel mode on `ScheduledThreadPoolExecutor`.
`Future<?>`	`submit(Runnable task)`	Submit a Runnable task for execution, receiving a Future representing that task.
`<T> Future<T>`	`submit(Callable<T> task)`	Submit a Callable task for execution, receiving a Future representing that task.
`ListenableFuture<?>`	`submitListenable(Runnable task)`	Submit a `Runnable` task for execution, receiving a `ListenableFuture` representing that task.
`<T> ListenableFuture<T>`	`submitListenable(Callable<T> task)`	Submit a `Callable` task for execution, receiving a `ListenableFuture` representing that task.

Methods inherited from class org.springframework.scheduling.concurrent.ExecutorConfigurationSupport
afterPropertiesSet, destroy, initialize, setAwaitTerminationMillis, setAwaitTerminationSeconds, 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

Methods inherited from interface org.springframework.scheduling.SchedulingTaskExecutor
prefersShortLivedTasks

Methods inherited from interface org.springframework.scheduling.TaskScheduler
schedule, scheduleAtFixedRate, scheduleAtFixedRate, scheduleWithFixedDelay, scheduleWithFixedDelay

- Constructor Detail
  - ThreadPoolTaskScheduler
```
public ThreadPoolTaskScheduler()
```
- Method Detail
  - setPoolSize
```
public void setPoolSize(int poolSize)
```
    Set the ScheduledExecutorService's pool size. Default is 1.
    This setting can be modified at runtime, for example through JMX.
  - setRemoveOnCancelPolicy
```
public void setRemoveOnCancelPolicy(boolean removeOnCancelPolicy)
```
    Set the remove-on-cancel mode on ScheduledThreadPoolExecutor.
    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).
    This setting can be modified at runtime, for example through JMX.
  - setErrorHandler
```
public void setErrorHandler(ErrorHandler errorHandler)
```
    Set a custom ErrorHandler strategy.
  - initializeExecutor
```
protected ExecutorService initializeExecutor(ThreadFactory threadFactory,
                                             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 ScheduledExecutorService createExecutor(int poolSize,
                                                  ThreadFactory threadFactory,
                                                  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
  - getScheduledExecutor
```
public ScheduledExecutorService getScheduledExecutor()
                                              throws IllegalStateException
```
    Return the underlying ScheduledExecutorService for native access.
    Returns:
    the underlying ScheduledExecutorService (never null)
    Throws:
    IllegalStateException - if the ThreadPoolTaskScheduler hasn't been initialized yet
  - getScheduledThreadPoolExecutor
```
public ScheduledThreadPoolExecutor getScheduledThreadPoolExecutor()
                                                           throws IllegalStateException
```
    Return the underlying ScheduledThreadPoolExecutor, if available.
    Returns:
    the underlying ScheduledExecutorService (never null)
    Throws:
    IllegalStateException - if the ThreadPoolTaskScheduler hasn't been initialized yet or if the underlying ScheduledExecutorService isn't a ScheduledThreadPoolExecutor
    See Also:
    getScheduledExecutor()
  - getPoolSize
```
public int getPoolSize()
```
    Return the current pool size.
    Requires an underlying ScheduledThreadPoolExecutor.
    See Also:
    getScheduledThreadPoolExecutor(), ThreadPoolExecutor.getPoolSize()
  - isRemoveOnCancelPolicy
```
public boolean isRemoveOnCancelPolicy()
```
    Return the current setting for the remove-on-cancel mode.
    Requires an underlying ScheduledThreadPoolExecutor.
  - getActiveCount
```
public int getActiveCount()
```
    Return the number of currently active threads.
    Requires an underlying ScheduledThreadPoolExecutor.
    See Also:
    getScheduledThreadPoolExecutor(), ThreadPoolExecutor.getActiveCount()
  - execute
```
public void execute(Runnable task)
```
    Description copied from interface: TaskExecutor
    Execute the given task.
    The call might return immediately if the implementation uses an asynchronous execution strategy, or might block in the case of synchronous execution.
    Specified by:
    execute in interface Executor
    Specified by:
    execute in interface TaskExecutor
    Parameters:
    task - the Runnable to execute (never null)
  - execute
```
public void execute(Runnable task,
                    long startTimeout)
```
    Description copied from interface: AsyncTaskExecutor
    Execute the given task.
    Specified by:
    execute in interface AsyncTaskExecutor
    Parameters:
    task - the Runnable to execute (never null)
    startTimeout - the time duration (milliseconds) within which the task is supposed to start. This is intended as a hint to the executor, allowing for preferred handling of immediate tasks. Typical values are AsyncTaskExecutor.TIMEOUT_IMMEDIATE or AsyncTaskExecutor.TIMEOUT_INDEFINITE (the default as used by TaskExecutor.execute(Runnable)).
  - submit
```
public Future<?> submit(Runnable task)
```
    Description copied from interface: AsyncTaskExecutor
    Submit a Runnable task for execution, receiving a Future representing that task. The Future will return a null result upon completion.
    Specified by:
    submit in interface AsyncTaskExecutor
    Parameters:
    task - the Runnable to execute (never null)
    Returns:
    a Future representing pending completion of the task
  - submit
```
public <T> Future<T> submit(Callable<T> task)
```
    Description copied from interface: AsyncTaskExecutor
    Submit a Callable task for execution, receiving a Future representing that task. The Future will return the Callable's result upon completion.
    Specified by:
    submit in interface AsyncTaskExecutor
    Parameters:
    task - the Callable to execute (never null)
    Returns:
    a Future representing pending completion of the task
  - submitListenable
```
public ListenableFuture<?> submitListenable(Runnable task)
```
    Description copied from interface: AsyncListenableTaskExecutor
    Submit a Runnable task for execution, receiving a ListenableFuture representing that task. The Future will return a null result upon completion.
    Specified by:
    submitListenable in interface AsyncListenableTaskExecutor
    Parameters:
    task - the Runnable to execute (never null)
    Returns:
    a ListenableFuture representing pending completion of the task
  - submitListenable
```
public <T> ListenableFuture<T> submitListenable(Callable<T> task)
```
    Description copied from interface: AsyncListenableTaskExecutor
    Submit a Callable task for execution, receiving a ListenableFuture representing that task. The Future will return the Callable's result upon completion.
    Specified by:
    submitListenable in interface AsyncListenableTaskExecutor
    Parameters:
    task - the Callable to execute (never null)
    Returns:
    a ListenableFuture representing pending completion of the task
  - cancelRemainingTask
```
protected void cancelRemainingTask(Runnable task)
```
    Description copied from class: ExecutorConfigurationSupport
    Cancel the given remaining task which never commended execution, as returned from ExecutorService.shutdownNow().
    Overrides:
    cancelRemainingTask in class ExecutorConfigurationSupport
    Parameters:
    task - the task to cancel (typically a RunnableFuture)
    See Also:
    ExecutorConfigurationSupport.shutdown(), Future.cancel(boolean)
  - schedule
```
@Nullable
public ScheduledFuture<?> schedule(Runnable task,
                                   Trigger trigger)
```
    Description copied from interface: TaskScheduler
    Schedule the given Runnable, invoking it whenever the trigger indicates a next execution time.
    Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.
    Specified by:
    schedule in interface TaskScheduler
    Parameters:
    task - the Runnable to execute whenever the trigger fires
    trigger - an implementation of the Trigger interface, e.g. a CronTrigger object wrapping a cron expression
    Returns:
    a ScheduledFuture representing pending completion of the task, or null if the given Trigger object never fires (i.e. returns null from Trigger.nextExecutionTime(org.springframework.scheduling.TriggerContext))
    See Also:
    CronTrigger
  - schedule
```
public ScheduledFuture<?> schedule(Runnable task,
                                   Date startTime)
```
    Description copied from interface: TaskScheduler
    Schedule the given Runnable, invoking it at the specified execution time.
    Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.
    Specified by:
    schedule in interface TaskScheduler
    Parameters:
    task - the Runnable to execute whenever the trigger fires
    startTime - the desired execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible)
    Returns:
    a ScheduledFuture representing pending completion of the task
  - scheduleAtFixedRate
```
public ScheduledFuture<?> scheduleAtFixedRate(Runnable task,
                                              Date startTime,
                                              long period)
```
    Description copied from interface: TaskScheduler
    Schedule the given Runnable, invoking it at the specified execution time and subsequently with the given period.
    Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.
    Specified by:
    scheduleAtFixedRate in interface TaskScheduler
    Parameters:
    task - the Runnable to execute whenever the trigger fires
    startTime - the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible)
    period - the interval between successive executions of the task (in milliseconds)
    Returns:
    a ScheduledFuture representing pending completion of the task
  - scheduleAtFixedRate
```
public ScheduledFuture<?> scheduleAtFixedRate(Runnable task,
                                              long period)
```
    Description copied from interface: TaskScheduler
    Schedule the given Runnable, starting as soon as possible and invoking it with the given period.
    Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.
    Specified by:
    scheduleAtFixedRate in interface TaskScheduler
    Parameters:
    task - the Runnable to execute whenever the trigger fires
    period - the interval between successive executions of the task (in milliseconds)
    Returns:
    a ScheduledFuture representing pending completion of the task
  - scheduleWithFixedDelay
```
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable task,
                                                 Date startTime,
                                                 long delay)
```
    Description copied from interface: TaskScheduler
    Schedule the given Runnable, invoking it at the specified execution time and subsequently with the given delay between the completion of one execution and the start of the next.
    Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.
    Specified by:
    scheduleWithFixedDelay in interface TaskScheduler
    Parameters:
    task - the Runnable to execute whenever the trigger fires
    startTime - the desired first execution time for the task (if this is in the past, the task will be executed immediately, i.e. as soon as possible)
    delay - the delay between the completion of one execution and the start of the next (in milliseconds)
    Returns:
    a ScheduledFuture representing pending completion of the task
  - scheduleWithFixedDelay
```
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable task,
                                                 long delay)
```
    Description copied from interface: TaskScheduler
    Schedule the given Runnable, starting as soon as possible and invoking it with the given delay between the completion of one execution and the start of the next.
    Execution will end once the scheduler shuts down or the returned ScheduledFuture gets cancelled.
    Specified by:
    scheduleWithFixedDelay in interface TaskScheduler
    Parameters:
    task - the Runnable to execute whenever the trigger fires
    delay - the delay between the completion of one execution and the start of the next (in milliseconds)
    Returns:
    a ScheduledFuture representing pending completion of the task

Class ThreadPoolTaskScheduler

Field Summary

Fields inherited from class org.springframework.scheduling.concurrent.ExecutorConfigurationSupport

Fields inherited from interface org.springframework.core.task.AsyncTaskExecutor

Constructor Summary

Method Summary

Methods inherited from class org.springframework.scheduling.concurrent.ExecutorConfigurationSupport

Methods inherited from class org.springframework.scheduling.concurrent.CustomizableThreadFactory

Methods inherited from class org.springframework.util.CustomizableThreadCreator

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.scheduling.SchedulingTaskExecutor

Methods inherited from interface org.springframework.scheduling.TaskScheduler

Constructor Detail

ThreadPoolTaskScheduler

Method Detail

setPoolSize

setRemoveOnCancelPolicy

setErrorHandler

initializeExecutor

createExecutor

getScheduledExecutor

getScheduledThreadPoolExecutor

getPoolSize

isRemoveOnCancelPolicy

getActiveCount

execute

execute

submit

submit

submitListenable

submitListenable

cancelRemainingTask

schedule

schedule

scheduleAtFixedRate

scheduleAtFixedRate

scheduleWithFixedDelay

scheduleWithFixedDelay