KafkaStreamsTopologyEndpoint.java

/*
 * Copyright 2020-present 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.cloud.stream.binder.kafka.streams.endpoint;

import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.boot.actuate.endpoint.annotation.Selector;
import org.springframework.cloud.stream.binder.kafka.streams.KafkaStreamsRegistry;
import org.springframework.kafka.config.StreamsBuilderFactoryBean;
import org.springframework.util.StringUtils;

/**
 * Actuator endpoint for topology description.
 *
 * @author Soby Chacko
 * @since 3.0.4
 */
@Endpoint(id = "kafkastreamstopology")
public class KafkaStreamsTopologyEndpoint {

	/**
	 * Topology not found message.
	 */
	public static final String NO_TOPOLOGY_FOUND_MSG = "No topology found for the given application ID";

	private final KafkaStreamsRegistry kafkaStreamsRegistry;

	public KafkaStreamsTopologyEndpoint(KafkaStreamsRegistry kafkaStreamsRegistry) {
		this.kafkaStreamsRegistry = kafkaStreamsRegistry;
	}

	@ReadOperation
	public List<String> kafkaStreamsTopologies() {
		final List<StreamsBuilderFactoryBean> streamsBuilderFactoryBeans = this.kafkaStreamsRegistry.streamsBuilderFactoryBeans();
		final List<String> descs = new ArrayList<>();
		streamsBuilderFactoryBeans.stream()
				.forEach(streamsBuilderFactoryBean ->
						descs.add(Objects.requireNonNull(streamsBuilderFactoryBean.getTopology()).describe().toString()));
		return descs;
	}

	@ReadOperation
	public String kafkaStreamsTopology(@Selector String applicationId) {
		if (StringUtils.hasText(applicationId)) {
			final StreamsBuilderFactoryBean streamsBuilderFactoryBean = this.kafkaStreamsRegistry.streamsBuilderFactoryBean(applicationId);
			if (streamsBuilderFactoryBean != null) {
				return Objects.requireNonNull(streamsBuilderFactoryBean.getTopology()).describe().toString();
			}
			else {
				return NO_TOPOLOGY_FOUND_MSG;
			}
		}
		return NO_TOPOLOGY_FOUND_MSG;
	}
}