org.springframework.web.reactive.accept

Class AbstractMappingContentTypeResolver

java.lang.Object

org.springframework.web.reactive.accept.AbstractMappingContentTypeResolver

All Implemented Interfaces:

MappingContentTypeResolver, RequestedContentTypeResolver

Direct Known Subclasses:

ParameterContentTypeResolver, PathExtensionContentTypeResolver

public abstract class AbstractMappingContentTypeResolver
extends Object
implements MappingContentTypeResolver

Abstract base class for MappingContentTypeResolver implementations. Maintains the actual mappings and pre-implements the overall algorithm with sub-classes left to provide a way to extract the lookup key (e.g. file extension, query parameter, etc) for a given exchange.

Since:

5.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
AbstractMappingContentTypeResolver(Map<String,org.springframework.http.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 String	extractKey(org.springframework.web.server.ServerWebExchange exchange) Extract the key to use to look up a media type from the given exchange, e.g.
protected List<org.springframework.http.MediaType>	getAllMediaTypes() Sub-classes can use this method get all mapped media types.
Set<String>	getKeys() Return all registered keys (e.g.
Set<String>	getKeysFor(org.springframework.http.MediaType mediaType) Resolve the given media type to a list of path extensions.
protected org.springframework.http.MediaType	getMediaType(String key) Sub-classes can use this method to look up a MediaType by key.
Map<String,org.springframework.http.MediaType>	getMediaTypes()
protected void	handleMatch(String key, org.springframework.http.MediaType mediaType) Override to provide handling when a key is successfully resolved via getMediaType(String).
protected org.springframework.http.MediaType	handleNoMatch(String key) Override to provide handling when a key is not resolved via.
List<org.springframework.http.MediaType>	resolveMediaTypes(org.springframework.web.server.ServerWebExchange exchange) Resolve the given request to a list of requested media types.
List<org.springframework.http.MediaType>	resolveMediaTypes(String key) An overloaded resolve method with a pre-resolved lookup key.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMappingContentTypeResolver

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

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

Method Detail

getMediaTypes

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

getMediaType

protected org.springframework.http.MediaType getMediaType(String key)

Sub-classes can use this method to look up a MediaType by key.

Parameters:

key - the key converted to lower case

Returns:

a MediaType or null

getAllMediaTypes

protected List<org.springframework.http.MediaType> getAllMediaTypes()

Sub-classes can use this method get all mapped media types.

resolveMediaTypes

public List<org.springframework.http.MediaType> resolveMediaTypes(org.springframework.web.server.ServerWebExchange exchange)
                                                           throws org.springframework.web.server.NotAcceptableStatusException

Description copied from interface: RequestedContentTypeResolver

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

Specified by:

resolveMediaTypes in interface RequestedContentTypeResolver

Parameters:

exchange - the current exchange

Returns:

the requested media types or an empty list

Throws:

org.springframework.web.server.NotAcceptableStatusException - if the requested media types is invalid

resolveMediaTypes

public List<org.springframework.http.MediaType> resolveMediaTypes(String key)
                                                           throws org.springframework.web.server.NotAcceptableStatusException

An overloaded resolve method with a pre-resolved lookup key.

Parameters:

key - the key for looking up media types

Returns:

a list of resolved media types or an empty list

Throws:

org.springframework.web.server.NotAcceptableStatusException

extractKey

protected abstract String extractKey(org.springframework.web.server.ServerWebExchange exchange)

Extract the key to use to look up a media type from the given exchange, e.g. file extension, query parameter, etc.

Returns:

the key or null

handleMatch

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

Override to provide handling when a key is successfully resolved via getMediaType(String).

handleNoMatch

protected org.springframework.http.MediaType handleNoMatch(String key)
                                                    throws org.springframework.web.server.NotAcceptableStatusException

Override to provide handling when a key is not resolved via. getMediaType(String). If a MediaType is returned from this method it will be added to the mappings.

Throws:

org.springframework.web.server.NotAcceptableStatusException

getKeysFor

public Set<String> getKeysFor(org.springframework.http.MediaType mediaType)

Description copied from interface: MappingContentTypeResolver

Resolve the given media type to a list of path extensions.

Specified by:

getKeysFor in interface MappingContentTypeResolver

Parameters:

mediaType - the media type to resolve

Returns:

a list of extensions or an empty list, never null

getKeys

public Set<String> getKeys()

Description copied from interface: MappingContentTypeResolver

Return all registered keys (e.g. "json", "xml").

Specified by:

getKeys in interface MappingContentTypeResolver

Returns:

a list of keys or an empty list, never null