org.springframework.web.reactive.config

Class WebFluxConfigurerComposite

java.lang.Object

org.springframework.web.reactive.config.WebFluxConfigurerComposite

All Implemented Interfaces:

WebFluxConfigurer

public class WebFluxConfigurerComposite
extends java.lang.Object
implements WebFluxConfigurer

A WebFluxConfigurer that delegates to one or more others.

Since:

5.0

Author:

Brian Clozel, Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<WebFluxConfigurer>	delegates

Constructor Summary

Constructors

Constructor and Description
WebFluxConfigurerComposite()

Method Summary

Modifier and Type	Method and Description
void	addArgumentResolvers(java.util.List<HandlerMethodArgumentResolver> resolvers) Provide custom controller method argument resolvers.
void	addCorsMappings(CorsRegistry registry) Configure cross origin requests processing.
void	addFormatters(FormatterRegistry registry) Add custom Converters and Formatters for performing type conversion and formatting of controller method arguments.
void	addResourceHandlers(ResourceHandlerRegistry registry) Add resource handlers for serving static resources.
void	addWebFluxConfigurers(java.util.List<WebFluxConfigurer> configurers)
void	configureContentTypeResolver(RequestedContentTypeResolverBuilder builder) Configure how the content type requested for the response is resolved.
void	configureMessageReaders(java.util.List<HttpMessageReader<?>> readers) Configure the message readers to use for decoding the request body where @RequestBody and HttpEntity controller method arguments are used.
void	configureMessageWriters(java.util.List<HttpMessageWriter<?>> writers) Configure the message writers to use to encode the response body based on the return values of @ResponseBody, and ResponseEntity controller methods.
void	configurePathMatching(PathMatchConfigurer configurer) Configure path matching options.
void	configureViewResolvers(ViewResolverRegistry registry) Configure view resolution for processing the return values of controller methods that rely on resolving a View to render the response with.
private <T> java.util.Optional<T>	createSingleBean(java.util.function.Function<WebFluxConfigurer,java.util.Optional<T>> factory, java.lang.Class<T> beanType)
void	extendMessageReaders(java.util.List<HttpMessageReader<?>> readers) An alternative to WebFluxConfigurer.configureMessageReaders(List) that allows modifying the message readers to use after default ones have been added.
void	extendMessageWriters(java.util.List<HttpMessageWriter<?>> writers) An alternative to WebFluxConfigurer.configureMessageWriters(List) that allows modifying the message writers to use after default ones have been added.
java.util.Optional<MessageCodesResolver>	getMessageCodesResolver() Provide a custom MessageCodesResolver to use for data binding instead of the one created by default in DataBinder.
java.util.Optional<Validator>	getValidator() Provide a custom Validator.

Methods inherited from class java.lang.Object

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

Field Detail

delegates

private final java.util.List<WebFluxConfigurer> delegates

Constructor Detail

WebFluxConfigurerComposite

public WebFluxConfigurerComposite()

Method Detail

addWebFluxConfigurers

public void addWebFluxConfigurers(java.util.List<WebFluxConfigurer> configurers)

configureContentTypeResolver

public void configureContentTypeResolver(RequestedContentTypeResolverBuilder builder)

Description copied from interface: WebFluxConfigurer

Configure how the content type requested for the response is resolved.

The given builder will create a composite of multiple RequestedContentTypeResolvers, each defining a way to resolve the requested content type (accept HTTP header, path extension, parameter, etc).

Specified by:

configureContentTypeResolver in interface WebFluxConfigurer

Parameters:

builder - factory that creates a CompositeContentTypeResolver

addCorsMappings

public void addCorsMappings(CorsRegistry registry)

Description copied from interface: WebFluxConfigurer

Configure cross origin requests processing.

Specified by:

addCorsMappings in interface WebFluxConfigurer

See Also:

CorsRegistry

configurePathMatching

public void configurePathMatching(PathMatchConfigurer configurer)

Description copied from interface: WebFluxConfigurer

Configure path matching options.

The given configurer assists with configuring HandlerMappings with path matching options.

Specified by:

configurePathMatching in interface WebFluxConfigurer

Parameters:

configurer - the PathMatchConfigurer instance

