org.springframework.scheduling.concurrent
Class ThreadPoolTaskExecutor

java.lang.Object
  org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor

All Implemented Interfaces:

Executor, DisposableBean, InitializingBean, TaskExecutor, SchedulingTaskExecutor

public class ThreadPoolTaskExecutor
extends Object
implements SchedulingTaskExecutor, Executor, InitializingBean, DisposableBean

JavaBean that allows for configuring a JDK 1.5 ThreadPoolExecutor in bean style (through "corePoolSize", "maxPoolSize", "keepAliveSeconds", "queueCapacity" properties), exposing it as both Spring TaskExecutor and JDK 1.5 Executor. This is an alternative to configuring a ThreadPoolExecutor instance directly using constructor injection, with a separate ConcurrentTaskExecutor adapter if necessary.

For any custom needs, in particular for defining a ScheduledThreadPoolExecutor, it is recommended to use a straight definition of the JDK 1.5 Executor implementation instance or a factory method definition that points to the JDK 1.5 Executors class. To expose it as a Spring TaskExecutor, wrap it with a ConcurrentTaskExecutor adapter.

Since:

2.0

Author:

Juergen Hoeller

See Also:

TaskExecutor, Executor, ThreadPoolExecutor, ScheduledThreadPoolExecutor, Executors, ConcurrentTaskExecutor

Field Summary

protected Log

logger

Constructor Summary

ThreadPoolTaskExecutor()

Method Summary

void	afterPropertiesSet() Calls initialize() after the container applied all property values.
protected BlockingQueue	createQueue(int queueCapacity) Create the BlockingQueue to use for the ThreadPoolExecutor.
void	destroy() Calls shutdown when the BeanFactory destroys the task executor instance.
void	execute(Runnable task) Implementation of both the JDK 1.5 Executor interface and the Spring TaskExecutor interface, delegating to the ThreadPoolExecutor instance.
void	initialize() Creates the BlockingQueue and the ThreadPoolExecutor.
boolean	prefersShortLivedTasks() This task executor prefers short-lived work units.
void	setCorePoolSize(int corePoolSize) Set the ThreadPoolExecutor's core pool size.
void	setKeepAliveSeconds(int keepAliveSeconds) Set the ThreadPoolExecutor's keep alive seconds.
void	setMaxPoolSize(int maxPoolSize) Set the ThreadPoolExecutor's maximum pool size.
void	setQueueCapacity(int queueCapacity) Set the capacity for the ThreadPoolExecutor's BlockingQueue.
void	setRejectedExecutionHandler(RejectedExecutionHandler rejectedExecutionHandler) Set the RejectedExecutionHandler to use for the ThreadPoolExecutor.
void	setThreadFactory(ThreadFactory threadFactory) Set the ThreadFactory to use for the ThreadPoolExecutor's thread pool.
void	shutdown() Perform a shutdown on the ThreadPoolExecutor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected final Log logger

Constructor Detail

ThreadPoolTaskExecutor

public ThreadPoolTaskExecutor()

Method Detail

setCorePoolSize

public void setCorePoolSize(int corePoolSize)

Set the ThreadPoolExecutor's core pool size. Default is 1.

setMaxPoolSize

public void setMaxPoolSize(int maxPoolSize)

Set the ThreadPoolExecutor's maximum pool size. Default is Integer.MAX_VALUE.

setKeepAliveSeconds

public void setKeepAliveSeconds(int keepAliveSeconds)

Set the ThreadPoolExecutor's keep alive seconds. Default is 60.

setQueueCapacity

public void setQueueCapacity(int queueCapacity)

Set the capacity for the ThreadPoolExecutor's BlockingQueue. Default is Integer.MAX_VALUE.

Any positive value will lead to a LinkedBlockingQueue instance; any other value will lead to a SynchronousQueue instance.

See Also:

LinkedBlockingQueue, SynchronousQueue

setThreadFactory

public void setThreadFactory(ThreadFactory threadFactory)

Set the ThreadFactory to use for the ThreadPoolExecutor's thread pool. Default is the ThreadPoolExecutor's default thread factory.

See Also:

Executors.defaultThreadFactory()

setRejectedExecutionHandler

public void setRejectedExecutionHandler(RejectedExecutionHandler rejectedExecutionHandler)

Set the RejectedExecutionHandler to use for the ThreadPoolExecutor. Default is the ThreadPoolExecutor's default abort policy.

See Also:

ThreadPoolExecutor.AbortPolicy

afterPropertiesSet

public void afterPropertiesSet()

Calls initialize() after the container applied all property values.

Specified by:

afterPropertiesSet in interface InitializingBean

See Also:

initialize()

initialize

public void initialize()

Creates the BlockingQueue and the ThreadPoolExecutor.

See Also:

createQueue(int)

createQueue

protected BlockingQueue createQueue(int queueCapacity)

Create the BlockingQueue to use for the ThreadPoolExecutor.

A LinkedBlockingQueue instance will be created for a positive capacity value; a SynchronousQueue else.

Parameters:

queueCapacity - the specified queue capacity

Returns:

the BlockingQueue instance

See Also:

LinkedBlockingQueue, SynchronousQueue

execute

public void execute(Runnable task)

Implementation of both the JDK 1.5 Executor interface and the Spring TaskExecutor interface, delegating to the ThreadPoolExecutor instance.

Specified by:

execute in interface Executor

Specified by:

execute in interface TaskExecutor

Parameters:

task - the Runnable to execute

See Also:

Executor.execute(Runnable), TaskExecutor.execute(Runnable)

prefersShortLivedTasks

public boolean prefersShortLivedTasks()

This task executor prefers short-lived work units.

Specified by:

prefersShortLivedTasks in interface SchedulingTaskExecutor

destroy

public void destroy()

Calls shutdown when the BeanFactory destroys the task executor instance.

Specified by:

destroy in interface DisposableBean

See Also:

shutdown()

shutdown

public void shutdown()

Perform a shutdown on the ThreadPoolExecutor.

See Also:

ThreadPoolExecutor.shutdown()