Class webFluxConfigurerComposite

java.lang.Object

org.springframework.web.reactive.config.webFluxConfigurerComposite

All Implemented Interfaces:

webFluxConfigurer

public class webFluxConfigurerComposite
extends Object
implements webFluxConfigurer

A webFluxConfigurer that delegates to one or more others.

Since:

5.0

Author:

Brian Clozel, Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
webFluxConfigurerComposite()

Method Summary

Modifier and Type	Method	Description
void	addCorsMappings(CorsRegistry registry)	Configure "global" cross-origin request processing.
void	addErrorResponseInterceptors(List<ErrorResponse.Interceptor> interceptors)	Add to the list of ErrorResponse.Interceptor's to invoke when rendering an RFC 9457 ProblemDetail error response.
void	addFormatters(FormatterRegistry registry)	Add custom Converters and Formatters for performing type conversion and formatting of annotated controller method arguments.
void	addResourceHandlers(ResourceHandlerRegistry registry)	Add resource handlers for serving static resources.
void	addwebFluxConfigurers(List<webFluxConfigurer> configurers)
void	configureApiVersioning(ApiVersionConfigurer configurer)	Configure API versioning for the application.
void	configureArgumentResolvers(ArgumentResolverConfigurer configurer)	Configure resolvers for custom @RequestMapping method arguments.
void	configureBlockingExecution(BlockingExecutionConfigurer configurer)	Configure settings related to blocking execution in webFlux.
void	configureContentTypeResolver(RequestedContentTypeResolverBuilder builder)	Configure how the content type requested for the response is resolved when handling requests with annotated controllers.
void	configureHttpMessageCodecs(ServerCodecConfigurer configurer)	Configure the HTTP message readers and writers for reading from the request body and for writing to the response body in annotated controllers and functional endpoints.
void	configurePathMatching(PathMatchConfigurer configurer)	Configure path matching options.
void	configureViewResolvers(ViewResolverRegistry registry)	Configure view resolution for rendering responses with a view and a model, where the view is typically an HTML template but could also be based on an HTTP message writer (for example, JSON, XML).
@Nullable MessageCodesResolver	getMessageCodesResolver()	Provide a custom MessageCodesResolver to use for data binding in annotated controller method arguments instead of the one created by default in DataBinder.
@Nullable Validator	getValidator()	Provide a custom Validator.
@Nullable webSocketService	getwebSocketService()	Provide the webSocketService to create webSocketHandlerAdapter with.

Methods inherited from class Object

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

Constructor Details

webFluxConfigurerComposite

public webFluxConfigurerComposite()

Method Details

addwebFluxConfigurers

public void addwebFluxConfigurers(List<webFluxConfigurer> configurers)

configureHttpMessageCodecs

public void configureHttpMessageCodecs(ServerCodecConfigurer configurer)

Description copied from interface: webFluxConfigurer

Configure the HTTP message readers and writers for reading from the request body and for writing to the response body in annotated controllers and functional endpoints.

By default, all built-in readers and writers are configured as long as the corresponding 3rd party libraries such Jackson JSON, JAXB2, and others are present on the classpath.

Specified by:

configureHttpMessageCodecs in interface webFluxConfigurer

Parameters:

configurer - the configurer to customize readers and writers

addFormatters

public void addFormatters(FormatterRegistry registry)

Description copied from interface: webFluxConfigurer

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

Specified by:

addFormatters in interface webFluxConfigurer

getValidator

public @Nullable 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.

The configured validator is used for validating annotated controller method arguments.

Specified by:

getValidator in interface webFluxConfigurer

getMessageCodesResolver

public @Nullable MessageCodesResolver getMessageCodesResolver()

Description copied from interface: webFluxConfigurer

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

Specified by:

getMessageCodesResolver in interface webFluxConfigurer

addCorsMappings

public void addCorsMappings(CorsRegistry registry)

Description copied from interface: webFluxConfigurer

Configure "global" cross-origin request processing. The configured CORS mappings apply to annotated controllers, functional endpoints, and static resources.

Annotated controllers can further declare more fine-grained config via @CrossOrigin. In such cases "global" CORS configuration declared here is combined with local CORS configuration defined on a controller method.

Specified by:

addCorsMappings in interface webFluxConfigurer

See Also:

• CorsRegistry
• CorsConfiguration.combine(CorsConfiguration)

configureBlockingExecution

public void configureBlockingExecution(BlockingExecutionConfigurer configurer)

Description copied from interface: webFluxConfigurer

Configure settings related to blocking execution in webFlux.

Specified by:

configureBlockingExecution in interface webFluxConfigurer

configureContentTypeResolver

public void configureContentTypeResolver(RequestedContentTypeResolverBuilder builder)

Description copied from interface: webFluxConfigurer

Configure how the content type requested for the response is resolved when handling requests with annotated controllers.

Specified by:

configureContentTypeResolver in interface webFluxConfigurer

Parameters:

builder - for configuring the resolvers to use

configureApiVersioning

public void configureApiVersioning(ApiVersionConfigurer configurer)

Description copied from interface: webFluxConfigurer

Configure API versioning for the application. In order for versioning to be enabled, you must configure at least one way to resolve the API version from a request (e.g. via request header).

Specified by:

configureApiVersioning in interface webFluxConfigurer

configurePathMatching

public void configurePathMatching(PathMatchConfigurer configurer)

Description copied from interface: webFluxConfigurer

Configure path matching options.

The configured path matching options will be used for mapping to annotated controllers and also static resources.

Specified by:

configurePathMatching in interface webFluxConfigurer

Parameters:

configurer - the PathMatchConfigurer instance

configureArgumentResolvers

public void configureArgumentResolvers(ArgumentResolverConfigurer configurer)

Description copied from interface: webFluxConfigurer

Configure resolvers for custom @RequestMapping method arguments.

Specified by:

configureArgumentResolvers in interface webFluxConfigurer

Parameters:

configurer - to configurer to use

addErrorResponseInterceptors

public void addErrorResponseInterceptors(List<ErrorResponse.Interceptor> interceptors)

Description copied from interface: webFluxConfigurer

Add to the list of ErrorResponse.Interceptor's to invoke when rendering an RFC 9457 ProblemDetail error response.

Specified by:

addErrorResponseInterceptors in interface webFluxConfigurer

Parameters:

interceptors - the handlers to use

configureViewResolvers

public void configureViewResolvers(ViewResolverRegistry registry)

Description copied from interface: webFluxConfigurer

Configure view resolution for rendering responses with a view and a model, where the view is typically an HTML template but could also be based on an HTTP message writer (for example, JSON, XML).

The configured view resolvers will be used for both annotated controllers and functional endpoints.

Specified by:

configureViewResolvers in interface webFluxConfigurer

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

getwebSocketService

public @Nullable webSocketService getwebSocketService()

Description copied from interface: webFluxConfigurer

Provide the webSocketService to create webSocketHandlerAdapter with. This can be used to configure server-specific properties through the RequestUpgradeStrategy.

Specified by:

getwebSocketService in interface webFluxConfigurer