org.springframework.web.accept

Class ParameterContentNegotiationStrategy

java.lang.Object

org.springframework.web.accept.MappingMediaTypeFileExtensionResolver

org.springframework.web.accept.AbstractMappingContentNegotiationStrategy

org.springframework.web.accept.ParameterContentNegotiationStrategy

All Implemented Interfaces:

ContentNegotiationStrategy, MediaTypeFileExtensionResolver

public class ParameterContentNegotiationStrategy
extends AbstractMappingContentNegotiationStrategy

Strategy that resolves the requested content type from a query parameter. The default query parameter name is "format".

You can register static mappings between keys (i.e. the expected value of the query parameter) and MediaType's via MappingMediaTypeFileExtensionResolver.addMapping(String, MediaType). As of 5.0 this strategy also supports dynamic lookups of keys via MediaTypeFactory.getMediaType(org.springframework.core.io.Resource).

Since:

3.2

Author:

Rossen Stoyanchev

Field Summary

Fields inherited from class org.springframework.web.accept.AbstractMappingContentNegotiationStrategy

logger

Constructor Summary

Constructors

Constructor and Description
ParameterContentNegotiationStrategy(java.util.Map<java.lang.String,MediaType> mediaTypes) Create an instance with the given map of file extensions and media types.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getMediaTypeKey(NativeWebRequest request) Extract a key from the request to use to look up media types.
java.lang.String	getParameterName()
void	setParameterName(java.lang.String parameterName) Set the name of the parameter to use to determine requested media types.

Methods inherited from class org.springframework.web.accept.AbstractMappingContentNegotiationStrategy

handleMatch, handleNoMatch, isIgnoreUnknownExtensions, isUseRegisteredExtensionsOnly, resolveMediaTypeKey, resolveMediaTypes, setIgnoreUnknownExtensions, setUseRegisteredExtensionsOnly

Methods inherited from class org.springframework.web.accept.MappingMediaTypeFileExtensionResolver

addMapping, getAllFileExtensions, getAllMediaTypes, getMediaTypes, lookupMediaType, resolveFileExtensions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParameterContentNegotiationStrategy

public ParameterContentNegotiationStrategy(java.util.Map<java.lang.String,MediaType> mediaTypes)

Create an instance with the given map of file extensions and media types.

Method Detail

setParameterName

public void setParameterName(java.lang.String parameterName)

Set the name of the parameter to use to determine requested media types.

By default this is set to "format".

getParameterName

public java.lang.String getParameterName()

getMediaTypeKey

@Nullable
protected java.lang.String getMediaTypeKey(NativeWebRequest request)

Description copied from class: AbstractMappingContentNegotiationStrategy

Extract a key from the request to use to look up media types.

Specified by:

getMediaTypeKey in class AbstractMappingContentNegotiationStrategy

Returns:

the lookup key, or null if none