org.springframework.web.reactive.accept

Class RequestedContentTypeResolverBuilder

java.lang.Object

org.springframework.web.reactive.accept.RequestedContentTypeResolverBuilder

public class RequestedContentTypeResolverBuilder
extends java.lang.Object

Factory to create a CompositeContentTypeResolver and configure it with one or more RequestedContentTypeResolver instances with build style methods. The following table shows methods, resulting strategy instances, and if in use by default:

Property Setter	Underlying Strategy	Default Setting
favorPathExtension	Path Extension resolver	On
favorParameter	Parameter resolver	Off
ignoreAcceptHeader	Header resolver	Off
defaultContentType(org.springframework.http.MediaType)	Fixed content resolver	Not set
defaultContentTypeResolver(org.springframework.web.reactive.accept.RequestedContentTypeResolver)	RequestedContentTypeResolver	Not set

The order in which resolvers are configured is fixed. Config methods may only turn individual resolvers on or off. If you need a custom order for any reason simply instantiate {@link CompositeContentTypeResolver} directly.

For the path extension and parameter resolvers you may explicitly add mediaTypes(Map). This will be used to resolve path extensions or a parameter value such as "json" to a media type such as "application/json".

The path extension strategy will also use the Java Activation framework (JAF), if available, to resolve a path extension to a MediaType. You may suppress the use of JAF.

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private RequestedContentTypeResolver	contentTypeResolver
private boolean	favorParameter
private boolean	favorPathExtension
private boolean	ignoreAcceptHeader
private boolean	ignoreUnknownPathExtensions
private java.util.Map<java.lang.String,MediaType>	mediaTypes
private java.lang.String	parameterName
private java.lang.Boolean	useJaf

Constructor Summary

Constructors

Constructor and Description
RequestedContentTypeResolverBuilder()

Method Summary

Modifier and Type	Method and Description
CompositeContentTypeResolver	build()
RequestedContentTypeResolverBuilder	defaultContentType(MediaType contentType) Set the default content type to use when no content type is requested.
RequestedContentTypeResolverBuilder	defaultContentTypeResolver(RequestedContentTypeResolver resolver) Set a custom RequestedContentTypeResolver to use to determine the content type to use when no content type is requested.
RequestedContentTypeResolverBuilder	favorParameter(boolean favorParameter) Whether a request parameter ("format" by default) should be used to determine the requested media type.
RequestedContentTypeResolverBuilder	favorPathExtension(boolean favorPathExtension) Whether the path extension in the URL path should be used to determine the requested media type.
RequestedContentTypeResolverBuilder	ignoreAcceptHeader(boolean ignoreAcceptHeader) Whether to disable checking the 'Accept' request header.
RequestedContentTypeResolverBuilder	ignoreUnknownPathExtensions(boolean ignore) Whether to ignore requests with path extension that cannot be resolved to any media type.
RequestedContentTypeResolverBuilder	mediaType(java.lang.String key, MediaType mediaType) Alternative to mediaTypes to add a single mapping.
RequestedContentTypeResolverBuilder	mediaTypes(java.util.Map<java.lang.String,MediaType> mediaTypes) Add a mapping from a key, extracted from a path extension or a query parameter, to a MediaType.
RequestedContentTypeResolverBuilder	parameterName(java.lang.String parameterName) Set the query parameter name to use when favorParameter is on.
RequestedContentTypeResolverBuilder	useJaf(boolean useJaf) When favorPathExtension is set, this property determines whether to allow use of JAF (Java Activation Framework) to resolve a path extension to a specific MediaType.

Methods inherited from class java.lang.Object

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

Field Detail

favorPathExtension

private boolean favorPathExtension

favorParameter

private boolean favorParameter

ignoreAcceptHeader

private boolean ignoreAcceptHeader

mediaTypes

private java.util.Map<java.lang.String,MediaType> mediaTypes

ignoreUnknownPathExtensions

private boolean ignoreUnknownPathExtensions

useJaf

private java.lang.Boolean useJaf

parameterName

private java.lang.String parameterName

contentTypeResolver

private RequestedContentTypeResolver contentTypeResolver

Constructor Detail

RequestedContentTypeResolverBuilder

public RequestedContentTypeResolverBuilder()

Method Detail

favorPathExtension

public RequestedContentTypeResolverBuilder favorPathExtension(boolean favorPathExtension)

Whether the path extension in the URL path should be used to determine the requested media type.

By default this is set to true in which case a request for /hotels.pdf will be interpreted as a request for "application/pdf" regardless of the 'Accept' header.

mediaTypes

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

Add a mapping from a key, extracted from a path extension or a query parameter, to a MediaType. This is required in order for the parameter strategy to work. Any extensions explicitly registered here are also whitelisted for the purpose of Reflected File Download attack detection (see Spring Framework reference documentation for more details on RFD attack protection).

The path extension strategy will also try to use JAF (if present) to resolve path extensions. To change this behavior see useJaf.

Parameters:

mediaTypes - media type mappings

mediaType

public RequestedContentTypeResolverBuilder mediaType(java.lang.String key,
                                                     MediaType mediaType)

Alternative to mediaTypes to add a single mapping.

ignoreUnknownPathExtensions

public RequestedContentTypeResolverBuilder ignoreUnknownPathExtensions(boolean ignore)

Whether to ignore requests with path extension that cannot be resolved to any media type. Setting this to false will result in an HttpMediaTypeNotAcceptableException if there is no match.

By default this is set to true.

useJaf

public RequestedContentTypeResolverBuilder useJaf(boolean useJaf)

When favorPathExtension is set, this property determines whether to allow use of JAF (Java Activation Framework) to resolve a path extension to a specific MediaType.

By default this is not set in which case PathExtensionContentNegotiationStrategy will use JAF if available.

favorParameter

public RequestedContentTypeResolverBuilder favorParameter(boolean favorParameter)

Whether a request parameter ("format" by default) should be used to determine the requested media type. For this option to work you must register media type mappings.

By default this is set to false.

See Also:

parameterName

parameterName

public RequestedContentTypeResolverBuilder parameterName(java.lang.String parameterName)

Set the query parameter name to use when favorParameter is on.

The default parameter name is "format".

ignoreAcceptHeader

public RequestedContentTypeResolverBuilder ignoreAcceptHeader(boolean ignoreAcceptHeader)

Whether to disable checking the 'Accept' request header.

By default this value is set to false.

defaultContentType

public RequestedContentTypeResolverBuilder defaultContentType(MediaType contentType)

Set the default content type to use when no content type is requested.

By default this is not set.

See Also:

defaultContentTypeResolver(org.springframework.web.reactive.accept.RequestedContentTypeResolver)

defaultContentTypeResolver

public RequestedContentTypeResolverBuilder defaultContentTypeResolver(RequestedContentTypeResolver resolver)

Set a custom RequestedContentTypeResolver to use to determine the content type to use when no content type is requested.

By default this is not set.

See Also:

defaultContentType(org.springframework.http.MediaType)

build

public CompositeContentTypeResolver build()