WebFluxConfigurationSupport

java.lang.Object
- org.springframework.web.reactive.config.WebFluxConfigurationSupport

All Implemented Interfaces:

Aware, ApplicationContextAware

Direct Known Subclasses:

DelegatingWebFluxConfiguration
```
public class WebFluxConfigurationSupport
extends java.lang.Object
implements ApplicationContextAware
```
The main class for Spring Web Reactive configuration.
Import directly or extend and override protected methods to customize.

Since:

5.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`WebFluxConfigurationSupport.EmptyHandlerMapping`
`private static class`	`WebFluxConfigurationSupport.NoOpValidator`

Field Summary

Fields
Modifier and Type	Field and Description
`private ApplicationContext`	`applicationContext`
`private java.util.Map<java.lang.String,CorsConfiguration>`	`corsConfigurations`
`private static boolean`	`jackson2Present`
`private static boolean`	`jaxb2Present`
`private java.util.List<HttpMessageReader<?>>`	`messageReaders`
`private java.util.List<HttpMessageWriter<?>>`	`messageWriters`
`private PathMatchConfigurer`	`pathMatchConfigurer`

Constructor Summary

Constructors
Constructor and Description

WebFluxConfigurationSupport()

Constructors
Constructor and Description
`WebFluxConfigurationSupport()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addArgumentResolvers(java.util.List<HandlerMethodArgumentResolver> resolvers)` Provide custom argument resolvers without overriding the built-in ones.
`protected void`	`addCorsMappings(CorsRegistry registry)` Override this method to configure cross origin requests processing.
`protected void`	`addDefaultHttpMessageReaders(java.util.List<HttpMessageReader<?>> readers)` Adds default converters that sub-classes can call from `configureMessageReaders(List)` for `byte[]`, `ByteBuffer`, `String`, `Resource`, JAXB2, and Jackson (if present on the classpath).
`protected void`	`addDefaultHttpMessageWriters(java.util.List<HttpMessageWriter<?>> writers)` Adds default converters that sub-classes can call from `configureMessageWriters(List)`.
`protected void`	`addFormatters(FormatterRegistry registry)` Override to add custom `Converter`s and `Formatter`s.
`protected void`	`addResourceHandlers(ResourceHandlerRegistry registry)` Override this method to add resource handlers for serving static resources.
`protected void`	`configureContentTypeResolver(RequestedContentTypeResolverBuilder builder)` Override to configure how the requested content type is resolved.
`protected void`	`configureMessageReaders(java.util.List<HttpMessageReader<?>> messageReaders)` Override to configure the message readers to use for decoding controller method arguments.
`protected void`	`configureMessageWriters(java.util.List<HttpMessageWriter<?>> messageWriters)` Override to configure the message writers to use for encoding return values.
`void`	`configurePathMatching(PathMatchConfigurer configurer)` Override to configure path matching options.
`protected void`	`configureViewResolvers(ViewResolverRegistry registry)` Configure view resolution for supporting template engines.
`protected RequestMappingHandlerAdapter`	`createRequestMappingHandlerAdapter()` Override to plug a sub-class of `RequestMappingHandlerAdapter`.
`protected RequestMappingHandlerMapping`	`createRequestMappingHandlerMapping()` Override to plug a sub-class of `RequestMappingHandlerMapping`.
`protected void`	`extendMessageReaders(java.util.List<HttpMessageReader<?>> messageReaders)` Override this to modify the list of message readers after it has been configured, for example to add some in addition to the default ones.
`protected void`	`extendMessageWriters(java.util.List<HttpMessageWriter<?>> messageWriters)` Override this to modify the list of message writers after it has been configured, for example to add some in addition to the default ones.
`protected ApplicationContext`	`getApplicationContext()`
`protected ConfigurableWebBindingInitializer`	`getConfigurableWebBindingInitializer()` Return the `ConfigurableWebBindingInitializer` to use for initializing all `WebDataBinder` instances.
`protected java.util.Map<java.lang.String,CorsConfiguration>`	`getCorsConfigurations()` Callback for building the global CORS configuration.
`protected java.util.Map<java.lang.String,MediaType>`	`getDefaultMediaTypeMappings()` Override to configure media type mappings.
`protected MessageCodesResolver`	`getMessageCodesResolver()` Override this method to provide a custom `MessageCodesResolver`.
`protected java.util.List<HttpMessageReader<?>>`	`getMessageReaders()` Main method to access message readers to use for decoding controller method arguments with.
`protected java.util.List<HttpMessageWriter<?>>`	`getMessageWriters()` Main method to access message writers to use for encoding return values.
`protected PathMatchConfigurer`	`getPathMatchConfigurer()` Callback for building the `PathMatchConfigurer`.
`protected Validator`	`getValidator()` Override this method to provide a custom `Validator`.
`RequestMappingHandlerAdapter`	`requestMappingHandlerAdapter()`
`RequestMappingHandlerMapping`	`requestMappingHandlerMapping()`
`HandlerMapping`	`resourceHandlerMapping()` Return a handler mapping ordered at Integer.MAX_VALUE-1 with mapped resource handlers.
`ResponseBodyResultHandler`	`responseBodyResultHandler()`
`ResponseEntityResultHandler`	`responseEntityResultHandler()`
`WebExceptionHandler`	`responseStatusExceptionHandler()`
`void`	`setApplicationContext(ApplicationContext applicationContext)` Set the ApplicationContext that this object runs in.
`SimpleHandlerAdapter`	`simpleHandlerAdapter()`
`ViewResolutionResultHandler`	`viewResolutionResultHandler()`
`ReactiveAdapterRegistry`	`webFluxAdapterRegistry()` Return a `ReactiveAdapterRegistry` to adapting reactive types.
`CompositeContentTypeResolver`	`webFluxContentTypeResolver()`
`FormattingConversionService`	`webFluxConversionService()`
`Validator`	`webFluxValidator()` Return a global `Validator` instance for example for validating `@RequestBody` method arguments.
`DispatcherHandler`	`webHandler()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - jackson2Present
```
private static final boolean jackson2Present
```
  - jaxb2Present
```
private static final boolean jaxb2Present
```
  - corsConfigurations
```
private java.util.Map<java.lang.String,CorsConfiguration> corsConfigurations
```
  - pathMatchConfigurer
```
private PathMatchConfigurer pathMatchConfigurer
```
  - messageReaders
```
private java.util.List<HttpMessageReader<?>> messageReaders
```
  - messageWriters
```
private java.util.List<HttpMessageWriter<?>> messageWriters
```
  - applicationContext
```
private ApplicationContext applicationContext
```
- Constructor Detail
  - WebFluxConfigurationSupport
```
public WebFluxConfigurationSupport()
```
- Method Detail
  - setApplicationContext
```
public void setApplicationContext(ApplicationContext applicationContext)
```
    Description copied from interface: ApplicationContextAware
    
    Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.
    Invoked after population of normal bean properties but before an init callback such as InitializingBean.afterPropertiesSet() or a custom init-method. Invoked after ResourceLoaderAware.setResourceLoader(org.springframework.core.io.ResourceLoader), ApplicationEventPublisherAware.setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher) and MessageSourceAware, if applicable.
    
    Specified by:
    
    setApplicationContext in interface ApplicationContextAware
    
    Parameters:
    
    applicationContext - the ApplicationContext object to be used by this object
    
    See Also:
    
    BeanInitializationException
  - getApplicationContext
```
protected ApplicationContext getApplicationContext()
```
  - webHandler
```
@Bean
public DispatcherHandler webHandler()
```
  - responseStatusExceptionHandler
```
@Bean
 @Order(value=0)
