Class SimpleAsyncTaskExecutorBuilder

java.lang.Object

org.springframework.boot.task.SimpleAsyncTaskExecutorBuilder

public class SimpleAsyncTaskExecutorBuilder
extends Object

Builder that can be used to configure and create a SimpleAsyncTaskExecutor. Provides convenience methods to set common SimpleAsyncTaskExecutor settings and register taskDecorator(TaskDecorator)). For advanced configuration, consider using SimpleAsyncTaskExecutorCustomizer.

In a typical auto-configured Spring Boot application this builder is available as a bean and can be injected whenever a SimpleAsyncTaskExecutor is needed.

Since:

3.2.0

Author:

Stephane Nicoll, Filip Hrisafov, Moritz Halbritter, Yanming Zhou

Constructor Summary

Constructors

Constructor	Description
SimpleAsyncTaskExecutorBuilder()

Method Summary

Modifier and Type	Method	Description
SimpleAsyncTaskExecutorBuilder	additionalCustomizers(Iterable<? extends SimpleAsyncTaskExecutorCustomizer> customizers)	Add customizers that should be applied to the SimpleAsyncTaskExecutor.
SimpleAsyncTaskExecutorBuilder	additionalCustomizers(SimpleAsyncTaskExecutorCustomizer... customizers)	Add customizers that should be applied to the SimpleAsyncTaskExecutor.
SimpleAsyncTaskExecutor	build()	Build a new SimpleAsyncTaskExecutor instance and configure it using this builder.
<T extends SimpleAsyncTaskExecutor> T	build(Class<T> taskExecutorClass)	Build a new SimpleAsyncTaskExecutor instance of the specified type and configure it using this builder.
SimpleAsyncTaskExecutorBuilder	cancelRemainingTasksOnClose(boolean cancelRemainingTasksOnClose)	Set whether to cancel remaining tasks on close.
SimpleAsyncTaskExecutorBuilder	concurrencyLimit(@Nullable Integer concurrencyLimit)	Set the concurrency limit.
<T extends SimpleAsyncTaskExecutor> T	configure(T taskExecutor)	Configure the provided SimpleAsyncTaskExecutor instance using this builder.
SimpleAsyncTaskExecutorBuilder	customizers(Iterable<? extends SimpleAsyncTaskExecutorCustomizer> customizers)	Set the customizers that should be applied to the SimpleAsyncTaskExecutor.
SimpleAsyncTaskExecutorBuilder	customizers(SimpleAsyncTaskExecutorCustomizer... customizers)	Set the customizers that should be applied to the SimpleAsyncTaskExecutor.
SimpleAsyncTaskExecutorBuilder	rejectTasksWhenLimitReached(boolean rejectTasksWhenLimitReached)	Set whether to reject tasks when the concurrency limit has been reached.
SimpleAsyncTaskExecutorBuilder	taskDecorator(@Nullable TaskDecorator taskDecorator)	Set the TaskDecorator to use or null to not use any.
SimpleAsyncTaskExecutorBuilder	taskTerminationTimeout(@Nullable Duration taskTerminationTimeout)	Set the task termination timeout.
SimpleAsyncTaskExecutorBuilder	threadNamePrefix(@Nullable String threadNamePrefix)	Set the prefix to use for the names of newly created threads.
SimpleAsyncTaskExecutorBuilder	virtualThreads(@Nullable Boolean virtualThreads)	Set whether to use virtual threads.

Methods inherited from class Object

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

Constructor Details

SimpleAsyncTaskExecutorBuilder

public SimpleAsyncTaskExecutorBuilder()

Method Details

threadNamePrefix

public SimpleAsyncTaskExecutorBuilder threadNamePrefix(@Nullable String threadNamePrefix)

Set the prefix to use for the names of newly created threads.

Parameters:

threadNamePrefix - the thread name prefix to set

Returns:

a new builder instance

virtualThreads

public SimpleAsyncTaskExecutorBuilder virtualThreads(@Nullable Boolean virtualThreads)

Set whether to use virtual threads.

Parameters:

virtualThreads - whether to use virtual threads

Returns:

a new builder instance

cancelRemainingTasksOnClose

public SimpleAsyncTaskExecutorBuilder cancelRemainingTasksOnClose(boolean cancelRemainingTasksOnClose)

Set whether to cancel remaining tasks on close. By default false not tracking active threads at all or just interrupting any remaining threads that still have not finished after the specified taskTerminationTimeout. Switch this to true for immediate interruption on close, either in combination with a subsequent termination timeout or without any waiting at all, depending on whether a taskTerminationTimeout has been specified as well.

