All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.springframework.boot.task.TaskSchedulerBuilder Maven / Gradle / Ivy

There is a newer version: 3.3.3
Show newest version
/*
 * Copyright 2012-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.task;

import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;

import org.springframework.boot.context.properties.PropertyMapper;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;

/**
 * Builder that can be used to configure and create a {@link TaskScheduler}. Provides
 * convenience methods to set common {@link ThreadPoolTaskScheduler} settings. For
 * advanced configuration, consider using {@link TaskSchedulerCustomizer}.
 * 

* In a typical auto-configured Spring Boot application this builder is available as a * bean and can be injected whenever a {@link TaskScheduler} is needed. * * @author Stephane Nicoll * @since 2.1.0 */ public class TaskSchedulerBuilder { private final Integer poolSize; private final String threadNamePrefix; private final Set customizers; public TaskSchedulerBuilder() { this.poolSize = null; this.threadNamePrefix = null; this.customizers = null; } public TaskSchedulerBuilder(Integer poolSize, String threadNamePrefix, Set taskSchedulerCustomizers) { this.poolSize = poolSize; this.threadNamePrefix = threadNamePrefix; this.customizers = taskSchedulerCustomizers; } /** * Set the maximum allowed number of threads. * @param poolSize the pool size to set * @return a new builder instance */ public TaskSchedulerBuilder poolSize(int poolSize) { return new TaskSchedulerBuilder(poolSize, this.threadNamePrefix, this.customizers); } /** * Set the prefix to use for the names of newly created threads. * @param threadNamePrefix the thread name prefix to set * @return a new builder instance */ public TaskSchedulerBuilder threadNamePrefix(String threadNamePrefix) { return new TaskSchedulerBuilder(this.poolSize, threadNamePrefix, this.customizers); } /** * Set the {@link TaskSchedulerCustomizer TaskSchedulerCustomizers} that should be * applied to the {@link ThreadPoolTaskScheduler}. 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. * @param customizers the customizers to set * @return a new builder instance * @see #additionalCustomizers(TaskSchedulerCustomizer...) */ public TaskSchedulerBuilder customizers(TaskSchedulerCustomizer... customizers) { Assert.notNull(customizers, "Customizers must not be null"); return customizers(Arrays.asList(customizers)); } /** * Set the {@link TaskSchedulerCustomizer taskSchedulerCustomizers} that should be * applied to the {@link ThreadPoolTaskScheduler}. 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. * @param customizers the customizers to set * @return a new builder instance * @see #additionalCustomizers(TaskSchedulerCustomizer...) */ public TaskSchedulerBuilder customizers(Iterable customizers) { Assert.notNull(customizers, "Customizers must not be null"); return new TaskSchedulerBuilder(this.poolSize, this.threadNamePrefix, append(null, customizers)); } /** * Add {@link TaskSchedulerCustomizer taskSchedulerCustomizers} that should be applied * to the {@link ThreadPoolTaskScheduler}. Customizers are applied in the order that * they were added after builder configuration has been applied. * @param customizers the customizers to add * @return a new builder instance * @see #customizers(TaskSchedulerCustomizer...) */ public TaskSchedulerBuilder additionalCustomizers(TaskSchedulerCustomizer... customizers) { Assert.notNull(customizers, "Customizers must not be null"); return additionalCustomizers(Arrays.asList(customizers)); } /** * Add {@link TaskSchedulerCustomizer taskSchedulerCustomizers} that should be applied * to the {@link ThreadPoolTaskScheduler}. Customizers are applied in the order that * they were added after builder configuration has been applied. * @param customizers the customizers to add * @return a new builder instance * @see #customizers(TaskSchedulerCustomizer...) */ public TaskSchedulerBuilder additionalCustomizers(Iterable customizers) { Assert.notNull(customizers, "Customizers must not be null"); return new TaskSchedulerBuilder(this.poolSize, this.threadNamePrefix, append(this.customizers, customizers)); } /** * Build a new {@link ThreadPoolTaskScheduler} instance and configure it using this * builder. * @return a configured {@link ThreadPoolTaskScheduler} instance. * @see #configure(ThreadPoolTaskScheduler) */ public ThreadPoolTaskScheduler build() { return configure(new ThreadPoolTaskScheduler()); } /** * Configure the provided {@link ThreadPoolTaskScheduler} instance using this builder. * @param the type of task scheduler * @param taskScheduler the {@link ThreadPoolTaskScheduler} to configure * @return the task scheduler instance * @see #build() */ public T configure(T taskScheduler) { PropertyMapper map = PropertyMapper.get().alwaysApplyingWhenNonNull(); map.from(this.poolSize).to(taskScheduler::setPoolSize); map.from(this.threadNamePrefix).to(taskScheduler::setThreadNamePrefix); if (!CollectionUtils.isEmpty(this.customizers)) { this.customizers.forEach((customizer) -> customizer.customize(taskScheduler)); } return taskScheduler; } private Set append(Set set, Iterable additions) { Set result = new LinkedHashSet<>((set != null) ? set : Collections.emptySet()); additions.forEach(result::add); return Collections.unmodifiableSet(result); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy