Package org.springframework.core.task.support

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 JDK java.util.concurrent.Executor and exposes a Spring TaskExecutor for it. Also detects an extended java.util.concurrent.ExecutorService, adapting the AsyncTaskExecutor interface accordingly.
Since:
3.0
Author:
Juergen Hoeller
See Also:

  • Constructor Details

    • 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 Details

    • setTaskDecorator

      public final void setTaskDecorator(TaskDecorator taskDecorator)
      Specify a custom TaskDecorator to be applied to any Runnable 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 plain Runnable execution via execute calls. In case of #submit calls, the exposed Runnable will be a FutureTask which does not propagate any exceptions; you might have to cast it and call Future#get to evaluate exceptions.

      Since:
      4.3

    • execute

      public void execute(Runnable task)
      Delegates to the specified JDK concurrent executor.
      Specified by:
      execute in interface Executor
      Specified by:
      execute in interface TaskExecutor
      Parameters:
      task - the Runnable to execute (never null)
      See Also:

    • 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

    • doExecute

      protected void doExecute(Executor concurrentExecutor, @Nullable TaskDecorator taskDecorator, Runnable runnable) throws RejectedExecutionException
      Actually execute the given Runnable (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 to
      taskDecorator - the specified decorator to be applied, if any
      runnable - the runnable to execute
      Throws:
      RejectedExecutionException - if the given runnable cannot be accepted
      Since:
      4.3