addResourceHandlers

public void addResourceHandlers(ResourceHandlerRegistry registry)

Description copied from interface: WebFluxConfigurer

Add resource handlers for serving static resources.

Specified by:

addResourceHandlers in interface WebFluxConfigurer

See Also:

ResourceHandlerRegistry

addArgumentResolvers

public void addArgumentResolvers(java.util.List<HandlerMethodArgumentResolver> resolvers)

Description copied from interface: WebFluxConfigurer

Provide custom controller method argument resolvers. Such resolvers do not override and will be invoked after the built-in ones.

Specified by:

addArgumentResolvers in interface WebFluxConfigurer

Parameters:

resolvers - a list of resolvers to add

configureMessageReaders

public void configureMessageReaders(java.util.List<HttpMessageReader<?>> readers)

Description copied from interface: WebFluxConfigurer

Configure the message readers to use for decoding the request body where @RequestBody and HttpEntity controller method arguments are used. If none are specified, default ones are added based on WebFluxConfigurationSupport.addDefaultHttpMessageReaders(java.util.List<org.springframework.http.codec.HttpMessageReader<?>>).

See WebFluxConfigurer.extendMessageReaders(List) for adding readers in addition to the default ones.

Specified by:

configureMessageReaders in interface WebFluxConfigurer

Parameters:

readers - an empty list to add message readers to

extendMessageReaders

public void extendMessageReaders(java.util.List<HttpMessageReader<?>> readers)

Description copied from interface: WebFluxConfigurer

An alternative to WebFluxConfigurer.configureMessageReaders(List) that allows modifying the message readers to use after default ones have been added.

Specified by:

extendMessageReaders in interface WebFluxConfigurer

addFormatters

public void addFormatters(FormatterRegistry registry)

Description copied from interface: WebFluxConfigurer

Add custom Converters and Formatters for performing type conversion and formatting of controller method arguments.

Specified by:

addFormatters in interface WebFluxConfigurer

getValidator

public java.util.Optional<Validator> getValidator()

Description copied from interface: WebFluxConfigurer

Provide a custom Validator.

By default a validator for standard bean validation is created if bean validation api is present on the classpath.

Specified by:

getValidator in interface WebFluxConfigurer

getMessageCodesResolver

public java.util.Optional<MessageCodesResolver> getMessageCodesResolver()

Description copied from interface: WebFluxConfigurer

Provide a custom MessageCodesResolver to use for data binding instead of the one created by default in DataBinder.

Specified by:

getMessageCodesResolver in interface WebFluxConfigurer

configureMessageWriters

public void configureMessageWriters(java.util.List<HttpMessageWriter<?>> writers)

Description copied from interface: WebFluxConfigurer

Configure the message writers to use to encode the response body based on the return values of @ResponseBody, and ResponseEntity controller methods. If none are specified, default ones are added based on WebFluxConfigurationSupport.addDefaultHttpMessageWriters(List).

See WebFluxConfigurer.extendMessageWriters(List) for adding writers in addition to the default ones.

Specified by:

configureMessageWriters in interface WebFluxConfigurer

Parameters:

writers - a empty list to add message writers to

extendMessageWriters

public void extendMessageWriters(java.util.List<HttpMessageWriter<?>> writers)

Description copied from interface: WebFluxConfigurer

An alternative to WebFluxConfigurer.configureMessageWriters(List) that allows modifying the message writers to use after default ones have been added.

Specified by:

extendMessageWriters in interface WebFluxConfigurer

configureViewResolvers

public void configureViewResolvers(ViewResolverRegistry registry)

Description copied from interface: WebFluxConfigurer

Configure view resolution for processing the return values of controller methods that rely on resolving a View to render the response with. By default all controller methods rely on view resolution unless annotated with @ResponseBody or explicitly return ResponseEntity. A view may be specified explicitly with a String return value or implicitly, e.g. void return value.

Specified by:

configureViewResolvers in interface WebFluxConfigurer

See Also:

ViewResolverRegistry

createSingleBean

private <T> java.util.Optional<T> createSingleBean(java.util.function.Function<WebFluxConfigurer,java.util.Optional<T>> factory,
                                                   java.lang.Class<T> beanType)