org.springframework.kafka.core.RoutingKafkaTemplate Maven / Gradle / Ivy

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.1.4
/*
 * Copyright 2020 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.core;

import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.regex.Pattern;

import org.apache.kafka.clients.consumer.OffsetAndMetadata;
import org.apache.kafka.clients.producer.Producer;
import org.apache.kafka.common.Metric;
import org.apache.kafka.common.MetricName;
import org.apache.kafka.common.TopicPartition;

import org.springframework.util.Assert;

/**
 * A {@link KafkaTemplate} that routes messages based on the topic name. Does not support
 * transactions, {@link #flush()}, {@link #metrics()}, and
 * {@link #execute(org.springframework.kafka.core.KafkaOperations.ProducerCallback)},
 * only simple send operations.
 *
 * @author Gary Russell
 * @since 2.5
 *
 */
public class RoutingKafkaTemplate extends KafkaTemplate {

	private final Map> factoryMatchers;

	private final ConcurrentMap> factoryMap = new ConcurrentHashMap<>();

	/**
	 * Construct an instance with the provided properties. The topic patterns will be
	 * traversed in order so an ordered map, such as {@link LinkedHashMap} should be used
	 * with more specific patterns declared first.
	 * @param factories the factories.
	 */
	public RoutingKafkaTemplate(Map> factories) {
		super(new ProducerFactory() {

			@Override
			public Producer createProducer() {
				throw new UnsupportedOperationException();
			}

		});
		this.factoryMatchers = new LinkedHashMap<>(factories);
		Optional transactional = factories.values().stream()
			.map(fact -> fact.transactionCapable())
			.findFirst();
		Assert.isTrue(!transactional.isPresent() || !transactional.get(), "Transactional factories are not supported");
	}

	@Override
	public ProducerFactory getProducerFactory() {
		throw new UnsupportedOperationException("This method is not supported");
	}

	@Override
	public ProducerFactory getProducerFactory(String topic) {
		ProducerFactory producerFactory = this.factoryMap.computeIfAbsent(topic, key -> {
			for (Entry> entry : this.factoryMatchers.entrySet()) {
				if (entry.getKey().matcher(topic).matches()) {
					return entry.getValue();
				}
			}
			return null;
		});
		Assert.state(producerFactory != null, "No producer factory found for topic: " + topic);
		return producerFactory;
	}

	@Override
	public  T execute(ProducerCallback callback) {
		throw new UnsupportedOperationException("This method is not supported");
	}

	@Override
	public  T executeInTransaction(OperationsCallback callback) {
		throw new UnsupportedOperationException("This method is not supported");
	}

	@Override
	public void sendOffsetsToTransaction(Map offsets, String consumerGroupId) {
		throw new UnsupportedOperationException("This method is not supported");
	}

	@Override
	public Map metrics() {
		throw new UnsupportedOperationException("This method is not supported");
	}

	@Override
	public void flush() {
		throw new UnsupportedOperationException("This method is not supported");
	}

}