org.tinygroup.springmvc.negotiation.impl

Class AbstractMappingContentNegotiationStrategy

java.lang.Object

org.tinygroup.springmvc.negotiation.impl.MappingTinyMediaTypeFileExtensionResolver

org.tinygroup.springmvc.negotiation.impl.AbstractMappingContentNegotiationStrategy

All Implemented Interfaces:

ContentNegotiationStrategy, MediaTypeFileExtensionResolver

Direct Known Subclasses:

ParameterContentNegotiationStrategy, PathExtensionContentNegotiationStrategy

public abstract class AbstractMappingContentNegotiationStrategy
extends MappingTinyMediaTypeFileExtensionResolver
implements ContentNegotiationStrategy, MediaTypeFileExtensionResolver

A base class for ContentNegotiationStrategy types that maintain a map with keys such as "json" and media types such as "application/json".

Author:

renhui

Constructor Summary

Constructors

Constructor and Description
AbstractMappingContentNegotiationStrategy(Map<String,org.springframework.http.MediaType> mediaTypes) Create an instance with the given extension-to-MediaType lookup.

Method Summary

Modifier and Type	Method and Description
protected abstract String	getMediaTypeKey(org.springframework.web.context.request.NativeWebRequest request) Sub-classes must extract the key to use to look up a media type.
protected void	handleMatch(String mappingKey, org.springframework.http.MediaType mediaType) Invoked when a matching media type is found in the lookup map.
protected org.springframework.http.MediaType	handleNoMatch(org.springframework.web.context.request.NativeWebRequest request, String key) Invoked when no matching media type is found in the lookup map.
List<org.springframework.http.MediaType>	resolveMediaTypes(org.springframework.web.context.request.NativeWebRequest webRequest) Resolve the given request to a list of media types.

Methods inherited from class org.tinygroup.springmvc.negotiation.impl.MappingTinyMediaTypeFileExtensionResolver

addMapping, getAllFileExtensions, getAllMediaTypes, lookupMediaType, resolveFileExtensions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tinygroup.springmvc.negotiation.MediaTypeFileExtensionResolver

getAllFileExtensions, resolveFileExtensions

Constructor Detail

AbstractMappingContentNegotiationStrategy

public AbstractMappingContentNegotiationStrategy(Map<String,org.springframework.http.MediaType> mediaTypes)

Create an instance with the given extension-to-MediaType lookup.

Throws:

IllegalArgumentException - if a media type string cannot be parsed

Method Detail

resolveMediaTypes

public List<org.springframework.http.MediaType> resolveMediaTypes(org.springframework.web.context.request.NativeWebRequest webRequest)
                                                           throws org.springframework.web.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:

org.springframework.web.HttpMediaTypeNotAcceptableException - if the requested media types cannot be parsed

getMediaTypeKey

protected abstract String getMediaTypeKey(org.springframework.web.context.request.NativeWebRequest request)

Sub-classes must extract the key to use to look up a media type.

Returns:

the lookup key or null if the key cannot be derived

handleMatch

protected void handleMatch(String mappingKey,
                           org.springframework.http.MediaType mediaType)

Invoked when a matching media type is found in the lookup map.

handleNoMatch

protected org.springframework.http.MediaType handleNoMatch(org.springframework.web.context.request.NativeWebRequest request,
                                                           String key)
                                                    throws org.springframework.web.HttpMediaTypeNotAcceptableException

Invoked when no matching media type is found in the lookup map. Sub-classes can take further steps to determine the media type.

Throws:

org.springframework.web.HttpMediaTypeNotAcceptableException