Support for multiple default content types

Enhance FixedContentNegotiationStrategy and places where it is exposed
to also accept a list of media types.

Issue: SPR-15367
This commit is contained in:
Ryan O'Meara
2017-03-21 00:53:26 -04:00
committed by Rossen Stoyanchev
parent 95e78b16f7
commit 4a890226ea
5 changed files with 60 additions and 17 deletions

View File

@@ -233,8 +233,8 @@ public class ContentNegotiationManagerFactoryBean
* <p>By default this is not set.
* @see #setDefaultContentTypeStrategy
*/
public void setDefaultContentType(MediaType contentType) {
this.defaultNegotiationStrategy = new FixedContentNegotiationStrategy(contentType);
public void setDefaultContentType(List<MediaType> contentTypes) {
this.defaultNegotiationStrategy = new FixedContentNegotiationStrategy(contentTypes);
}
/**

View File

@@ -16,12 +16,11 @@
package org.springframework.web.accept;
import java.util.Collections;
import java.util.Arrays;
import java.util.List;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.http.MediaType;
import org.springframework.web.context.request.NativeWebRequest;
@@ -35,23 +34,36 @@ public class FixedContentNegotiationStrategy implements ContentNegotiationStrate
private static final Log logger = LogFactory.getLog(FixedContentNegotiationStrategy.class);
private final List<MediaType> contentType;
private final List<MediaType> contentTypes;
/**
* Create an instance with the given content type.
*/
public FixedContentNegotiationStrategy(MediaType contentType) {
this.contentType = Collections.singletonList(contentType);
public FixedContentNegotiationStrategy(MediaType... contentTypes) {
this.contentTypes = Arrays.asList(contentTypes);
}
/**
* Create an instance with the given content type.
*
* <p>
* List is ordered in the same manner as a "quality" parameter on incoming requests.
* If destinations which do not support any of the media types provided are present,
* end the list with {@link MediaType#ALL} to allow standard media type determination
*/
public FixedContentNegotiationStrategy(List<MediaType> contentTypes) {
this.contentTypes = contentTypes;
}
@Override
public List<MediaType> resolveMediaTypes(NativeWebRequest request) {
if (logger.isDebugEnabled()) {
logger.debug("Requested media types: " + this.contentType);
logger.debug("Requested media types: " + this.contentTypes);
}
return this.contentType;
return this.contentTypes;
}
}

View File

@@ -16,13 +16,13 @@
package org.springframework.web.accept;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.junit.Before;
import org.junit.Test;
import org.springframework.http.MediaType;
import org.springframework.mock.web.test.MockHttpServletRequest;
import org.springframework.mock.web.test.MockServletContext;
@@ -161,10 +161,10 @@ public class ContentNegotiationManagerFactoryBeanTests {
assertEquals(Collections.<MediaType>emptyList(), manager.resolveMediaTypes(this.webRequest));
}
@Test
public void setDefaultContentType() throws Exception {
this.factoryBean.setDefaultContentType(MediaType.APPLICATION_JSON);
this.factoryBean.setDefaultContentType(Arrays.asList(MediaType.APPLICATION_JSON));
this.factoryBean.afterPropertiesSet();
ContentNegotiationManager manager = this.factoryBean.getObject();
@@ -176,6 +176,21 @@ public class ContentNegotiationManagerFactoryBeanTests {
assertEquals(Collections.singletonList(MediaType.APPLICATION_JSON),
manager.resolveMediaTypes(this.webRequest));
}
@Test
public void setMultipleDefaultContentTypess() throws Exception {
this.factoryBean.setDefaultContentType(Arrays.asList(MediaType.APPLICATION_JSON, MediaType.ALL));
this.factoryBean.afterPropertiesSet();
ContentNegotiationManager manager = this.factoryBean.getObject();
assertEquals(Arrays.asList(MediaType.APPLICATION_JSON, MediaType.ALL),
manager.resolveMediaTypes(this.webRequest));
// SPR-15367
this.servletRequest.addHeader("Accept", MediaType.ALL_VALUE);
assertEquals(Arrays.asList(MediaType.APPLICATION_JSON, MediaType.ALL),
manager.resolveMediaTypes(this.webRequest));
}
@Test // SPR-12286
public void setDefaultContentTypeWithStrategy() throws Exception {