public WebExceptionHandler responseStatusExceptionHandler()
```
  - requestMappingHandlerMapping
```
@Bean
public RequestMappingHandlerMapping requestMappingHandlerMapping()
```
  - createRequestMappingHandlerMapping
```
protected RequestMappingHandlerMapping createRequestMappingHandlerMapping()
```
    Override to plug a sub-class of RequestMappingHandlerMapping.
  - webFluxContentTypeResolver
```
@Bean
public CompositeContentTypeResolver webFluxContentTypeResolver()
```
  - getDefaultMediaTypeMappings
```
protected java.util.Map<java.lang.String,MediaType> getDefaultMediaTypeMappings()
```
    Override to configure media type mappings.
    
    See Also:
    
    RequestedContentTypeResolverBuilder.mediaTypes(Map)
  - configureContentTypeResolver
```
protected void configureContentTypeResolver(RequestedContentTypeResolverBuilder builder)
```
    Override to configure how the requested content type is resolved.
  - getCorsConfigurations
```
protected final java.util.Map<java.lang.String,CorsConfiguration> getCorsConfigurations()
```
    Callback for building the global CORS configuration. This method is final. Use addCorsMappings(CorsRegistry) to customize the CORS conifg.
  - addCorsMappings
```
protected void addCorsMappings(CorsRegistry registry)
```
    Override this method to configure cross origin requests processing.
    
    See Also:
    
    CorsRegistry
  - getPathMatchConfigurer
```
protected final PathMatchConfigurer getPathMatchConfigurer()
```
    Callback for building the PathMatchConfigurer. This method is final, use configurePathMatching(org.springframework.web.reactive.config.PathMatchConfigurer) to customize path matching.
  - configurePathMatching
```
public void configurePathMatching(PathMatchConfigurer configurer)
```
    Override to configure path matching options.
  - resourceHandlerMapping
```
@Bean
public HandlerMapping resourceHandlerMapping()
```
    Return a handler mapping ordered at Integer.MAX_VALUE-1 with mapped resource handlers. To configure resource handling, override addResourceHandlers(org.springframework.web.reactive.config.ResourceHandlerRegistry).
  - addResourceHandlers
```
protected void addResourceHandlers(ResourceHandlerRegistry registry)
```
    Override this method to add resource handlers for serving static resources.
    
    See Also:
    
    ResourceHandlerRegistry
  - requestMappingHandlerAdapter
```
@Bean
public RequestMappingHandlerAdapter requestMappingHandlerAdapter()
```
  - createRequestMappingHandlerAdapter
```
protected RequestMappingHandlerAdapter createRequestMappingHandlerAdapter()
```
    Override to plug a sub-class of RequestMappingHandlerAdapter.
  - addArgumentResolvers
```
protected void addArgumentResolvers(java.util.List<HandlerMethodArgumentResolver> resolvers)
```
    Provide custom argument resolvers without overriding the built-in ones.
  - getMessageReaders
```
protected final java.util.List<HttpMessageReader<?>> getMessageReaders()
```
    Main method to access message readers to use for decoding controller method arguments with.
    Use configureMessageReaders(java.util.List<org.springframework.http.codec.HttpMessageReader<?>>) to configure the list or extendMessageReaders(java.util.List<org.springframework.http.codec.HttpMessageReader<?>>) to add in addition to the default ones.
  - configureMessageReaders
```
protected void configureMessageReaders(java.util.List<HttpMessageReader<?>> messageReaders)
```
    Override to configure the message readers to use for decoding controller method arguments.
    If no message readres are specified, default will be added via addDefaultHttpMessageReaders(java.util.List<org.springframework.http.codec.HttpMessageReader<?>>).
    
    Parameters:
    
    messageReaders - a list to add message readers to, initially an empty
  - addDefaultHttpMessageReaders
```
protected final void addDefaultHttpMessageReaders(java.util.List<HttpMessageReader<?>> readers)
```
    Adds default converters that sub-classes can call from configureMessageReaders(List) for byte[], ByteBuffer, String, Resource, JAXB2, and Jackson (if present on the classpath).
  - extendMessageReaders
```
protected void extendMessageReaders(java.util.List<HttpMessageReader<?>> messageReaders)
```
    Override this to modify the list of message readers after it has been configured, for example to add some in addition to the default ones.
  - getConfigurableWebBindingInitializer
```
protected ConfigurableWebBindingInitializer getConfigurableWebBindingInitializer()
```
    Return the ConfigurableWebBindingInitializer to use for initializing all WebDataBinder instances.
  - webFluxConversionService
```
@Bean
public FormattingConversionService webFluxConversionService()
```
  - addFormatters
```
protected void addFormatters(FormatterRegistry registry)
```
    Override to add custom Converters and Formatters.
  - webFluxAdapterRegistry
```
@Bean
public ReactiveAdapterRegistry webFluxAdapterRegistry()
```
    Return a ReactiveAdapterRegistry to adapting reactive types.
  - webFluxValidator
```
@Bean
public Validator webFluxValidator()
```
    Return a global Validator instance for example for validating @RequestBody method arguments.
    Delegates to getValidator() first. If that returns null checks the classpath for the presence of a JSR-303 implementations before creating a OptionalValidatorFactoryBean. If a JSR-303 implementation is not available, a "no-op" Validator is returned.
  - getValidator
```
protected Validator getValidator()
```
    Override this method to provide a custom Validator.
  - getMessageCodesResolver
```
protected MessageCodesResolver getMessageCodesResolver()
```
    Override this method to provide a custom MessageCodesResolver.
  - simpleHandlerAdapter
```
@Bean
public SimpleHandlerAdapter simpleHandlerAdapter()
```
  - responseEntityResultHandler
```
@Bean
public ResponseEntityResultHandler responseEntityResultHandler()
```
  - responseBodyResultHandler
```
@Bean
public ResponseBodyResultHandler responseBodyResultHandler()
```
  - getMessageWriters
```
protected final java.util.List<HttpMessageWriter<?>> getMessageWriters()
```
    Main method to access message writers to use for encoding return values.
    Use configureMessageWriters(List) to configure the list or extendMessageWriters(List) to add in addition to the default ones.
  - configureMessageWriters
```
protected void configureMessageWriters(java.util.List<HttpMessageWriter<?>> messageWriters)
```
    Override to configure the message writers to use for encoding return values.
    If no message readers are specified, default will be added via addDefaultHttpMessageWriters(java.util.List<org.springframework.http.codec.HttpMessageWriter<?>>).
    
    Parameters:
    
    messageWriters - a list to add message writers to, initially an empty
  - addDefaultHttpMessageWriters
```
protected final void addDefaultHttpMessageWriters(java.util.List<HttpMessageWriter<?>> writers)
```
    Adds default converters that sub-classes can call from configureMessageWriters(List).
  - extendMessageWriters
```
protected void extendMessageWriters(java.util.List<HttpMessageWriter<?>> messageWriters)
```
    Override this to modify the list of message writers after it has been configured, for example to add some in addition to the default ones.
  - viewResolutionResultHandler
```
@Bean
public ViewResolutionResultHandler viewResolutionResultHandler()
```
  - configureViewResolvers
```
protected void configureViewResolvers(ViewResolverRegistry registry)
```
    Configure view resolution for supporting template engines.
    
    See Also:
    
    ViewResolverRegistry

Class WebFluxConfigurationSupport

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

jackson2Present

jaxb2Present

corsConfigurations

pathMatchConfigurer

messageReaders

messageWriters

applicationContext

Constructor Detail

WebFluxConfigurationSupport

Method Detail

setApplicationContext

getApplicationContext

webHandler

responseStatusExceptionHandler

requestMappingHandlerMapping

createRequestMappingHandlerMapping

webFluxContentTypeResolver

getDefaultMediaTypeMappings

configureContentTypeResolver

getCorsConfigurations

addCorsMappings

getPathMatchConfigurer

configurePathMatching

resourceHandlerMapping

addResourceHandlers

requestMappingHandlerAdapter

createRequestMappingHandlerAdapter

addArgumentResolvers

getMessageReaders

configureMessageReaders

addDefaultHttpMessageReaders

extendMessageReaders

getConfigurableWebBindingInitializer

webFluxConversionService

addFormatters

webFluxAdapterRegistry

webFluxValidator

getValidator

getMessageCodesResolver

simpleHandlerAdapter

responseEntityResultHandler

responseBodyResultHandler

getMessageWriters

configureMessageWriters

addDefaultHttpMessageWriters

extendMessageWriters

viewResolutionResultHandler

configureViewResolvers