org.springframework.web.reactive.accept

Class ParameterContentTypeResolver

java.lang.Object

org.springframework.web.reactive.accept.AbstractMappingContentTypeResolver

org.springframework.web.reactive.accept.ParameterContentTypeResolver

All Implemented Interfaces:

MappingContentTypeResolver, RequestedContentTypeResolver

public class ParameterContentTypeResolver
extends AbstractMappingContentTypeResolver

A RequestedContentTypeResolver that extracts the media type lookup key from a known query parameter named "format" by default.

Since:

5.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
ParameterContentTypeResolver(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 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.
String	getParameterName()
protected void	handleMatch(String mediaTypeKey, org.springframework.http.MediaType mediaType) Override to provide handling when a key is successfully resolved via AbstractMappingContentTypeResolver.getMediaType(String).
protected org.springframework.http.MediaType	handleNoMatch(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.reactive.accept.AbstractMappingContentTypeResolver

getAllMediaTypes, getKeys, getKeysFor, getMediaType, getMediaTypes, resolveMediaTypes, resolveMediaTypes

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterContentTypeResolver

public ParameterContentTypeResolver(Map<String,org.springframework.http.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()

extractKey

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

Description copied from class: AbstractMappingContentTypeResolver

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

Specified by:

extractKey in class AbstractMappingContentTypeResolver

Returns:

the key or null

handleMatch

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

Description copied from class: AbstractMappingContentTypeResolver

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

Overrides:

handleMatch in class AbstractMappingContentTypeResolver

handleNoMatch

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

Description copied from class: AbstractMappingContentTypeResolver

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

Overrides:

handleNoMatch in class AbstractMappingContentTypeResolver

Throws:

org.springframework.web.server.NotAcceptableStatusException