Package org.springframework.core.task

Class SimpleAsyncTaskExecutor

java.lang.Object
org.springframework.util.CustomizableThreadCreator
org.springframework.core.task.SimpleAsyncTaskExecutor
All Implemented Interfaces:
Serializable, Executor, AsyncListenableTaskExecutor, AsyncTaskExecutor, TaskExecutor
public class SimpleAsyncTaskExecutor extends CustomizableThreadCreator implements AsyncListenableTaskExecutor, Serializable
TaskExecutor implementation that fires up a new Thread for each task, executing it asynchronously.

Supports limiting concurrent threads through the "concurrencyLimit" bean property. By default, the number of concurrent threads is unlimited.

NOTE: This implementation does not reuse threads! Consider a thread-pooling TaskExecutor implementation instead, in particular for executing a large number of short-lived tasks.

Since:
2.0
Author:
Juergen Hoeller
See Also:

  • Field Details

  • Constructor Details

    • SimpleAsyncTaskExecutor

      public SimpleAsyncTaskExecutor()
      Create a new SimpleAsyncTaskExecutor with default thread name prefix.

    • SimpleAsyncTaskExecutor

      public SimpleAsyncTaskExecutor(String threadNamePrefix)
      Create a new SimpleAsyncTaskExecutor with the given thread name prefix.
      Parameters:
      threadNamePrefix - the prefix to use for the names of newly created threads

    • SimpleAsyncTaskExecutor

      public SimpleAsyncTaskExecutor(ThreadFactory threadFactory)
      Create a new SimpleAsyncTaskExecutor with the given external thread factory.
      Parameters:
      threadFactory - the factory to use for creating new Threads

  • Method Details

    • setVirtualThreads

      public void setVirtualThreads(boolean virtual)
      Switch this executor to virtual threads. Requires Java 21 or higher.

      The default is false, indicating platform threads. Set this flag to true in order to create virtual threads instead.

      Since:
      6.1

    • setThreadFactory

      public void setThreadFactory(@Nullable ThreadFactory threadFactory)
      Specify an external factory to use for creating new Threads, instead of relying on the local properties of this executor.

      You may specify an inner ThreadFactory bean or also a ThreadFactory reference obtained from JNDI (on a Jakarta EE server) or some other lookup mechanism.

      See Also:

    • getThreadFactory

      @Nullable public final ThreadFactory getThreadFactory()
      Return the external factory to use for creating new Threads, if any.

    • 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

    • setConcurrencyLimit

      public void setConcurrencyLimit(int concurrencyLimit)
      Set the maximum number of parallel accesses allowed. -1 indicates no concurrency limit at all.

      In principle, this limit can be changed at runtime, although it is generally designed as a config time setting. NOTE: Do not switch between -1 and any concrete limit at runtime, as this will lead to inconsistent concurrency counts: A limit of -1 effectively turns off concurrency counting completely.

      See Also:

    • getConcurrencyLimit

      public final int getConcurrencyLimit()
      Return the maximum number of parallel accesses allowed.

    • isThrottleActive

      public final boolean isThrottleActive()
      Return whether this throttle is currently active.
      Returns:
      true if the concurrency limit for this instance is active
      See Also:

    • execute

      public void execute(Runnable task)
      Executes the given task, within a concurrency throttle if configured (through the superclass's settings).
      Specified by:
      execute in interface Executor
      Specified by:
      execute in interface TaskExecutor
      Parameters:
      task - the Runnable to execute (never null)
      See Also:

    • execute

      @Deprecated public void execute(Runnable task, long startTimeout)
      Deprecated.
      Executes the given task, within a concurrency throttle if configured (through the superclass's settings).

      Executes urgent tasks (with 'immediate' timeout) directly, bypassing the concurrency throttle (if active). All other tasks are subject to throttling.

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

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

      As of 6.1, this method comes with a default implementation that delegates to TaskExecutor.execute(Runnable).

      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.

      As of 6.1, this method comes with a default implementation that delegates to TaskExecutor.execute(Runnable).

      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(Runnable task)
      Template method for the actual execution of a task.

      The default implementation creates a new Thread and starts it.

      Parameters:
      task - the Runnable to execute
      See Also: