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

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

There is a newer version: 3.2.0
Show newest version
/*
 * Copyright 2017 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
 *
 *      http://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.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.stream.Collectors;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.kafka.clients.admin.AdminClient;
import org.apache.kafka.clients.admin.CreatePartitionsResult;
import org.apache.kafka.clients.admin.CreateTopicsResult;
import org.apache.kafka.clients.admin.DescribeTopicsResult;
import org.apache.kafka.clients.admin.NewPartitions;
import org.apache.kafka.clients.admin.NewTopic;
import org.apache.kafka.clients.admin.TopicDescription;
import org.apache.kafka.common.errors.UnsupportedVersionException;

import org.springframework.beans.BeansException;
import org.springframework.beans.factory.SmartInitializingSingleton;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.kafka.KafkaException;

/**
 * An admin that delegates to an {@link AdminClient} to create topics defined
 * in the application context.
 *
 * @author Gary Russell
 *
 * @since 1.3
 */
public class KafkaAdmin implements ApplicationContextAware, SmartInitializingSingleton {

	private static final int DEFAULT_CLOSE_TIMEOUT = 10;

	private static final int DEFAULT_OPERATION_TIMEOUT = 30;

	private final static Log logger = LogFactory.getLog(KafkaAdmin.class);

	private final Map config;

	private ApplicationContext applicationContext;

	private int closeTimeout = DEFAULT_CLOSE_TIMEOUT;

	private int operationTimeout = DEFAULT_OPERATION_TIMEOUT;

	private boolean fatalIfBrokerNotAvailable;

	private boolean autoCreate = true;

	private boolean initializingContext;

	/**
	 * Create an instance with an {@link AdminClient} based on the supplied
	 * configuration.
	 * @param config the configuration for the {@link AdminClient}.
	 */
	public KafkaAdmin(Map config) {
		this.config = new HashMap<>(config);
	}

