Class TaskExecutorAdapter
- java.lang.Object
- org.springframework.core.task.support.TaskExecutorAdapter
- All Implemented Interfaces:
Executor
,AsyncListenableTaskExecutor
,AsyncTaskExecutor
,TaskExecutor
public class TaskExecutorAdapter extends Object implements AsyncListenableTaskExecutor
Adapter that takes a JDKjava.util.concurrent.Executor
and exposes a SpringTaskExecutor
for it. Also detects an extendedjava.util.concurrent.ExecutorService
, adapting theAsyncTaskExecutor
interface accordingly.- Since:
- 3.0
- Author:
- Juergen Hoeller
- See Also:
Executor
,ExecutorService
,Executors
Field Summary
Fields inherited from interface org.springframework.core.task.AsyncTaskExecutor
TIMEOUT_IMMEDIATE, TIMEOUT_INDEFINITE
Constructor Summary
Constructors Constructor Description TaskExecutorAdapter(Executor concurrentExecutor)
Create a new TaskExecutorAdapter, using the given JDK concurrent executor.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
doExecute(Executor concurrentExecutor, TaskDecorator taskDecorator, Runnable runnable)
Actually execute the givenRunnable
(which may be a user-supplied task or a wrapper around a user-supplied task) with the given executor.void
execute(Runnable task)
Delegates to the specified JDK concurrent executor.void
execute(Runnable task, long startTimeout)
Execute the giventask
.void
setTaskDecorator(TaskDecorator taskDecorator)
Specify a customTaskDecorator
to be applied to anyRunnable
about to be executed.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 aRunnable
task for execution, receiving aListenableFuture
representing that task.<T> ListenableFuture<T>
submitListenable(Callable<T> task)
Submit aCallable
task for execution, receiving aListenableFuture
representing that task.
Constructor Detail
TaskExecutorAdapter
public TaskExecutorAdapter(Executor concurrentExecutor)
Create a new TaskExecutorAdapter, using the given JDK concurrent executor.- Parameters:
concurrentExecutor
- the JDK concurrent executor to delegate to
Method Detail
setTaskDecorator
public final void setTaskDecorator(TaskDecorator taskDecorator)
Specify a customTaskDecorator
to be applied to anyRunnable
about to be executed.Note that such a decorator is not necessarily being applied to the user-supplied
Runnable
/Callable
but rather to the actual execution callback (which may be a wrapper around the user-supplied task).The primary use case is to set some execution context around the task's invocation, or to provide some monitoring/statistics for task execution.
NOTE: Exception handling in
TaskDecorator
implementations is limited to plainRunnable
execution viaexecute
calls. In case of#submit
calls, the exposedRunnable
will be aFutureTask
which does not propagate any exceptions; you might have to cast it and callFuture#get
to evaluate exceptions.- Since:
- 4.3
execute
public void execute(Runnable task)
Delegates to the specified JDK concurrent executor.- Specified by:
execute
in interfaceExecutor
- Specified by:
execute
in interfaceTaskExecutor
- Parameters:
task
- theRunnable
to execute (nevernull
)- See Also:
Executor.execute(Runnable)
execute
public void execute(Runnable task, long startTimeout)
Description copied from interface:AsyncTaskExecutor
Execute the giventask
.- Specified by:
execute
in interfaceAsyncTaskExecutor
- Parameters:
task
- theRunnable
to execute (nevernull
)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 areAsyncTaskExecutor.TIMEOUT_IMMEDIATE
orAsyncTaskExecutor.TIMEOUT_INDEFINITE
(the default as used byTaskExecutor.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 anull
result upon completion.- Specified by:
submit
in interfaceAsyncTaskExecutor
- Parameters:
task
- theRunnable
to execute (nevernull
)- 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 interfaceAsyncTaskExecutor
- Parameters:
task
- theCallable
to execute (nevernull
)- Returns:
- a Future representing pending completion of the task
submitListenable
public ListenableFuture<?> submitListenable(Runnable task)
Description copied from interface:AsyncListenableTaskExecutor
Submit aRunnable
task for execution, receiving aListenableFuture
representing that task. The Future will return anull
result upon completion.- Specified by:
submitListenable
in interfaceAsyncListenableTaskExecutor
- Parameters:
task
- theRunnable
to execute (nevernull
)- Returns:
- a
ListenableFuture
representing pending completion of the task
submitListenable
public <T> ListenableFuture<T> submitListenable(Callable<T> task)
Description copied from interface:AsyncListenableTaskExecutor
Submit aCallable
task for execution, receiving aListenableFuture
representing that task. The Future will return the Callable's result upon completion.- Specified by:
submitListenable
in interfaceAsyncListenableTaskExecutor
- Parameters:
task
- theCallable
to execute (nevernull
)- Returns:
- a
ListenableFuture
representing pending completion of the task
doExecute
protected void doExecute(Executor concurrentExecutor, TaskDecorator taskDecorator, Runnable runnable) throws RejectedExecutionException
Actually execute the givenRunnable
(which may be a user-supplied task or a wrapper around a user-supplied task) with the given executor.- Parameters:
concurrentExecutor
- the underlying JDK concurrent executor to delegate totaskDecorator
- the specified decorator to be applied, if anyrunnable
- the runnable to execute- Throws:
RejectedExecutionException
- if the given runnable cannot be accepted- Since:
- 4.3