Parameters:

cancelRemainingTasksOnClose - whether to cancel remaining tasks on close

Returns:

a new builder instance

Since:

4.0.0

rejectTasksWhenLimitReached

public SimpleAsyncTaskExecutorBuilder rejectTasksWhenLimitReached(boolean rejectTasksWhenLimitReached)

Set whether to reject tasks when the concurrency limit has been reached. By default false to block the caller until the submission can be accepted. Switch to true for immediate rejection instead.

Parameters:

rejectTasksWhenLimitReached - whether to reject tasks when the concurrency limit has been reached

Returns:

a new builder instance

Since:

3.5.0

concurrencyLimit

public SimpleAsyncTaskExecutorBuilder concurrencyLimit(@Nullable Integer concurrencyLimit)

Set the concurrency limit.

Parameters:

concurrencyLimit - the concurrency limit

Returns:

a new builder instance

taskDecorator

public SimpleAsyncTaskExecutorBuilder taskDecorator(@Nullable TaskDecorator taskDecorator)

Set the TaskDecorator to use or null to not use any.

Parameters:

taskDecorator - the task decorator to use

Returns:

a new builder instance

taskTerminationTimeout

public SimpleAsyncTaskExecutorBuilder taskTerminationTimeout(@Nullable Duration taskTerminationTimeout)

Set the task termination timeout.

Parameters:

taskTerminationTimeout - the task termination timeout

Returns:

a new builder instance

Since:

3.2.1

customizers

public SimpleAsyncTaskExecutorBuilder customizers(SimpleAsyncTaskExecutorCustomizer... customizers)

Set the customizers that should be applied to the SimpleAsyncTaskExecutor. Customizers are applied in the order that they were added after builder configuration has been applied. Setting this value will replace any previously configured customizers.

Parameters:

customizers - the customizers to set

Returns:

a new builder instance

See Also:

• additionalCustomizers(SimpleAsyncTaskExecutorCustomizer...)

customizers

public SimpleAsyncTaskExecutorBuilder customizers(Iterable<? extends SimpleAsyncTaskExecutorCustomizer> customizers)

Set the customizers that should be applied to the SimpleAsyncTaskExecutor. Customizers are applied in the order that they were added after builder configuration has been applied. Setting this value will replace any previously configured customizers.

Parameters:

customizers - the customizers to set

Returns:

a new builder instance

See Also:

• additionalCustomizers(Iterable)

additionalCustomizers

public SimpleAsyncTaskExecutorBuilder additionalCustomizers(SimpleAsyncTaskExecutorCustomizer... customizers)

Add customizers that should be applied to the SimpleAsyncTaskExecutor. Customizers are applied in the order that they were added after builder configuration has been applied.

Parameters:

customizers - the customizers to add

Returns:

a new builder instance

See Also:

• customizers(SimpleAsyncTaskExecutorCustomizer...)

additionalCustomizers

public SimpleAsyncTaskExecutorBuilder additionalCustomizers(Iterable<? extends SimpleAsyncTaskExecutorCustomizer> customizers)

Add customizers that should be applied to the SimpleAsyncTaskExecutor. Customizers are applied in the order that they were added after builder configuration has been applied.

Parameters:

customizers - the customizers to add

Returns:

a new builder instance

See Also:

• customizers(Iterable)

build

public SimpleAsyncTaskExecutor build()

Build a new SimpleAsyncTaskExecutor instance and configure it using this builder.

Returns:

a configured SimpleAsyncTaskExecutor instance.

See Also:

• build(Class)
• configure(SimpleAsyncTaskExecutor)

build

public <T extends SimpleAsyncTaskExecutor> T build(Class<T> taskExecutorClass)

Build a new SimpleAsyncTaskExecutor instance of the specified type and configure it using this builder.

Type Parameters:

T - the type of task executor

Parameters:

taskExecutorClass - the template type to create

Returns:

a configured SimpleAsyncTaskExecutor instance.

See Also:

• build()
• configure(SimpleAsyncTaskExecutor)

configure

public <T extends SimpleAsyncTaskExecutor> T configure(T taskExecutor)

Configure the provided SimpleAsyncTaskExecutor instance using this builder.

Type Parameters:

T - the type of task executor

Parameters:

taskExecutor - the SimpleAsyncTaskExecutor to configure

Returns:

the task executor instance

See Also:

• build()
• build(Class)