Ensure media types are used consistently across endpoint mappings

Previously, the media types that are consumed and produced by
endpoints were configured in the web stack-specific configuration.
Furthermore, these configured media types were not used for the
discovery "endpoint" that links to all the available endpoints.

This commit introduces EndpointMediaTypes that is configred in a
single, central location and then used to configure the consumed and
produced media types for endpoints exposed via WebFlux, Web MVC, and
Jersey as well as the discovery "endpoint" provided by each.

Closes gh-10659

Author: wilkinsona

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/cloudfoundry/CloudFoundryActuatorAutoConfiguration.java

@@ -20,6 +20,7 @@
 
 import org.springframework.boot.actuate.autoconfigure.endpoint.EndpointProvider;
 import org.springframework.boot.actuate.autoconfigure.web.servlet.ServletManagementContextAutoConfiguration;
+import org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes;
 import org.springframework.boot.actuate.endpoint.web.WebEndpointOperation;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
@@ -67,11 +68,12 @@ static class MvcWebEndpointConfiguration {
 
 		@Bean
 		public CloudFoundryWebEndpointServletHandlerMapping cloudFoundryWebEndpointServletHandlerMapping(
-				EndpointProvider<WebEndpointOperation> provider, Environment environment,
+				EndpointProvider<WebEndpointOperation> provider,
+				EndpointMediaTypes endpointMediaTypes, Environment environment,
 				RestTemplateBuilder builder) {
 			return new CloudFoundryWebEndpointServletHandlerMapping(
 					new EndpointMapping("/cloudfoundryapplication"),
-					provider.getEndpoints(), getCorsConfiguration(),
+					provider.getEndpoints(), endpointMediaTypes, getCorsConfiguration(),
 					getSecurityInterceptor(builder, environment));
 		}
 

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/cloudfoundry/CloudFoundryWebEndpointServletHandlerMapping.java

@@ -36,6 +36,7 @@
 import org.springframework.boot.actuate.endpoint.ParameterMappingException;
 import org.springframework.boot.actuate.endpoint.ParametersMissingException;
 import org.springframework.boot.actuate.endpoint.web.EndpointLinksResolver;
+import org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes;
 import org.springframework.boot.actuate.endpoint.web.Link;
 import org.springframework.boot.actuate.endpoint.web.WebEndpointOperation;
 import org.springframework.boot.actuate.endpoint.web.WebEndpointResponse;
@@ -76,9 +77,9 @@ class CloudFoundryWebEndpointServletHandlerMapping
 
 	CloudFoundryWebEndpointServletHandlerMapping(EndpointMapping endpointMapping,
 			Collection<EndpointInfo<WebEndpointOperation>> webEndpoints,
-			CorsConfiguration corsConfiguration,
+			EndpointMediaTypes endpointMediaTypes, CorsConfiguration corsConfiguration,
 			CloudFoundrySecurityInterceptor securityInterceptor) {
-		super(endpointMapping, webEndpoints, corsConfiguration);
+		super(endpointMapping, webEndpoints, endpointMediaTypes, corsConfiguration);
 		this.securityInterceptor = securityInterceptor;
 	}
 

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/EndpointAutoConfiguration.java

@@ -25,6 +25,7 @@
 import org.springframework.boot.actuate.endpoint.cache.CachingConfigurationFactory;
 import org.springframework.boot.actuate.endpoint.convert.ConversionServiceOperationParameterMapper;
 import org.springframework.boot.actuate.endpoint.http.ActuatorMediaType;
+import org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes;
 import org.springframework.boot.actuate.endpoint.web.WebEndpointOperation;
 import org.springframework.boot.actuate.endpoint.web.annotation.WebAnnotationEndpointDiscoverer;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
@@ -71,14 +72,19 @@ static class EndpointWebConfiguration {
 			this.applicationContext = applicationContext;
 		}
 
+		@Bean
+		public EndpointMediaTypes endpointMediaTypes() {
+			return new EndpointMediaTypes(MEDIA_TYPES, MEDIA_TYPES);
+		}
+
 		@Bean
 		public EndpointProvider<WebEndpointOperation> webEndpointProvider(
 				OperationParameterMapper parameterMapper,
 				DefaultCachingConfigurationFactory cachingConfigurationFactory) {
 			Environment environment = this.applicationContext.getEnvironment();
 			WebAnnotationEndpointDiscoverer endpointDiscoverer = new WebAnnotationEndpointDiscoverer(
 					this.applicationContext, parameterMapper, cachingConfigurationFactory,
-					MEDIA_TYPES, MEDIA_TYPES);
+					endpointMediaTypes());
 			return new EndpointProvider<>(environment, endpointDiscoverer,
 					EndpointExposure.WEB);
 		}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/jersey/JerseyWebEndpointManagementContextConfiguration.java

@@ -26,6 +26,7 @@
 import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;
 import org.springframework.boot.actuate.autoconfigure.web.ManagementContextConfiguration;
 import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
+import org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes;
 import org.springframework.boot.actuate.endpoint.web.WebEndpointOperation;
 import org.springframework.boot.actuate.endpoint.web.jersey.JerseyEndpointResourceFactory;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@@ -55,11 +56,12 @@ class JerseyWebEndpointManagementContextConfiguration {
 	@Bean
 	public ResourceConfigCustomizer webEndpointRegistrar(
 			EndpointProvider<WebEndpointOperation> provider,
+			EndpointMediaTypes endpointMediaTypes,
 			WebEndpointProperties webEndpointProperties) {
 		return (resourceConfig) -> resourceConfig.registerResources(
 				new HashSet<>(new JerseyEndpointResourceFactory().createEndpointResources(
 						new EndpointMapping(webEndpointProperties.getBasePath()),
-						provider.getEndpoints())));
+						provider.getEndpoints(), endpointMediaTypes)));
 	}
 
 	@Bean

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/reactive/WebFluxEndpointManagementContextConfiguration.java

@@ -22,6 +22,7 @@
 import org.springframework.boot.actuate.autoconfigure.endpoint.web.WebEndpointProperties;
 import org.springframework.boot.actuate.autoconfigure.web.ManagementContextConfiguration;
 import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
+import org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes;
 import org.springframework.boot.actuate.endpoint.web.WebEndpointOperation;
 import org.springframework.boot.actuate.endpoint.web.reactive.WebFluxEndpointHandlerMapping;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
@@ -45,10 +46,11 @@ public class WebFluxEndpointManagementContextConfiguration {
 	@ConditionalOnMissingBean
 	public WebFluxEndpointHandlerMapping webEndpointReactiveHandlerMapping(
 			EndpointProvider<WebEndpointOperation> provider,
+			EndpointMediaTypes endpointMediaTypes,
 			WebEndpointProperties webEndpointProperties) {
 		return new WebFluxEndpointHandlerMapping(
 				new EndpointMapping(webEndpointProperties.getBasePath()),
-				provider.getEndpoints());
+				provider.getEndpoints(), endpointMediaTypes);
 	}
 
 	@Bean

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/servlet/WebMvcEndpointManagementContextConfiguration.java

@@ -23,6 +23,7 @@
 import org.springframework.boot.actuate.autoconfigure.web.ManagementContextConfiguration;
 import org.springframework.boot.actuate.autoconfigure.web.server.ManagementServerProperties;
 import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
+import org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes;
 import org.springframework.boot.actuate.endpoint.web.WebEndpointOperation;
 import org.springframework.boot.actuate.endpoint.web.servlet.WebMvcEndpointHandlerMapping;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@@ -56,11 +57,12 @@ public class WebMvcEndpointManagementContextConfiguration {
 	@ConditionalOnMissingBean
 	public WebMvcEndpointHandlerMapping webEndpointServletHandlerMapping(
 			EndpointProvider<WebEndpointOperation> provider,
+			EndpointMediaTypes endpointMediaTypes,
 			CorsEndpointProperties corsProperties,
 			WebEndpointProperties webEndpointProperties) {
 		WebMvcEndpointHandlerMapping handlerMapping = new WebMvcEndpointHandlerMapping(
 				new EndpointMapping(webEndpointProperties.getBasePath()),
-				provider.getEndpoints(), getCorsConfiguration(corsProperties));
+				provider.getEndpoints(), endpointMediaTypes, getCorsConfiguration(corsProperties));
 		return handlerMapping;
 	}
 

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

@@ -25,6 +25,7 @@
 import org.springframework.boot.actuate.autoconfigure.endpoint.EndpointAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.web.server.ManagementContextAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.web.servlet.ServletManagementContextAutoConfiguration;
+import org.springframework.boot.actuate.endpoint.http.ActuatorMediaType;
 import org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration;
 import org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration;
 import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration;