	@Override
	public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
		this.applicationContext = applicationContext;
	}

	/**
	 * Set the close timeout in seconds. Defaults to {@value #DEFAULT_CLOSE_TIMEOUT} seconds.
	 * @param closeTimeout the timeout.
	 */
	public void setCloseTimeout(int closeTimeout) {
		this.closeTimeout = closeTimeout;
	}

	/**
	 * Set the operation timeout in seconds. Defaults to {@value #DEFAULT_OPERATION_TIMEOUT} seconds.
	 * @param operationTimeout the timeout.
	 */
	public void setOperationTimeout(int operationTimeout) {
		this.operationTimeout = operationTimeout;
	}

	/**
	 * Set to true if you want the application context to fail to load if we are unable
	 * to connect to the broker during initialization, to check/add topics.
	 * @param fatalIfBrokerNotAvailable true to fail.
	 */
	public void setFatalIfBrokerNotAvailable(boolean fatalIfBrokerNotAvailable) {
		this.fatalIfBrokerNotAvailable = fatalIfBrokerNotAvailable;
	}

	/**
	 * Set to false to suppress auto creation of topics during context initialization.
	 * @param autoCreate boolean flag to indicate creating topics or not during context initialization
	 * @see #initialize()
	 */
	public void setAutoCreate(boolean autoCreate) {
		this.autoCreate = autoCreate;
	}

	/**
	 * Get an unmodifiable copy of this admin's configuration.
	 * @return the configuration map.
	 */
	public Map getConfig() {
		return Collections.unmodifiableMap(this.config);
	}

	@Override
	public void afterSingletonsInstantiated() {
		this.initializingContext = true;
		if (this.autoCreate) {
			initialize();
		}
	}

	/**
	 * Call this method to check/add topics; this might be needed if the broker was not
	 * available when the application context was initialized, and
	 * {@link #setFatalIfBrokerNotAvailable(boolean) fatalIfBrokerNotAvailable} is false,
	 * or {@link #setAutoCreate(boolean) autoCreate} was set to false.
	 * @return true if successful.
	 * @see #setFatalIfBrokerNotAvailable(boolean)
	 * @see #setAutoCreate(boolean)
	 */
	public final boolean initialize() {
		Collection newTopics = this.applicationContext.getBeansOfType(NewTopic.class, false, false).values();
		if (newTopics.size() > 0) {
			AdminClient adminClient = null;
			try {
				adminClient = AdminClient.create(this.config);
			}
			catch (Exception e) {
				if (!this.initializingContext || this.fatalIfBrokerNotAvailable) {
					throw new IllegalStateException("Could not create admin", e);
				}
			}
			if (adminClient != null) {
				try {
					addTopicsIfNeeded(adminClient, newTopics);
					return true;
				}
				catch (Throwable e) {
					if (e instanceof Error) {
						throw (Error) e;
					}
					if (!this.initializingContext || this.fatalIfBrokerNotAvailable) {
						throw new IllegalStateException("Could not configure topics", e);
					}
				}
				finally {
					this.initializingContext = false;
					adminClient.close(this.closeTimeout, TimeUnit.SECONDS);
				}
			}
		}
		this.initializingContext = false;
		return false;
	}

	private void addTopicsIfNeeded(AdminClient adminClient, Collection topics) throws Throwable {
		if (topics.size() > 0) {
			Map topicNameToTopic = new HashMap<>();
			topics.forEach(t -> topicNameToTopic.compute(t.name(), (k, v) -> v = t));
			DescribeTopicsResult topicInfo = adminClient
					.describeTopics(topics.stream()
							.map(NewTopic::name)
							.collect(Collectors.toList()));
			List topicsToAdd = new ArrayList<>();
			Map topicsToModify = new HashMap<>();
			topicInfo.values().forEach((n, f) -> {
				NewTopic topic = topicNameToTopic.get(n);
				try {
					TopicDescription topicDescription = f.get(this.operationTimeout, TimeUnit.SECONDS);
					if (topic.numPartitions() < topicDescription.partitions().size()) {
						if (logger.isInfoEnabled()) {
							logger.info(String.format(
								"Topic '%s' exists but has a different partition count: %d not %d", n,
								topicDescription.partitions().size(), topic.numPartitions()));
						}
					}
					else if (topic.numPartitions() > topicDescription.partitions().size()) {
						if (logger.isInfoEnabled()) {
							logger.info(String.format(
								"Topic '%s' exists but has a different partition count: %d not %d, increasing "
								+ "if the broker supports it", n,
								topicDescription.partitions().size(), topic.numPartitions()));
						}
						topicsToModify.put(n, NewPartitions.increaseTo(topic.numPartitions()));
					}
				}
				catch (InterruptedException e) {
					Thread.currentThread().interrupt();
				}
				catch (TimeoutException e) {
					throw new KafkaException("Timed out waiting to get existing topics", e);
				}
				catch (ExecutionException e) {
					topicsToAdd.add(topic);
				}
			});
			if (topicsToAdd.size() > 0) {
				CreateTopicsResult topicResults = adminClient.createTopics(topicsToAdd);
				try {
					topicResults.all().get(this.operationTimeout, TimeUnit.SECONDS);
				}
				catch (InterruptedException e) {
					Thread.currentThread().interrupt();
					logger.error("Interrupted while waiting for topic creation results", e);
				}
				catch (TimeoutException e) {
					throw new KafkaException("Timed out waiting for create topics results", e);
				}
				catch (ExecutionException e) {
					logger.error("Failed to create topics", e.getCause());
					throw new KafkaException("Failed to create topics", e.getCause());
				}
			}
			if (topicsToModify.size() > 0) {
				CreatePartitionsResult partitionsResult = adminClient.createPartitions(topicsToModify);
				try {
					partitionsResult.all().get(this.operationTimeout, TimeUnit.SECONDS);
				}
				catch (InterruptedException e) {
					Thread.currentThread().interrupt();
					logger.error("Interrupted while waiting for partition creation results", e);
				}
				catch (TimeoutException e) {
					throw new KafkaException("Timed out waiting for create partitions results", e);
				}
				catch (ExecutionException e) {
					logger.error("Failed to create partitions", e.getCause());
					if (!(e.getCause() instanceof UnsupportedVersionException)) {
						throw new KafkaException("Failed to create partitions", e.getCause());
					}
				}
			}
		}
	}

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy