Class WebFluxConfigurationsupport

java.lang.Object

org.springframework.web.reactive.config.WebFluxConfigurationsupport

All Implemented Interfaces:

Aware, ApplicationContextAware

Direct Known subclasses:

DelegatingWebFluxConfiguration

public class WebFluxConfigurationsupport
extends Object
implements ApplicationContextAware

The main class for spring WebFlux configuration.

Import directly or extend and override protected methods to customize.

since:

5.0

Author:

Rossen stoyanchev, Brian Clozel

Constructor summary

Constructors

Constructor	Description
WebFluxConfigurationsupport()	 

Method summary

Modifier and Type	Method	Description
protected void	addCorsMappings(CorsRegistry registry)	Override this method to configure cross-origin requests processing.
protected void	addFormatters(FormatterRegistry registry)	Override this method to add custom Converter and/or Formatter delegates to the common FormattingConversionservice.
protected void	addResourceHandlers(ResourceHandlerRegistry registry)	Override this method to add resource handlers for serving static resources.
protected void	configureApiVersioning(ApiVersionConfigurer configurer)	Override this method to configure API versioning.
protected void	configureArgumentResolvers(ArgumentResolverConfigurer configurer)	Configure resolvers for custom controller method arguments.
protected void	configureBlockingExecution(BlockingExecutionConfigurer configurer)	Override this method to configure blocking execution.
protected void	configureContentTypeResolver(RequestedContentTypeResolverBuilder builder)	Override to configure how the requested content type is resolved.
protected void	configureErrorResponseInterceptors(List<ErrorResponse.Interceptor>&nbsp;interceptors)	Override this method for control over the ErrorResponse.Interceptor's to apply in result handling when rendering error responses.
protected void	configureHttpMessageCodecs(serverCodecConfigurer&nbsp;configurer)	Override to configure the HTTP message readers and writers to use.
void	configurePathMatching(PathMatchConfigurer&nbsp;configurer)	Override to configure path matching options.
protected void	configureViewResolvers(ViewResolverRegistry&nbsp;registry)	Configure view resolution for supporting template engines.
protected LocaleContextResolver	createLocaleContextResolver()	Override to plug a subclass of LocaleContextResolver.
protected RequestMappingHandlerAdapter	createRequestMappingHandlerAdapter()	Override to plug a subclass of RequestMappingHandlerAdapter.
protected RequestMappingHandlerMapping	createRequestMappingHandlerMapping()	Override to plug a subclass of RequestMappingHandlerMapping.
protected RouterFunctionMapping	createRouterFunctionMapping()	Override to plug a subclass of RouterFunctionMapping.
final @Nullable ApplicationContext	getApplicationContext()	&nbsp;
protected final BlockingExecutionConfigurer	getBlockingExecutionConfigurer()	Callback to build and cache the BlockingExecutionConfigurer.
protected ConfigurableWebBindingInitializer	getConfigurableWebBindingInitializer(FormattingConversionservice&nbsp;webFluxConversionservice, Validator&nbsp;webFluxValidator)	Return the ConfigurableWebBindingInitializer to use for initializing all WebDataBinder instances.
protected final Map<string, CorsConfiguration>	getCorsConfigurations()	Callback for building the global CORs configuration.
protected final List<ErrorResponse.Interceptor>	getErrorResponseInterceptors()	Provide access to the list of ErrorResponse.Interceptor's to apply in result handlers when rendering error responses.
protected @Nullable MessageCodesResolver	getMessageCodesResolver()	Override this method to provide a custom MessageCodesResolver.
protected final PathMatchConfigurer	getPathMatchConfigurer()	Callback for building the PathMatchConfigurer.
protected @Nullable Validator	getValidator()	Override this method to provide a custom Validator.
protected final ViewResolverRegistry	getViewResolverRegistry()	Callback for building the ViewResolverRegistry.
protected @Nullable Websocketservice	getWebsocketservice()	&nbsp;
HandlerFunctionAdapter	handlerFunctionAdapter()	&nbsp;
LocaleContextResolver	localeContextResolver()	&nbsp;
RequestMappingHandlerAdapter	requestMappingHandlerAdapter(ReactiveAdapterRegistry&nbsp;reactiveAdapterRegistry, serverCodecConfigurer&nbsp;serverCodecConfigurer, FormattingConversionservice&nbsp;conversionservice, RequestedContentTypeResolver&nbsp;contentTypeResolver, Validator&nbsp;validator)	&nbsp;
RequestMappingHandlerMapping	requestMappingHandlerMapping(RequestedContentTypeResolver&nbsp;contentTypeResolver, @Nullable ApiVersionstrategy&nbsp;apiVersionstrategy)	&nbsp;
HandlerMapping	resourceHandlerMapping(ResourceUrlProvider&nbsp;resourceUrlProvider)	Return a handler mapping ordered at Integer.MAX_VALUE-1 with mapped resource handlers.
ResourceUrlProvider	resourceUrlProvider()	&nbsp;
ResponseBodyResultHandler	responseBodyResultHandler(ReactiveAdapterRegistry&nbsp;reactiveAdapterRegistry, serverCodecConfigurer&nbsp;serverCodecConfigurer, RequestedContentTypeResolver&nbsp;contentTypeResolver)	&nbsp;
ResponseEntityResultHandler	responseEntityResultHandler(ReactiveAdapterRegistry&nbsp;reactiveAdapterRegistry, serverCodecConfigurer&nbsp;serverCodecConfigurer, RequestedContentTypeResolver&nbsp;contentTypeResolver)	&nbsp;
WebExceptionHandler	responsestatusExceptionHandler()	&nbsp;
RouterFunctionMapping	routerFunctionMapping(serverCodecConfigurer&nbsp;serverCodecConfigurer, @Nullable ApiVersionstrategy&nbsp;apiVersionstrategy)	&nbsp;
serverCodecConfigurer	serverCodecConfigurer()	Return the configurer for HTTP message readers and writers.
serverResponseResultHandler	serverResponseResultHandler(serverCodecConfigurer&nbsp;serverCodecConfigurer)	&nbsp;
void	setApplicationContext(@Nullable ApplicationContext&nbsp;applicationContext)	set the ApplicationContext that this object runs in.
simpleHandlerAdapter	simpleHandlerAdapter()	&nbsp;
ViewResolutionResultHandler	viewResolutionResultHandler(ReactiveAdapterRegistry&nbsp;reactiveAdapterRegistry, RequestedContentTypeResolver&nbsp;contentTypeResolver)	&nbsp;
ReactiveAdapterRegistry	webFluxAdapterRegistry()	Return a ReactiveAdapterRegistry to adapting reactive types.
@Nullable ApiVersionstrategy	webFluxApiVersionstrategy()	Return the central strategy to manage API versioning with, or null if the application does not use versioning.
RequestedContentTypeResolver	webFluxContentTypeResolver()	&nbsp;
FormattingConversionservice	webFluxConversionservice()	Return a FormattingConversionservice for use with annotated controllers.
Validator	webFluxValidator()	Return a global Validator instance for example for validating @RequestBody method arguments.
WebsocketHandlerAdapter	webFluxWebsocketHandlerAdapter()	&nbsp;
DispatcherHandler	webHandler()	&nbsp;

