Allow endpoint paths to be configured via endpoint.<name>.path

wilkinsona · wilkinsona · commit 617c97322d8d · 2016-02-23T17:06:51.000Z
Support for configuring an endpoint’s path separately from its id was introduced in 9725578, but it didn’t work for a variety of reasons: 1. Some custom MVC endpoints did not have configuration properties bound to them 2. Some generic endpoints rejected the path property as they were configured not to ignore unknown fields 3. The property used to configure the path was dependent on the id of the endpoint. This meant that the path property’s name would change if the endpoint’s id was changed This commit addresses these problems: 1. @ConfigurationProperties has been added to custom MvcEndpoints where it was missing 2. Generic endpoints have been updated to ignore unknown fields, allowing the path of their MVC adapter to be configured 3. Rather than using the id of a generic endpoint to determine the name of its path property, the prefix or value of the endpoint’s @ConfigurationProperties annotation is used instead. Any generic endpoint that is not annotated with @ConfigurationProperties is ignored, making its path unconfigurable. Closes gh-5105
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/AutoConfigurationReportEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/AutoConfigurationReportEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -44,7 +44,7 @@
  * @author Dave Syer
  * @author Andy Wilkinson
  */
-@ConfigurationProperties(prefix = "endpoints.autoconfig", ignoreUnknownFields = false)
+@ConfigurationProperties(prefix = "endpoints.autoconfig")
 public class AutoConfigurationReportEndpoint extends AbstractEndpoint<Report> {
 
 	@Autowired
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/BeansEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/BeansEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -35,7 +35,7 @@
  *
  * @author Dave Syer
  */
-@ConfigurationProperties(prefix = "endpoints.beans", ignoreUnknownFields = false)
+@ConfigurationProperties(prefix = "endpoints.beans")
 public class BeansEndpoint extends AbstractEndpoint<List<Object>>
 		implements ApplicationContextAware {
 
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ConfigurationPropertiesReportEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ConfigurationPropertiesReportEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -58,7 +58,7 @@
  * @author Christian Dupuis
  * @author Dave Syer
  */
-@ConfigurationProperties(prefix = "endpoints.configprops", ignoreUnknownFields = false)
+@ConfigurationProperties(prefix = "endpoints.configprops")
 public class ConfigurationPropertiesReportEndpoint
 		extends AbstractEndpoint<Map<String, Object>> implements ApplicationContextAware {
 
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/DumpEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/DumpEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -28,7 +28,7 @@
  *
  * @author Dave Syer
  */
-@ConfigurationProperties(prefix = "endpoints.dump", ignoreUnknownFields = false)
+@ConfigurationProperties(prefix = "endpoints.dump")
 public class DumpEndpoint extends AbstractEndpoint<List<ThreadInfo>> {
 
 	/**
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/EnvironmentEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/EnvironmentEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -36,7 +36,7 @@
  * @author Phillip Webb
  * @author Christian Dupuis
  */
-@ConfigurationProperties(prefix = "endpoints.env", ignoreUnknownFields = false)
+@ConfigurationProperties(prefix = "endpoints.env")
 public class EnvironmentEndpoint extends AbstractEndpoint<Map<String, Object>> {
 
 	private final Sanitizer sanitizer = new Sanitizer();
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/FlywayEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/FlywayEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -36,7 +36,7 @@
  * @author Phillip Webb
  * @since 1.3.0
  */
-@ConfigurationProperties(prefix = "endpoints.flyway", ignoreUnknownFields = true)
+@ConfigurationProperties(prefix = "endpoints.flyway")
 public class FlywayEndpoint extends AbstractEndpoint<List<FlywayMigration>> {
 
 	private final Flyway flyway;
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/HealthEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/HealthEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -32,7 +32,7 @@
  * @author Christian Dupuis
  * @author Andy Wilkinson
  */
-@ConfigurationProperties(prefix = "endpoints.health", ignoreUnknownFields = true)
+@ConfigurationProperties(prefix = "endpoints.health")
 public class HealthEndpoint extends AbstractEndpoint<Health> {
 
 	private final HealthIndicator healthIndicator;
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/InfoEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/InfoEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -28,7 +28,7 @@
  *
  * @author Dave Syer
  */
-@ConfigurationProperties(prefix = "endpoints.info", ignoreUnknownFields = false)
+@ConfigurationProperties(prefix = "endpoints.info")
 public class InfoEndpoint extends AbstractEndpoint<Map<String, Object>> {
 
 	private final Map<String, ? extends Object> info;
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/LiquibaseEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/LiquibaseEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -36,7 +36,7 @@
  * @author Eddú Meléndez
  * @since 1.3.0
  */
-@ConfigurationProperties(prefix = "endpoints.liquibase", ignoreUnknownFields = true)
+@ConfigurationProperties(prefix = "endpoints.liquibase")
 public class LiquibaseEndpoint extends AbstractEndpoint<List<Map<String, ?>>> {
 
 	private final SpringLiquibase liquibase;
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/RequestMappingEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/RequestMappingEndpoint.java
@@ -38,7 +38,7 @@
  * @author Dave Syer
  * @author Andy Wilkinson
  */
-@ConfigurationProperties(prefix = "endpoints.mappings", ignoreUnknownFields = false)
+@ConfigurationProperties(prefix = "endpoints.mappings")
 public class RequestMappingEndpoint extends AbstractEndpoint<Map<String, Object>>
 		implements ApplicationContextAware {
 
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ShutdownEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/ShutdownEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -31,7 +31,7 @@
  * @author Dave Syer
  * @author Christian Dupuis
  */
-@ConfigurationProperties(prefix = "endpoints.shutdown", ignoreUnknownFields = false)
+@ConfigurationProperties(prefix = "endpoints.shutdown")
 public class ShutdownEndpoint extends AbstractEndpoint<Map<String, Object>>
 		implements ApplicationContextAware {
 
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/TraceEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/TraceEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -28,7 +28,7 @@
  *
  * @author Dave Syer
  */
-@ConfigurationProperties(prefix = "endpoints.trace", ignoreUnknownFields = false)
+@ConfigurationProperties(prefix = "endpoints.trace")
 public class TraceEndpoint extends AbstractEndpoint<List<Trace>> {
 
 	private final TraceRepository repository;
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/AbstractEndpointMvcAdapter.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/AbstractEndpointMvcAdapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -34,6 +34,9 @@ public abstract class AbstractEndpointMvcAdapter<E extends Endpoint<?>>
 
 	private final E delegate;
 
+	/**
+	 * Endpoint URL path.
+	 */
 	private String path;
 
 	/**
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/DocsMvcEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/DocsMvcEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -40,6 +40,9 @@ public class DocsMvcEndpoint extends WebMvcConfigurerAdapter
 
 	private Environment environment;
 
+	/**
+	 * Endpoint URL path.
+	 */
 	private String path = "/docs";
 
 	/**
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/EnvironmentMvcEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/EnvironmentMvcEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -17,6 +17,7 @@
 package org.springframework.boot.actuate.endpoint.mvc;
 
 import org.springframework.boot.actuate.endpoint.EnvironmentEndpoint;
+import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.EnvironmentAware;
 import org.springframework.core.env.ConfigurableEnvironment;
 import org.springframework.core.env.EnumerablePropertySource;
@@ -38,6 +39,7 @@
  * @author Christian Dupuis
  * @author Andy Wilkinson
  */
+@ConfigurationProperties(prefix = "endpoints.env")
 public class EnvironmentMvcEndpoint extends EndpointMvcAdapter
 		implements EnvironmentAware {
 
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/HalJsonMvcEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/HalJsonMvcEndpoint.java
@@ -49,7 +49,7 @@ public class HalJsonMvcEndpoint extends WebMvcConfigurerAdapter
 	 * Endpoint URL path.
 	 */
 	@NotNull
-	@Pattern(regexp = "^$|/[^/]*", message = "Path must be empty or start with /")
+	@Pattern(regexp = "^$|/.*", message = "Path must be empty or start with /")
 	private String path;
 
 	/**
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/HealthMvcEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/HealthMvcEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -25,6 +25,7 @@
 import org.springframework.boot.actuate.health.Status;
 import org.springframework.boot.bind.RelaxedNames;
 import org.springframework.boot.bind.RelaxedPropertyResolver;
+import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.EnvironmentAware;
 import org.springframework.core.env.Environment;
 import org.springframework.http.HttpStatus;
@@ -46,6 +47,7 @@
  * @author Phillip Webb
  * @since 1.1.0
  */
+@ConfigurationProperties(prefix = "endpoints.health")
 public class HealthMvcEndpoint extends AbstractEndpointMvcAdapter<HealthEndpoint>
 		implements EnvironmentAware {
 
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/JolokiaMvcEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/JolokiaMvcEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2015 the original author or authors.
+ * Copyright 2013-2016 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.
@@ -59,8 +59,8 @@ public class JolokiaMvcEndpoint implements MvcEndpoint, InitializingBean,
 	 * Endpoint URL path.
 	 */
 	@NotNull
-	@Pattern(regexp = "/[^?#]*", message = "Path must start with /")
-	private String path = "/jolokia";;
+	@Pattern(regexp = "/.*", message = "Path must start with /")
+	private String path = "/jolokia";
 
 	/**
 	 * Enable the endpoint.
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/LogFileMvcEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/LogFileMvcEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -59,7 +59,7 @@ public class LogFileMvcEndpoint implements MvcEndpoint, EnvironmentAware {
 	 * Endpoint URL path.
 	 */
 	@NotNull
-	@Pattern(regexp = "/[^/]*", message = "Path must start with /")
+	@Pattern(regexp = "/.*", message = "Path must start with /")
 	private String path = "/logfile";
 
 	/**
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MetricsMvcEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MetricsMvcEndpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2015 the original author or authors.
+ * Copyright 2012-2016 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,6 +19,7 @@
 import java.util.Map;
 
 import org.springframework.boot.actuate.endpoint.MetricsEndpoint;
+import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -34,6 +35,7 @@
  * @author Andy Wilkinson
  * @author Sergei Egorov
  */
+@ConfigurationProperties(prefix = "endpoints.metrics")
 public class MetricsMvcEndpoint extends EndpointMvcAdapter {
 
 	private final MetricsEndpoint delegate;
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpoints.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpoints.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -24,9 +24,13 @@
 import org.springframework.beans.factory.BeanFactoryUtils;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.boot.actuate.endpoint.Endpoint;
+import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationContextAware;
+import org.springframework.core.annotation.AnnotationUtils;
+import org.springframework.core.env.Environment;
 import org.springframework.stereotype.Component;
+import org.springframework.util.StringUtils;
 
 /**
  * A registry for all {@link MvcEndpoint} beans, and a factory for a set of generic ones
@@ -64,8 +68,8 @@ public void afterPropertiesSet() throws Exception {
 		for (Endpoint<?> endpoint : delegates) {
 			if (isGenericEndpoint(endpoint.getClass()) && endpoint.isEnabled()) {
 				EndpointMvcAdapter adapter = new EndpointMvcAdapter(endpoint);
-				String path = this.applicationContext.getEnvironment()
-						.getProperty("endpoints." + endpoint.getId() + ".path");
+				String path = determinePath(endpoint,
+						this.applicationContext.getEnvironment());
 				if (path != null) {
 					adapter.setPath(path);
 				}
@@ -94,4 +98,15 @@ private boolean isGenericEndpoint(Class<?> type) {
 				&& !MvcEndpoint.class.isAssignableFrom(type);
 	}
 
+	private String determinePath(Endpoint<?> endpoint, Environment environment) {
+		ConfigurationProperties configurationProperties = AnnotationUtils
+				.findAnnotation(endpoint.getClass(), ConfigurationProperties.class);
+		if (configurationProperties != null) {
+			String prefix = StringUtils.hasText(configurationProperties.prefix())
+					? configurationProperties.prefix() : configurationProperties.value();
+			return environment.getProperty(prefix + ".path");
+		}
+		return null;
+	}
+
 }
diff --git a/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/ShutdownMvcEndpoint.java b/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/endpoint/mvc/ShutdownMvcEndpoint.java
diff --git a/spring-boot-actuator/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/spring-boot-actuator/src/main/resources/META-INF/additional-spring-configuration-metadata.json
diff --git a/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/autoconfigure/MvcEndpointPathConfigurationTests.java b/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/autoconfigure/MvcEndpointPathConfigurationTests.java
diff --git a/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpointsTests.java b/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/endpoint/mvc/MvcEndpointsTests.java

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * Copyright 2012-2014 the original author or authors.`
	`2`	`+ * Copyright 2012-2016 the original author or authors.`
`3`	`3`	`*`
`4`	`4`	`* Licensed under the Apache License, Version 2.0 (the "License");`
`5`	`5`	`* you may not use this file except in compliance with the License.`
`@@ -35,7 +35,7 @@`
`35`	`35`	`*`
`36`	`36`	`* @author Dave Syer`
`37`	`37`	`*/`
`38`		`-@ConfigurationProperties(prefix = "endpoints.beans", ignoreUnknownFields = false)`
	`38`	`+@ConfigurationProperties(prefix = "endpoints.beans")`
`39`	`39`	`public class BeansEndpoint extends AbstractEndpoint<List<Object>>`
`40`	`40`	`implements ApplicationContextAware {`
`41`	`41`