Polish "Introduce HealthIndicatorRegistry"

See gh-4965

Co-authored-by: Andy Wilkinson <[email protected]>

Author: snicoll

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/CompositeHealthIndicatorConfiguration.java

@@ -20,8 +20,10 @@
 
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.actuate.health.CompositeHealthIndicator;
+import org.springframework.boot.actuate.health.DefaultHealthIndicatorRegistry;
 import org.springframework.boot.actuate.health.HealthAggregator;
 import org.springframework.boot.actuate.health.HealthIndicator;
+import org.springframework.boot.actuate.health.HealthIndicatorRegistry;
 import org.springframework.core.ResolvableType;
 
 /**
@@ -42,11 +44,10 @@ protected HealthIndicator createHealthIndicator(Map<String, S> beans) {
 		if (beans.size() == 1) {
 			return createHealthIndicator(beans.values().iterator().next());
 		}
-		CompositeHealthIndicator composite = new CompositeHealthIndicator(
-				this.healthAggregator);
-		beans.forEach((name, source) -> composite.addHealthIndicator(name,
-				createHealthIndicator(source)));
-		return composite;
+		HealthIndicatorRegistry registry = new DefaultHealthIndicatorRegistry();
+		beans.forEach(
+				(name, source) -> registry.register(name, createHealthIndicator(source)));
+		return new CompositeHealthIndicator(this.healthAggregator, registry);
 	}
 
 	@SuppressWarnings("unchecked")

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthEndpointConfiguration.java

@@ -16,41 +16,32 @@
 
 package org.springframework.boot.actuate.autoconfigure.health;
 
-import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnEnabledEndpoint;
+import org.springframework.boot.actuate.health.CompositeHealthIndicator;
 import org.springframework.boot.actuate.health.HealthAggregator;
 import org.springframework.boot.actuate.health.HealthEndpoint;
 import org.springframework.boot.actuate.health.HealthIndicatorRegistry;
-import org.springframework.boot.actuate.health.OrderedHealthAggregator;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
 /**
  * Configuration for {@link HealthEndpoint}.
  *
  * @author Stephane Nicoll
- * @author Vedran Pavic
  */
 @Configuration