Methods inherited from class Object

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

Constructor Details

WebFluxConfigurationsupport

public WebFluxConfigurationsupport()

Method Details

setApplicationContext

public void setApplicationContext(@Nullable 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(ResourceLoader), ApplicationEventPublisherAware.setApplicationEventPublisher(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

public final @Nullable ApplicationContext getApplicationContext()

webHandler

@Bean
public DispatcherHandler webHandler()

responsestatusExceptionHandler

@Bean
@Order(0)
public WebExceptionHandler responsestatusExceptionHandler()

requestMappingHandlerMapping

@Bean
public RequestMappingHandlerMapping requestMappingHandlerMapping(@Qualifier("webFluxContentTypeResolver")
 RequestedContentTypeResolver contentTypeResolver,
 @Qualifier("webFluxApiVersionstrategy")
 @Nullable ApiVersionstrategy apiVersionstrategy)

createRequestMappingHandlerMapping

protected RequestMappingHandlerMapping createRequestMappingHandlerMapping()

Override to plug a subclass of RequestMappingHandlerMapping.

webFluxContentTypeResolver

@Bean
public RequestedContentTypeResolver webFluxContentTypeResolver()

configureContentTypeResolver

protected void configureContentTypeResolver(RequestedContentTypeResolverBuilder builder)

Override to configure how the requested content type is resolved.

webFluxApiVersionstrategy

@Bean
public @Nullable ApiVersionstrategy webFluxApiVersionstrategy()

Return the central strategy to manage API versioning with, or null if the application does not use versioning.

since:

7.0

configureApiVersioning

protected void configureApiVersioning(ApiVersionConfigurer configurer)

Override this method to configure API versioning.

since:

7.0

getCorsConfigurations

protected final&nbsp;Map<string, CorsConfiguration>&nbsp;getCorsConfigurations()

Callback for building the global CORs configuration. This method is final. Use addCorsMappings(CorsRegistry) to customize the CORs config.

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(PathMatchConfigurer) to customize path matching.

configurePathMatching

public void configurePathMatching(PathMatchConfigurer configurer)

Override to configure path matching options.

routerFunctionMapping

@Bean
public RouterFunctionMapping routerFunctionMapping(serverCodecConfigurer serverCodecConfigurer,
 @Nullable ApiVersionstrategy apiVersionstrategy)

createRouterFunctionMapping

protected RouterFunctionMapping createRouterFunctionMapping()

Override to plug a subclass of RouterFunctionMapping.

resourceHandlerMapping

@Bean
public HandlerMapping resourceHandlerMapping(ResourceUrlProvider resourceUrlProvider)

Return a handler mapping ordered at Integer.MAX_VALUE-1 with mapped resource handlers. To configure resource handling, override addResourceHandlers(ResourceHandlerRegistry).

resourceUrlProvider

@Bean
public ResourceUrlProvider resourceUrlProvider()

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(@Qualifier("webFluxAdapterRegistry")
 ReactiveAdapterRegistry reactiveAdapterRegistry,
 serverCodecConfigurer serverCodecConfigurer,
 @Qualifier("webFluxConversionservice")
 FormattingConversionservice conversionservice,
 @Qualifier("webFluxContentTypeResolver")
 RequestedContentTypeResolver contentTypeResolver,
 @Qualifier("webFluxValidator")
 Validator validator)

createRequestMappingHandlerAdapter

protected RequestMappingHandlerAdapter createRequestMappingHandlerAdapter()

Override to plug a subclass of RequestMappingHandlerAdapter.

configureArgumentResolvers

protected void configureArgumentResolvers(ArgumentResolverConfigurer configurer)

Configure resolvers for custom controller method arguments.

serverCodecConfigurer

@Bean
public serverCodecConfigurer serverCodecConfigurer()

Return the configurer for HTTP message readers and writers.

Use configureHttpMessageCodecs(serverCodecConfigurer) to configure the readers and writers.

createLocaleContextResolver

protected LocaleContextResolver createLocaleContextResolver()

Override to plug a subclass of LocaleContextResolver.

localeContextResolver

@Bean
public LocaleContextResolver localeContextResolver()

configureHttpMessageCodecs

protected void configureHttpMessageCodecs(serverCodecConfigurer configurer)

Override to configure the HTTP message readers and writers to use.

getConfigurableWebBindingInitializer

protected ConfigurableWebBindingInitializer getConfigurableWebBindingInitializer(FormattingConversionservice webFluxConversionservice,
 Validator webFluxValidator)

Return the ConfigurableWebBindingInitializer to use for initializing all WebDataBinder instances.

webFluxConversionservice

@Bean
public FormattingConversionservice webFluxConversionservice()

Return a FormattingConversionservice for use with annotated controllers.

see addFormatters(FormatterRegistry) as an alternative to overriding this method.

addFormatters

protected void addFormatters(FormatterRegistry registry)

Override this method to add custom Converter and/or Formatter delegates to the common FormattingConversionservice.

see Also:

• webFluxConversionservice()

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 @Nullable Validator getValidator()

Override this method to provide a custom Validator.

getMessageCodesResolver

protected @Nullable MessageCodesResolver getMessageCodesResolver()

Override this method to provide a custom MessageCodesResolver.

getBlockingExecutionConfigurer

protected final BlockingExecutionConfigurer getBlockingExecutionConfigurer()

Callback to build and cache the BlockingExecutionConfigurer. This method is final, but subclasses can override configureBlockingExecution(BlockingExecutionConfigurer).

since:

6.1

configureBlockingExecution

protected void configureBlockingExecution(BlockingExecutionConfigurer configurer)

Override this method to configure blocking execution.

since:

6.1

handlerFunctionAdapter

@Bean
public HandlerFunctionAdapter handlerFunctionAdapter()

simpleHandlerAdapter

@Bean
public simpleHandlerAdapter simpleHandlerAdapter()

webFluxWebsocketHandlerAdapter

@Bean
public WebsocketHandlerAdapter webFluxWebsocketHandlerAdapter()

getWebsocketservice

protected @Nullable Websocketservice getWebsocketservice()

responseEntityResultHandler

@Bean
public ResponseEntityResultHandler responseEntityResultHandler(@Qualifier("webFluxAdapterRegistry")
 ReactiveAdapterRegistry reactiveAdapterRegistry,
 serverCodecConfigurer serverCodecConfigurer,
 @Qualifier("webFluxContentTypeResolver")
 RequestedContentTypeResolver contentTypeResolver)

responseBodyResultHandler

@Bean
public ResponseBodyResultHandler responseBodyResultHandler(@Qualifier("webFluxAdapterRegistry")
 ReactiveAdapterRegistry reactiveAdapterRegistry,
 serverCodecConfigurer serverCodecConfigurer,
 @Qualifier("webFluxContentTypeResolver")
 RequestedContentTypeResolver contentTypeResolver)

viewResolutionResultHandler

@Bean
public ViewResolutionResultHandler viewResolutionResultHandler(@Qualifier("webFluxAdapterRegistry")
 ReactiveAdapterRegistry reactiveAdapterRegistry,
 @Qualifier("webFluxContentTypeResolver")
 RequestedContentTypeResolver contentTypeResolver)

serverResponseResultHandler

@Bean
public serverResponseResultHandler serverResponseResultHandler(serverCodecConfigurer serverCodecConfigurer)

getErrorResponseInterceptors

protected final&nbsp;List<ErrorResponse.Interceptor>&nbsp;getErrorResponseInterceptors()

Provide access to the list of ErrorResponse.Interceptor's to apply in result handlers when rendering error responses.

This method cannot be overridden; use configureErrorResponseInterceptors(List) instead.

since:

6.2

configureErrorResponseInterceptors

protected&nbsp;void&nbsp;configureErrorResponseInterceptors(List<ErrorResponse.Interceptor>&nbsp;interceptors)

Override this method for control over the ErrorResponse.Interceptor's to apply in result handling when rendering error responses.

Parameters:

interceptors - the list to add handlers to

since:

6.2

getViewResolverRegistry

protected final ViewResolverRegistry getViewResolverRegistry()

Callback for building the ViewResolverRegistry. This method is final, use configureViewResolvers(ViewResolverRegistry) to customize view resolvers.

configureViewResolvers

protected void configureViewResolvers(ViewResolverRegistry registry)

Configure view resolution for supporting template engines.

see Also:

• ViewResolverRegistry