@@ -40,11 +41,15 @@
 import org.springframework.security.web.FilterChainProxy;
 import org.springframework.security.web.SecurityFilterChain;
 import org.springframework.test.util.ReflectionTestUtils;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.setup.MockMvcBuilders;
 import org.springframework.web.client.RestTemplate;
 import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
 import org.springframework.web.cors.CorsConfiguration;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header;
 
 /**
  * Tests for {@link CloudFoundryActuatorAutoConfiguration}.
@@ -92,6 +97,18 @@ public void cloudFoundryPlatformActive() throws Exception {
 				Arrays.asList("Authorization", "X-Cf-App-Instance", "Content-Type"));
 	}
 
+	@Test
+	public void cloudfoundryapplicationProducesActuatorMediaType() throws Exception {
+		TestPropertyValues
+				.of("VCAP_APPLICATION:---", "vcap.application.application_id:my-app-id",
+						"vcap.application.cf_api:http://my-cloud-controller.com")
+				.applyTo(this.context);
+		this.context.refresh();
+		MockMvc mockMvc = MockMvcBuilders.webAppContextSetup(this.context).build();
+		mockMvc.perform(get("/cloudfoundryapplication")).andExpect(header()
+				.string("Content-Type", ActuatorMediaType.V2_JSON + ";charset=UTF-8"));
+	}
+
 	@Test
 	public void cloudFoundryPlatformActiveSetsApplicationId() throws Exception {
 		CloudFoundryWebEndpointServletHandlerMapping handlerMapping = getHandlerMapping();

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

@@ -31,6 +31,7 @@
 import org.springframework.boot.actuate.endpoint.annotation.WriteOperation;
 import org.springframework.boot.actuate.endpoint.cache.CachingConfiguration;
 import org.springframework.boot.actuate.endpoint.convert.ConversionServiceOperationParameterMapper;
+import org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes;
 import org.springframework.boot.actuate.endpoint.web.annotation.WebAnnotationEndpointDiscoverer;
 import org.springframework.boot.endpoint.web.EndpointMapping;
 import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
@@ -190,28 +191,35 @@ public CloudFoundrySecurityInterceptor interceptor() {
 					"app-id");
 		}
 
+		@Bean
+		public EndpointMediaTypes EndpointMediaTypes() {
+			return new EndpointMediaTypes(Collections.singletonList("application/json"),
+					Collections.singletonList("application/json"));
+		}
+
 		@Bean
 		public CloudFoundryWebEndpointServletHandlerMapping cloudFoundryWebEndpointServletHandlerMapping(
 				WebAnnotationEndpointDiscoverer webEndpointDiscoverer,
+				EndpointMediaTypes endpointMediaTypes,
 				CloudFoundrySecurityInterceptor interceptor) {
 			CorsConfiguration corsConfiguration = new CorsConfiguration();
 			corsConfiguration.setAllowedOrigins(Arrays.asList("http://example.com"));
 			corsConfiguration.setAllowedMethods(Arrays.asList("GET", "POST"));
 			return new CloudFoundryWebEndpointServletHandlerMapping(
 					new EndpointMapping("/cfApplication"),
-					webEndpointDiscoverer.discoverEndpoints(), corsConfiguration,
-					interceptor);
+					webEndpointDiscoverer.discoverEndpoints(), endpointMediaTypes,
+					corsConfiguration, interceptor);
 		}
 
 		@Bean
 		public WebAnnotationEndpointDiscoverer webEndpointDiscoverer(
-				ApplicationContext applicationContext) {
+				ApplicationContext applicationContext,
+				EndpointMediaTypes endpointMediaTypes) {
 			OperationParameterMapper parameterMapper = new ConversionServiceOperationParameterMapper(
 					DefaultConversionService.getSharedInstance());
 			return new WebAnnotationEndpointDiscoverer(applicationContext,
 					parameterMapper, (id) -> new CachingConfiguration(0),
-					Collections.singletonList("application/json"),
-					Collections.singletonList("application/json"));
+					endpointMediaTypes);
 		}
 
 		@Bean

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/EndpointAutoConfigurationTests.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2012-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.boot.actuate.autoconfigure.endpoint;
+
+import org.junit.Test;
+
+import org.springframework.boot.actuate.endpoint.http.ActuatorMediaType;
+import org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes;
+import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.test.context.runner.WebApplicationContextRunner;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link EndpointAutoConfiguration}.
+ *
+ * @author Andy Wilkinson
+ */
+public class EndpointAutoConfigurationTests {
+
+	@Test
+	public void webApplicationConfiguresEndpointMediaTypes() {
+		new WebApplicationContextRunner()
+				.withConfiguration(AutoConfigurations.of(EndpointAutoConfiguration.class))
+				.run((context) -> {
+					EndpointMediaTypes endpointMediaTypes = context
+							.getBean(EndpointMediaTypes.class);
+					assertThat(endpointMediaTypes.getConsumed()).containsExactly(
+							ActuatorMediaType.V2_JSON, "application/json");
+				});
+	}
+
+}

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/web/servlet/RequestMappingEndpointTests.java

@@ -16,6 +16,7 @@
 
 package org.springframework.boot.actuate.autoconfigure.web.servlet;
 
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.Map;
 
@@ -24,6 +25,7 @@
 import org.springframework.boot.actuate.endpoint.DefaultEnablement;
 import org.springframework.boot.actuate.endpoint.EndpointInfo;
 import org.springframework.boot.actuate.endpoint.OperationType;
+import org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes;
 import org.springframework.boot.actuate.endpoint.web.OperationRequestPredicate;
 import org.springframework.boot.actuate.endpoint.web.WebEndpointHttpMethod;
 import org.springframework.boot.actuate.endpoint.web.WebEndpointOperation;
@@ -142,7 +144,9 @@ private WebMvcEndpointHandlerMapping createHandlerMapping() {
 		WebMvcEndpointHandlerMapping mapping = new WebMvcEndpointHandlerMapping(
 				new EndpointMapping("application"),
 				Collections.singleton(new EndpointInfo<>("test",
-						DefaultEnablement.ENABLED, Collections.singleton(operation))));
+						DefaultEnablement.ENABLED, Collections.singleton(operation))),
+				new EndpointMediaTypes(Arrays.asList("application/vnd.test+json"),
+						Arrays.asList("application/vnd.test+json")));
 		mapping.setApplicationContext(new StaticApplicationContext());
 		mapping.afterPropertiesSet();
 		return mapping;