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 java.lang.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

Field Summary

Fields

Modifier and Type	Field and Description
private MultiValueMap<MediaType,java.lang.String>	keyLookup Reverse lookup for keys associated with a media type
private java.util.Map<java.lang.String,MediaType>	mediaTypeLookup Primary lookup for media types by key (e.g.

Constructor Summary

Constructors

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

Field Detail

mediaTypeLookup

private final java.util.Map<java.lang.String,MediaType> mediaTypeLookup

Primary lookup for media types by key (e.g. "json" -> "application/json")

keyLookup

private final MultiValueMap<MediaType,java.lang.String> keyLookup

Reverse lookup for keys associated with a media type

Constructor Detail

AbstractMappingContentTypeResolver

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

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

Method Detail

getMediaTypes

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

getMediaType

protected MediaType getMediaType(java.lang.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 java.util.List<MediaType> getAllMediaTypes()

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

resolveMediaTypes

public java.util.List<MediaType> resolveMediaTypes(ServerWebExchange exchange)
                                            throws 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:

NotAcceptableStatusException - if the requested media types is invalid

resolveMediaTypes

public java.util.List<MediaType> resolveMediaTypes(java.lang.String key)
                                            throws 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:

NotAcceptableStatusException

extractKey

protected abstract java.lang.String extractKey(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(java.lang.String key,
                           MediaType mediaType)

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

handleNoMatch

protected MediaType handleNoMatch(java.lang.String key)
                           throws 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:

NotAcceptableStatusException

getKeysFor

public java.util.Set<java.lang.String> getKeysFor(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 java.util.Set<java.lang.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