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

A ContentNegotiationStrategy that resolves a query parameter to a key to be used to look up a media type. The default parameter name is format. s

Since:

3.2

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
ParameterContentNegotiationStrategy(Map<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 String	getMediaTypeKey(NativeWebRequest request) Extract a key from the request to use to look up media types.
String	getParameterName()
protected void	handleMatch(String mediaTypeKey, MediaType mediaType) Override to provide handling when a key is successfully resolved via MappingMediaTypeFileExtensionResolver.lookupMediaType(java.lang.String).
protected MediaType	handleNoMatch(NativeWebRequest request, String key) Override to provide handling when a key is not resolved via.
void	setParameterName(String parameterName) Set the name of the parameter to use to determine requested media types.

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

resolveMediaTypeKey, resolveMediaTypes

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

addMapping, getAllFileExtensions, getAllMediaTypes, 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(Map<String,MediaType> mediaTypes)

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

Method Detail

setParameterName

public void setParameterName(String parameterName)

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

By default this is set to "format".

getParameterName

public String getParameterName()

getMediaTypeKey

protected 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.

handleMatch

protected void handleMatch(String mediaTypeKey,
                           MediaType mediaType)

Description copied from class: AbstractMappingContentNegotiationStrategy

Override to provide handling when a key is successfully resolved via MappingMediaTypeFileExtensionResolver.lookupMediaType(java.lang.String).

Overrides:

handleMatch in class AbstractMappingContentNegotiationStrategy

handleNoMatch

protected MediaType handleNoMatch(NativeWebRequest request,
                                  String key)
                           throws HttpMediaTypeNotAcceptableException

Description copied from class: AbstractMappingContentNegotiationStrategy

Override to provide handling when a key is not resolved via. MappingMediaTypeFileExtensionResolver.lookupMediaType(java.lang.String). Sub-classes can take further steps to determine the media type(s). If a MediaType is returned from this method it will be added to the cache in the base class.

Overrides:

handleNoMatch in class AbstractMappingContentNegotiationStrategy

Throws:

HttpMediaTypeNotAcceptableException