Spring Framework 6.1.4 · org.springframework.web.reactive.config.WebFluxConfigurer

Method Summary

Modifier and Type	Method and Description
public default void	addCorsMappings(CorsRegistry registry) Configure "global" cross-origin request processing.
public default void	addFormatters(FormatterRegistry registry) Add custom `Converters` and `Formatters` for performing type conversion and formatting of annotated controller method arguments.
public default void	addResourceHandlers(ResourceHandlerRegistry registry) Add resource handlers for serving static resources.
public default void	configureArgumentResolvers(ArgumentResolverConfigurer to configurer to use configurer) Configure resolvers for custom `@RequestMapping` method arguments.
public default void	configureBlockingExecution(BlockingExecutionConfigurer configurer) Configure settings related to blocking execution in WebFlux.
public default void	configureContentTypeResolver(RequestedContentTypeResolverBuilder for configuring the resolvers to use builder) Configure how the content type requested for the response is resolved when handling requests with annotated controllers.
public default void	configureHttpMessageCodecs(ServerCodecConfigurer the configurer to customize readers and writers 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.
public default void	configurePathMatching(PathMatchConfigurer the `PathMatchConfigurer` instance configurer) Configure path matching options.
public default 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 (e.g. JSON, XML).
public default MessageCodesResolver	getMessageCodesResolver() Provide a custom `MessageCodesResolver` to use for data binding in annotated controller method arguments instead of the one created by default in `org.springframework.validation.DataBinder`.
public default Validator	getValidator() Provide a custom `Validator`.
public default WebSocketService	getWebSocketService() Provide the `WebSocketService` to create `org.springframework.web.reactive.socket.server.support.WebSocketHandlerAdapter` with.

Method Detail

addCorsMappings back to summary

addCorsMappings	back to summary
public default void addCorsMappings(CorsRegistry registry) 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. See Also `CorsRegistry`, `CorsConfiguration#combine(CorsConfiguration)`

public default void addCorsMappings(CorsRegistry registry)

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.

See Also: CorsRegistry, CorsConfiguration#combine(CorsConfiguration)

addFormatters	back to summary
public default void addFormatters(FormatterRegistry registry) Add custom `Converters` and `Formatters` for performing type conversion and formatting of annotated controller method arguments.

addResourceHandlers back to summary

addResourceHandlers	back to summary
public default void addResourceHandlers(ResourceHandlerRegistry registry) Add resource handlers for serving static resources. See Also `ResourceHandlerRegistry`

public default void addResourceHandlers(ResourceHandlerRegistry registry)

Add resource handlers for serving static resources.

See Also: ResourceHandlerRegistry

configureArgumentResolvers back to summary

configureArgumentResolvers	back to summary
public default void configureArgumentResolvers(ArgumentResolverConfigurer configurer) Configure resolvers for custom `@RequestMapping` method arguments. Parameters configurer:ArgumentResolverConfigurer to configurer to use

public default void configureArgumentResolvers(ArgumentResolverConfigurer configurer)

Configure resolvers for custom @RequestMapping method arguments.

Parameters

configurer:ArgumentResolverConfigurer: to configurer to use

configureBlockingExecution	back to summary
public default void configureBlockingExecution(BlockingExecutionConfigurer configurer) Configure settings related to blocking execution in WebFlux. Since 6.1

configureBlockingExecution

back to summary

public default void configureBlockingExecution(BlockingExecutionConfigurer configurer)

Configure settings related to blocking execution in WebFlux.

Since: 6.1

configureContentTypeResolver	back to summary
public default void configureContentTypeResolver(RequestedContentTypeResolverBuilder builder) Configure how the content type requested for the response is resolved when handling requests with annotated controllers. Parameters builder:RequestedContentTypeResolverBuilder for configuring the resolvers to use

configureContentTypeResolver

back to summary

public default void configureContentTypeResolver(RequestedContentTypeResolverBuilder builder)

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

Parameters

builder:RequestedContentTypeResolverBuilder: for configuring the resolvers to use

configureHttpMessageCodecs	back to summary
public default 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. 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. Parameters configurer:ServerCodecConfigurer the configurer to customize readers and writers

configureHttpMessageCodecs

back to summary

public default 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.

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.

Parameters

configurer:ServerCodecConfigurer: the configurer to customize readers and writers

configurePathMatching back to summary

configurePathMatching	back to summary
public default void configurePathMatching(PathMatchConfigurer configurer) Configure path matching options. The configured path matching options will be used for mapping to annotated controllers and also `static resources`. Parameters configurer:PathMatchConfigurer the `PathMatchConfigurer` instance

public default void configurePathMatching(PathMatchConfigurer configurer)

Configure path matching options.

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

Parameters

configurer:PathMatchConfigurer: the PathMatchConfigurer instance

configureViewResolvers	back to summary
public default 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 (e.g. JSON, XML). The configured view resolvers will be used for both annotated controllers and functional endpoints.

configureViewResolvers

back to summary

public default 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 (e.g. JSON, XML).

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

getMessageCodesResolver back to summary

getMessageCodesResolver	back to summary
public default MessageCodesResolver getMessageCodesResolver() Provide a custom `MessageCodesResolver` to use for data binding in annotated controller method arguments instead of the one created by default in `org.springframework.validation.DataBinder`. Annotations @Nullable

public default MessageCodesResolver getMessageCodesResolver()

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

Annotations

@Nullable

getValidator back to summary

getValidator	back to summary
public default Validator getValidator() 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. Annotations @Nullable

public default Validator getValidator()

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.

Annotations

@Nullable

getWebSocketService back to summary

getWebSocketService	back to summary
public default WebSocketService getWebSocketService() Provide the `WebSocketService` to create `org.springframework.web.reactive.socket.server.support.WebSocketHandlerAdapter` with. This can be used to configure server-specific properties through the `org.springframework.web.reactive.socket.server.RequestUpgradeStrategy`. Annotations @Nullable Since 5.3

public default WebSocketService getWebSocketService()

Provide the WebSocketService to create org.springframework.web.reactive.socket.server.support.WebSocketHandlerAdapter with. This can be used to configure server-specific properties through the org.springframework.web.reactive.socket.server.RequestUpgradeStrategy.

Annotations

@Nullable

Since

5.3

public Interface WebFluxConfigurer

Method Summary

Method Detail