org.springframework.kafka.retrytopic.RetryTopicSchedulerWrapper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-kafka Show documentation

Spring Kafka Support

There is a newer version: 3.2.4

/*
 * Copyright 2022 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.kafka.retrytopic;

import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.scheduling.TaskScheduler;

/**
 * A wrapper class for a {@link TaskScheduler} to use for scheduling container resumption
 * when a partition has been paused for a retry topic. Using this class prevents breaking
 * Spring Boot's auto configuration for other frameworks. Use this if you are using Spring
 * Boot and do not want to use that auto configured scheduler (if it is configured). This
 * framework requires a scheduler bean and looks for one in this order: 1. A single
 * instance of this class, 2. a single {@link TaskScheduler} bean, 3. when multiple
 * {@link TaskScheduler}s are present, a bean with the name {@code taskScheduler}.
 * If you use this class, you should provide a {@link TaskScheduler} that is not defined
 * as a bean; this class will maintain the scheduler's lifecycle.
 *
 * @author Gary Russell
 * @since 2.9
 */
public class RetryTopicSchedulerWrapper implements InitializingBean, DisposableBean {

	private final TaskScheduler scheduler;

	/**
	 * Create a wrapper for the supplied scheduler.
	 * @param scheduler the scheduler
	 */
	public RetryTopicSchedulerWrapper(TaskScheduler scheduler) {
		this.scheduler = scheduler;
	}

	public TaskScheduler getScheduler() {
		return this.scheduler;
	}

	@Override
	public void afterPropertiesSet() throws Exception {
		if (this.scheduler instanceof InitializingBean) {
			((InitializingBean) this.scheduler).afterPropertiesSet();
		}
	}

	@Override
	public void destroy() throws Exception {
		if (this.scheduler instanceof DisposableBean) {
			((DisposableBean) this.scheduler).destroy();
		}

	}

}