+@ConditionalOnSingleCandidate(HealthIndicatorRegistry.class)
 class HealthEndpointConfiguration {
 
-	private final HealthAggregator healthAggregator;
-
-	private final HealthIndicatorRegistry healthIndicatorRegistry;
-
-	HealthEndpointConfiguration(ObjectProvider<HealthAggregator> healthAggregator,
-			ObjectProvider<HealthIndicatorRegistry> healthIndicatorRegistry) {
-		this.healthAggregator = healthAggregator
-				.getIfAvailable(OrderedHealthAggregator::new);
-		this.healthIndicatorRegistry = healthIndicatorRegistry.getObject();
-	}
-
 	@Bean
 	@ConditionalOnMissingBean
 	@ConditionalOnEnabledEndpoint
-	public HealthEndpoint healthEndpoint() {
-		return new HealthEndpoint(this.healthAggregator, this.healthIndicatorRegistry);
+	public HealthEndpoint healthEndpoint(HealthAggregator healthAggregator,
+			HealthIndicatorRegistry registry) {
+		return new HealthEndpoint(
+				new CompositeHealthIndicator(healthAggregator, registry));
 	}
 
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthIndicatorAutoConfiguration.java

@@ -16,11 +16,7 @@
 
 package org.springframework.boot.actuate.autoconfigure.health;
 
-import java.util.LinkedHashMap;
-import java.util.Map;
-
 import org.springframework.boot.actuate.health.ApplicationHealthIndicator;
-import org.springframework.boot.actuate.health.DefaultHealthIndicatorRegistry;
 import org.springframework.boot.actuate.health.HealthAggregator;
 import org.springframework.boot.actuate.health.HealthIndicator;
 import org.springframework.boot.actuate.health.HealthIndicatorRegistry;
@@ -32,7 +28,6 @@
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.util.ClassUtils;
 
 /**
  * {@link EnableAutoConfiguration Auto-configuration} for {@link HealthIndicator}s.
@@ -73,30 +68,7 @@ public OrderedHealthAggregator healthAggregator() {
 	@ConditionalOnMissingBean(HealthIndicatorRegistry.class)
 	public HealthIndicatorRegistry healthIndicatorRegistry(
 			ApplicationContext applicationContext) {
-		HealthIndicatorRegistry registry = new DefaultHealthIndicatorRegistry();
-		Map<String, HealthIndicator> indicators = new LinkedHashMap<>();
-		indicators.putAll(applicationContext.getBeansOfType(HealthIndicator.class));
-		if (ClassUtils.isPresent("reactor.core.publisher.Flux", null)) {
-			new ReactiveHealthIndicators().get(applicationContext)
-					.forEach(indicators::putIfAbsent);
-		}
-		indicators.forEach(registry::register);
-		return registry;
-	}
-
-	private static class ReactiveHealthIndicators {
-
-		public Map<String, HealthIndicator> get(ApplicationContext applicationContext) {
-			Map<String, HealthIndicator> indicators = new LinkedHashMap<>();
-			applicationContext.getBeansOfType(ReactiveHealthIndicator.class)
-					.forEach((name, indicator) -> indicators.put(name, adapt(indicator)));
-			return indicators;
-		}
-
-		private HealthIndicator adapt(ReactiveHealthIndicator indicator) {
-			return () -> indicator.health().block();
-		}
-
+		return HealthIndicatorRegistryBeans.get(applicationContext);
 	}
 
 }

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthIndicatorRegistryBeans.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2012-2018 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.boot.actuate.autoconfigure.health;
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+import org.springframework.boot.actuate.health.HealthIndicator;
+import org.springframework.boot.actuate.health.HealthIndicatorRegistry;
+import org.springframework.boot.actuate.health.HealthIndicatorRegistryFactory;
+import org.springframework.boot.actuate.health.ReactiveHealthIndicator;
+import org.springframework.context.ApplicationContext;
+import org.springframework.util.ClassUtils;
+
+/**
+ * Creates a {@link HealthIndicatorRegistry} from beans in the {@link ApplicationContext}.
+ *
+ * @author Phillip Webb
+ * @author Stephane Nicoll
+ */
+final class HealthIndicatorRegistryBeans {
+
+	private HealthIndicatorRegistryBeans() {
+	}
+
+	public static HealthIndicatorRegistry get(ApplicationContext applicationContext) {
+		Map<String, HealthIndicator> indicators = new LinkedHashMap<>();
+		indicators.putAll(applicationContext.getBeansOfType(HealthIndicator.class));
+		if (ClassUtils.isPresent("reactor.core.publisher.Flux", null)) {
+			new ReactiveHealthIndicators().get(applicationContext)
+					.forEach(indicators::putIfAbsent);
+		}
+		HealthIndicatorRegistryFactory factory = new HealthIndicatorRegistryFactory();
+		return factory.createHealthIndicatorRegistry(indicators);
+	}
+
+	private static class ReactiveHealthIndicators {
+
+		public Map<String, HealthIndicator> get(ApplicationContext applicationContext) {
+			Map<String, HealthIndicator> indicators = new LinkedHashMap<>();
+			applicationContext.getBeansOfType(ReactiveHealthIndicator.class)
+					.forEach((name, indicator) -> indicators.put(name, adapt(indicator)));
+			return indicators;
+		}
+
+		private HealthIndicator adapt(ReactiveHealthIndicator indicator) {
+			return () -> indicator.health().block();
+		}
+
+	}
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/cloudfoundry/CloudFoundryWebEndpointDiscovererTests.java

@@ -34,9 +34,8 @@
 import org.springframework.boot.actuate.endpoint.web.PathMapper;
 import org.springframework.boot.actuate.endpoint.web.WebOperation;
 import org.springframework.boot.actuate.endpoint.web.annotation.EndpointWebExtension;
-import org.springframework.boot.actuate.health.HealthAggregator;
 import org.springframework.boot.actuate.health.HealthEndpoint;
-import org.springframework.boot.actuate.health.HealthIndicatorRegistry;
+import org.springframework.boot.actuate.health.HealthIndicator;
 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -110,8 +109,7 @@ public TestEndpointWebExtension testEndpointWebExtension() {
 
 		@Bean
 		public HealthEndpoint healthEndpoint() {
-			return new HealthEndpoint(mock(HealthAggregator.class),
-					mock(HealthIndicatorRegistry.class));
+			return new HealthEndpoint(mock(HealthIndicator.class));
 		}
 
 		@Bean

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/HealthEndpointDocumentationTests.java

@@ -23,10 +23,10 @@
 
 import org.junit.Test;
 
-import org.springframework.boot.actuate.health.DefaultHealthIndicatorRegistry;
+import org.springframework.boot.actuate.health.CompositeHealthIndicator;
 import org.springframework.boot.actuate.health.HealthEndpoint;
 import org.springframework.boot.actuate.health.HealthIndicator;
-import org.springframework.boot.actuate.health.HealthIndicatorRegistry;
+import org.springframework.boot.actuate.health.HealthIndicatorRegistryFactory;
 import org.springframework.boot.actuate.health.OrderedHealthAggregator;
 import org.springframework.boot.actuate.jdbc.DataSourceHealthIndicator;
 import org.springframework.boot.actuate.system.DiskSpaceHealthIndicator;
@@ -73,9 +73,9 @@ static class TestConfiguration {
 
 		@Bean
 		public HealthEndpoint endpoint(Map<String, HealthIndicator> healthIndicators) {
-			HealthIndicatorRegistry registry = new DefaultHealthIndicatorRegistry();
-			healthIndicators.forEach(registry::register);
-			return new HealthEndpoint(new OrderedHealthAggregator(), registry);
+			return new HealthEndpoint(new CompositeHealthIndicator(
+					new OrderedHealthAggregator(), new HealthIndicatorRegistryFactory()
+							.createHealthIndicatorRegistry(healthIndicators)));
 		}
 
 		@Bean

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/integrationtest/JmxEndpointIntegrationTests.java

@@ -48,7 +48,8 @@ public class JmxEndpointIntegrationTests {
 	private final WebApplicationContextRunner contextRunner = new WebApplicationContextRunner()
 			.withConfiguration(AutoConfigurations.of(JmxAutoConfiguration.class,
 					EndpointAutoConfiguration.class, JmxEndpointAutoConfiguration.class,
-					HttpTraceAutoConfiguration.class, HealthIndicatorAutoConfiguration.class))
+					HealthIndicatorAutoConfiguration.class,
+					HttpTraceAutoConfiguration.class))
 			.withConfiguration(
 					AutoConfigurations.of(EndpointAutoConfigurationClasses.ALL));
 

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/health/CompositeHealthIndicator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2017 the original author or authors.
+ * Copyright 2012-2018 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.
@@ -19,8 +19,6 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 
-import org.springframework.util.Assert;
-
 /**
  * {@link HealthIndicator} that returns health indications from all registered delegates.
  *
@@ -31,43 +29,71 @@
  */
 public class CompositeHealthIndicator implements HealthIndicator {
 
-	private final Map<String, HealthIndicator> indicators;
+	private final HealthIndicatorRegistry registry;
 
-	private final HealthAggregator healthAggregator;
+	private final HealthAggregator aggregator;
 
 	/**
 	 * Create a new {@link CompositeHealthIndicator}.
 	 * @param healthAggregator the health aggregator
+	 * @deprecated since 2.1.0 in favour of
+	 * {@link #CompositeHealthIndicator(HealthAggregator, HealthIndicatorRegistry)}
 	 */
+	@Deprecated
 	public CompositeHealthIndicator(HealthAggregator healthAggregator) {
-		this(healthAggregator, new LinkedHashMap<>());
+		this(healthAggregator, new DefaultHealthIndicatorRegistry());
 	}
 
 	/**
-	 * Create a new {@link CompositeHealthIndicator} from the specified indicators.
+	 * Create a new {@link CompositeHealthIndicator} from the specified
+	 * indicators.
 	 * @param healthAggregator the health aggregator
-	 * @param indicators a map of {@link HealthIndicator}s with the key being used as an
-	 * indicator name.
+	 * @param indicators a map of {@link HealthIndicator HealthIndicators} with
+	 * the key being used as an indicator name.
+	 * @deprecated since 2.1.0 in favour of
+	 * {@link #CompositeHealthIndicator(HealthAggregator, HealthIndicatorRegistry)}
 	 */
+	@Deprecated
 	public CompositeHealthIndicator(HealthAggregator healthAggregator,
 			Map<String, HealthIndicator> indicators) {
-		Assert.notNull(healthAggregator, "HealthAggregator must not be null");
-		Assert.notNull(indicators, "Indicators must not be null");
-		this.indicators = new LinkedHashMap<>(indicators);
-		this.healthAggregator = healthAggregator;
+		this(healthAggregator, new DefaultHealthIndicatorRegistry(indicators));
 	}
 
+	/**
+	 * Create a new {@link CompositeHealthIndicator} from the indicators in the
+	 * given {@code registry}.
+	 * @param healthAggregator the health aggregator
+	 * @param registry the registry of {@link HealthIndicator HealthIndicators}.
+	 */
+	public CompositeHealthIndicator(HealthAggregator healthAggregator,
+			HealthIndicatorRegistry registry) {
+		this.aggregator = healthAggregator;
+		this.registry = registry;
+	}
+
+	/**
+	 * Adds the given {@code healthIndicator}, associating it with the given
+	 * {@code name}.
+	 * @param name the name of the indicator
+	 * @param indicator the indicator
+	 * @throws IllegalStateException if an indicator with the given {@code name}
+	 * is already registered.
+	 * @deprecated since 2.1.0 in favour of
+	 * {@link HealthIndicatorRegistry#register(String, HealthIndicator)}
+	 */
+	@Deprecated
 	public void addHealthIndicator(String name, HealthIndicator indicator) {
-		this.indicators.put(name, indicator);
+		this.registry.register(name, indicator);
 	}
 
 	@Override
 	public Health health() {
 		Map<String, Health> healths = new LinkedHashMap<>();
-		for (Map.Entry<String, HealthIndicator> entry : this.indicators.entrySet()) {
+		for (Map.Entry<String, HealthIndicator> entry : this.registry.getAll()
+				.entrySet()) {
 			healths.put(entry.getKey(), entry.getValue().health());
 		}
-		return this.healthAggregator.aggregate(healths);
+		return this.aggregator.aggregate(healths);
 	}
 
 }