org.springframework.kafka.config.KafkaStreamsCustomizer 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

The newest version!

/*
 * Copyright 2018-2024 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.config;

import java.util.Properties;

import org.apache.kafka.streams.KafkaClientSupplier;
import org.apache.kafka.streams.KafkaStreams;
import org.apache.kafka.streams.Topology;

/**
 * Callback interface that can be used to configure {@link KafkaStreams} directly.
 *
 * @author Nurettin Yilmaz
 * @author Almog Gavra
 *
 * @since 2.1.5
 *
 * @see StreamsBuilderFactoryBean
 */
@FunctionalInterface
public interface KafkaStreamsCustomizer {

	/**
	 * Customize the instantiation of the {@code KafkaStreams} instance. This
	 * happens before the modifications made by {@link StreamsBuilderFactoryBean}.
	 *
	 * @param topology the full topology
	 * @param properties the configuration properties
	 * @param clientSupplier the client supplier
	 *
	 * @return a new instance of {@link KafkaStreams}
	 *
	 * @since 3.3.0
	 */
	default KafkaStreams initKafkaStreams(
			Topology topology,
			Properties properties,
			KafkaClientSupplier clientSupplier
	) {
		return new KafkaStreams(topology, properties, clientSupplier);
	}

	/**
	 * Customize the instance of {@code KafkaStreams} after {@link StreamsBuilderFactoryBean}
	 * has applied its default configurations.
	 *
	 * @param kafkaStreams the instantiated Kafka Streams instance
	 */
	void customize(KafkaStreams kafkaStreams);

}