Package org.springframework.boot.task
Class TaskSchedulerBuilder
java.lang.Object
org.springframework.boot.task.TaskSchedulerBuilder
Builder that can be used to configure and create a
TaskScheduler
. Provides
convenience methods to set common ThreadPoolTaskScheduler
settings. For
advanced configuration, consider using TaskSchedulerCustomizer
.
In a typical auto-configured Spring Boot application this builder is available as a
bean and can be injected whenever a TaskScheduler
is needed.
- Since:
- 2.1.0
- Author:
- Stephane Nicoll
-
Constructor Summary
ConstructorDescriptionTaskSchedulerBuilder
(Integer poolSize, Boolean awaitTermination, Duration awaitTerminationPeriod, String threadNamePrefix, Set<TaskSchedulerCustomizer> taskSchedulerCustomizers) -
Method Summary
Modifier and TypeMethodDescriptionadditionalCustomizers
(Iterable<TaskSchedulerCustomizer> customizers) AddtaskSchedulerCustomizers
that should be applied to theThreadPoolTaskScheduler
.additionalCustomizers
(TaskSchedulerCustomizer... customizers) AddtaskSchedulerCustomizers
that should be applied to theThreadPoolTaskScheduler
.awaitTermination
(boolean awaitTermination) Set whether the executor should wait for scheduled tasks to complete on shutdown, not interrupting running tasks and executing all tasks in the queue.awaitTerminationPeriod
(Duration awaitTerminationPeriod) Set the maximum time the executor is supposed to block on shutdown.build()
Build a newThreadPoolTaskScheduler
instance and configure it using this builder.<T extends ThreadPoolTaskScheduler>
Tconfigure
(T taskScheduler) Configure the providedThreadPoolTaskScheduler
instance using this builder.customizers
(Iterable<TaskSchedulerCustomizer> customizers) Set thetaskSchedulerCustomizers
that should be applied to theThreadPoolTaskScheduler
.customizers
(TaskSchedulerCustomizer... customizers) Set theTaskSchedulerCustomizers
that should be applied to theThreadPoolTaskScheduler
.poolSize
(int poolSize) Set the maximum allowed number of threads.threadNamePrefix
(String threadNamePrefix) Set the prefix to use for the names of newly created threads.
-
Constructor Details
-
TaskSchedulerBuilder
public TaskSchedulerBuilder() -
TaskSchedulerBuilder
-
-
Method Details
-
poolSize
Set the maximum allowed number of threads.- Parameters:
poolSize
- the pool size to set- Returns:
- a new builder instance
-
awaitTermination
Set whether the executor should wait for scheduled tasks to complete on shutdown, not interrupting running tasks and executing all tasks in the queue.- Parameters:
awaitTermination
- whether the executor needs to wait for the tasks to complete on shutdown- Returns:
- a new builder instance
- See Also:
-
awaitTerminationPeriod
Set the maximum time the executor is supposed to block on shutdown. When set, the executor blocks on shutdown in order to wait for remaining tasks to complete their execution before the rest of the container continues to shut down. This is particularly useful if your remaining tasks are likely to need access to other resources that are also managed by the container.- Parameters:
awaitTerminationPeriod
- the await termination period to set- Returns:
- a new builder instance
-
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
-
customizers
Set theTaskSchedulerCustomizers
that should be applied to theThreadPoolTaskScheduler
. 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:
-
customizers
Set thetaskSchedulerCustomizers
that should be applied to theThreadPoolTaskScheduler
. 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
AddtaskSchedulerCustomizers
that should be applied to theThreadPoolTaskScheduler
. 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:
-
additionalCustomizers
AddtaskSchedulerCustomizers
that should be applied to theThreadPoolTaskScheduler
. 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:
-
build
Build a newThreadPoolTaskScheduler
instance and configure it using this builder.- Returns:
- a configured
ThreadPoolTaskScheduler
instance. - See Also:
-
configure
Configure the providedThreadPoolTaskScheduler
instance using this builder.- Type Parameters:
T
- the type of task scheduler- Parameters:
taskScheduler
- theThreadPoolTaskScheduler
to configure- Returns:
- the task scheduler instance
- See Also:
-