org.springframework.web.accept

Class AbstractMappingContentNegotiationStrategy

java.lang.Object

org.springframework.web.accept.MappingMediaTypeFileExtensionResolver

org.springframework.web.accept.AbstractMappingContentNegotiationStrategy

All Implemented Interfaces:

ContentNegotiationStrategy, MediaTypeFileExtensionResolver

Direct Known Subclasses:

ParameterContentNegotiationStrategy, PathExtensionContentNegotiationStrategy

public abstract class AbstractMappingContentNegotiationStrategy
extends MappingMediaTypeFileExtensionResolver
implements ContentNegotiationStrategy

Base class for ContentNegotiationStrategy implementations with the steps to resolve a request to media types.

First a key (e.g. "json", "pdf") must be extracted from the request (e.g. file extension, query param). The key must then be resolved to media type(s) through the base class MappingMediaTypeFileExtensionResolver which stores such mappings.

The method handleNoMatch(org.springframework.web.context.request.NativeWebRequest, java.lang.String) allow sub-classes to plug in additional ways of looking up media types (e.g. through the Java Activation framework, or javax.servlet.ServletContext#getMimeType. Media types resolved via base classes are then added to the base class MappingMediaTypeFileExtensionResolver, i.e. cached for new lookups.

Since:

3.2

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
AbstractMappingContentNegotiationStrategy(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 abstract java.lang.String	getMediaTypeKey(NativeWebRequest request) Extract a key from the request to use to look up media types.
protected void	handleMatch(java.lang.String key, MediaType mediaType) Override to provide handling when a key is successfully resolved via MappingMediaTypeFileExtensionResolver.lookupMediaType(java.lang.String).
protected MediaType	handleNoMatch(NativeWebRequest request, java.lang.String key) Override to provide handling when a key is not resolved via.
java.util.List<MediaType>	resolveMediaTypeKey(NativeWebRequest webRequest, java.lang.String key) An alternative to resolveMediaTypes(NativeWebRequest) that accepts an already extracted key.
java.util.List<MediaType>	resolveMediaTypes(NativeWebRequest webRequest) Resolve the given request to a list of media types.

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

AbstractMappingContentNegotiationStrategy

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

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

Method Detail

resolveMediaTypes

public java.util.List<MediaType> resolveMediaTypes(NativeWebRequest webRequest)
                                            throws HttpMediaTypeNotAcceptableException

Description copied from interface: ContentNegotiationStrategy

Resolve the given request to a list of media types. The returned list is ordered by specificity first and by quality parameter second.

Specified by:

resolveMediaTypes in interface ContentNegotiationStrategy

Parameters:

webRequest - the current request

Returns:

the requested media types or an empty list, never null

Throws:

HttpMediaTypeNotAcceptableException - if the requested media types cannot be parsed

resolveMediaTypeKey

public java.util.List<MediaType> resolveMediaTypeKey(NativeWebRequest webRequest,
                                                     java.lang.String key)
                                              throws HttpMediaTypeNotAcceptableException

An alternative to resolveMediaTypes(NativeWebRequest) that accepts an already extracted key.

Throws:

HttpMediaTypeNotAcceptableException

Since:

3.2.16

getMediaTypeKey

protected abstract java.lang.String getMediaTypeKey(NativeWebRequest request)

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

Returns:

the lookup key or null.

handleMatch

protected void handleMatch(java.lang.String key,
                           MediaType mediaType)

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

handleNoMatch

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

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.

Throws:

HttpMediaTypeNotAcceptableException