org.springframework.scheduling.annotation.SchedulingConfigurer Maven / Gradle / Ivy
/*
* Copyright 2002-2023 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.scheduling.annotation;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
/**
* Optional interface to be implemented by {@link
* org.springframework.context.annotation.Configuration @Configuration} classes annotated
* with {@link EnableScheduling @EnableScheduling}. Typically used for setting a specific
* {@link org.springframework.scheduling.TaskScheduler TaskScheduler} bean to be used when
* executing scheduled tasks or for registering scheduled tasks in a programmatic
* fashion as opposed to the declarative approach of using the
* {@link Scheduled @Scheduled} annotation. For example, this may be necessary
* when implementing {@link org.springframework.scheduling.Trigger Trigger}-based
* tasks, which are not supported by the {@code @Scheduled} annotation.
*
* See {@link EnableScheduling @EnableScheduling} for detailed usage examples.
*
* @author Chris Beams
* @since 3.1
* @see EnableScheduling
* @see ScheduledTaskRegistrar
*/
@FunctionalInterface
public interface SchedulingConfigurer {
/**
* Callback allowing a {@link org.springframework.scheduling.TaskScheduler}
* and specific {@link org.springframework.scheduling.config.Task} instances
* to be registered against the given the {@link ScheduledTaskRegistrar}.
* @param taskRegistrar the registrar to be configured
*/
void configureTasks(ScheduledTaskRegistrar taskRegistrar);
}