Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	WebFluxConfigurationSupport.EmptyHandlerMapping
private static class	WebFluxConfigurationSupport.NoOpValidator
private static class	WebFluxConfigurationSupport.NoUpgradeStrategyWebSocketService

Modifier and Type	Field and Description
private ApplicationContext	applicationContext
private BlockingExecutionConfigurer	blockingExecutionConfigurer
private Map<String, CorsConfiguration>	corsConfigurations
private static final boolean	jakartaValidatorPresent
private PathMatchConfigurer	pathMatchConfigurer
private ViewResolverRegistry	viewResolverRegistry

Constructor Summary

Access	Constructor and Description
public	WebFluxConfigurationSupport()

Method Summary

Modifier and Type	Method and 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.
private void	configureAbstractHandlerMapping(AbstractHandlerMapping mapping, PathMatchConfigurer configurer)
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	configureHttpMessageCodecs(ServerCodecConfigurer configurer) Override to configure the HTTP message readers and writers to use.
public void	configurePathMatching(PathMatchConfigurer configurer) Override to configure path matching options.
protected void	configureViewResolvers(ViewResolverRegistry 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`.
public final ApplicationContext	getApplicationContext()
protected final BlockingExecutionConfigurer	getBlockingExecutionConfigurer() Callback to build and cache the `BlockingExecutionConfigurer`.
protected ConfigurableWebBindingInitializer	getConfigurableWebBindingInitializer(FormattingConversionService webFluxConversionService, Validator 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 MessageCodesResolver	getMessageCodesResolver() Override this method to provide a custom `MessageCodesResolver`.
protected final PathMatchConfigurer	getPathMatchConfigurer() Callback for building the `PathMatchConfigurer`.
protected Validator	getValidator() Override this method to provide a custom `Validator`.
protected final ViewResolverRegistry	getViewResolverRegistry() Callback for building the `ViewResolverRegistry`.
protected WebSocketService	getWebSocketService()
public HandlerFunctionAdapter	handlerFunctionAdapter()
private WebSocketService	initWebSocketService()
public LocaleContextResolver	localeContextResolver()
public RequestMappingHandlerAdapter	requestMappingHandlerAdapter(ReactiveAdapterRegistry reactiveAdapterRegistry, ServerCodecConfigurer serverCodecConfigurer, FormattingConversionService conversionService, Validator validator)
public RequestMappingHandlerMapping	requestMappingHandlerMapping(RequestedContentTypeResolver contentTypeResolver)
public HandlerMapping	resourceHandlerMapping(ResourceUrlProvider resourceUrlProvider) Return a handler mapping ordered at Integer.MAX_VALUE-1 with mapped resource handlers.
public ResourceUrlProvider	resourceUrlProvider()
public ResponseBodyResultHandler	responseBodyResultHandler(ReactiveAdapterRegistry reactiveAdapterRegistry, ServerCodecConfigurer serverCodecConfigurer, RequestedContentTypeResolver contentTypeResolver)
public ResponseEntityResultHandler	responseEntityResultHandler(ReactiveAdapterRegistry reactiveAdapterRegistry, ServerCodecConfigurer serverCodecConfigurer, RequestedContentTypeResolver contentTypeResolver)
public WebExceptionHandler	responseStatusExceptionHandler()
public RouterFunctionMapping	routerFunctionMapping(ServerCodecConfigurer serverCodecConfigurer)
public ServerCodecConfigurer	serverCodecConfigurer() Return the configurer for HTTP message readers and writers.
public ServerResponseResultHandler	serverResponseResultHandler(ServerCodecConfigurer serverCodecConfigurer)
public void	setApplicationContext(ApplicationContext the ApplicationContext object to be used by this object applicationContext) Implements org.springframework.context.ApplicationContextAware.setApplicationContext. Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.
public SimpleHandlerAdapter	simpleHandlerAdapter()
public ViewResolutionResultHandler	viewResolutionResultHandler(ReactiveAdapterRegistry reactiveAdapterRegistry, RequestedContentTypeResolver contentTypeResolver)
public ReactiveAdapterRegistry	webFluxAdapterRegistry() Return a `ReactiveAdapterRegistry` to adapting reactive types.
public RequestedContentTypeResolver	webFluxContentTypeResolver()
public FormattingConversionService	webFluxConversionService() Return a `FormattingConversionService` for use with annotated controllers.
public Validator	webFluxValidator() Return a global `Validator` instance for example for validating `@RequestBody` method arguments.
public WebSocketHandlerAdapter	webFluxWebSocketHandlerAdapter()
public DispatcherHandler	webHandler()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

applicationContext	back to summary
private ApplicationContext applicationContext Annotations @Nullable

blockingExecutionConfigurer	back to summary
private BlockingExecutionConfigurer blockingExecutionConfigurer Annotations @Nullable

corsConfigurations	back to summary
private Map<String, CorsConfiguration> corsConfigurations Annotations @Nullable

jakartaValidatorPresent	back to summary
private static final boolean jakartaValidatorPresent

pathMatchConfigurer	back to summary
private PathMatchConfigurer pathMatchConfigurer Annotations @Nullable

viewResolverRegistry	back to summary
private ViewResolverRegistry viewResolverRegistry Annotations @Nullable

Constructor Detail

WebFluxConfigurationSupport	back to summary
public WebFluxConfigurationSupport()

Method Detail

addCorsMappings back to summary

addCorsMappings	back to summary
protected void addCorsMappings(CorsRegistry registry) Override this method to configure cross-origin requests processing. See Also `CorsRegistry`

protected void addCorsMappings(CorsRegistry registry)

Override this method to configure cross-origin requests processing.

See Also: CorsRegistry

addFormatters back to summary

addFormatters	back to summary
protected void addFormatters(FormatterRegistry registry) Override this method to add custom `Converter` and/or `Formatter` delegates to the common `FormattingConversionService`. See Also `webFluxConversionService()`

protected void addFormatters(FormatterRegistry registry)

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

See Also: webFluxConversionService()

addResourceHandlers back to summary

addResourceHandlers	back to summary
protected void addResourceHandlers(ResourceHandlerRegistry registry) Override this method to add resource handlers for serving static resources. See Also `ResourceHandlerRegistry`

protected void addResourceHandlers(ResourceHandlerRegistry registry)

Override this method to add resource handlers for serving static resources.

See Also: ResourceHandlerRegistry

configureAbstractHandlerMapping	back to summary
private void configureAbstractHandlerMapping(AbstractHandlerMapping mapping, PathMatchConfigurer configurer) Annotations @SuppressWarnings:deprecation

configureArgumentResolvers	back to summary
protected void configureArgumentResolvers(ArgumentResolverConfigurer configurer) Configure resolvers for custom controller method arguments.

configureBlockingExecution	back to summary
protected void configureBlockingExecution(BlockingExecutionConfigurer configurer) Override this method to configure blocking execution. Since 6.1

configureBlockingExecution

back to summary

protected void configureBlockingExecution(BlockingExecutionConfigurer configurer)

Override this method to configure blocking execution.

Since: 6.1

configureContentTypeResolver	back to summary
protected void configureContentTypeResolver(RequestedContentTypeResolverBuilder builder) Override to configure how the requested content type is resolved.

configureHttpMessageCodecs	back to summary
protected void configureHttpMessageCodecs(ServerCodecConfigurer configurer) Override to configure the HTTP message readers and writers to use.

configurePathMatching	back to summary
public void configurePathMatching(PathMatchConfigurer configurer) Override to configure path matching options.

configureViewResolvers back to summary

configureViewResolvers	back to summary
protected void configureViewResolvers(ViewResolverRegistry registry) Configure view resolution for supporting template engines. See Also `ViewResolverRegistry`

protected void configureViewResolvers(ViewResolverRegistry registry)

Configure view resolution for supporting template engines.

See Also: ViewResolverRegistry

createLocaleContextResolver	back to summary
protected LocaleContextResolver createLocaleContextResolver() Override to plug a subclass of `LocaleContextResolver`.

createRequestMappingHandlerAdapter	back to summary
protected RequestMappingHandlerAdapter createRequestMappingHandlerAdapter() Override to plug a subclass of `RequestMappingHandlerAdapter`.

createRequestMappingHandlerMapping	back to summary
protected RequestMappingHandlerMapping createRequestMappingHandlerMapping() Override to plug a subclass of `RequestMappingHandlerMapping`.

createRouterFunctionMapping	back to summary
protected RouterFunctionMapping createRouterFunctionMapping() Override to plug a subclass of `RouterFunctionMapping`.

getApplicationContext	back to summary
public final ApplicationContext getApplicationContext() Annotations @Nullable

getBlockingExecutionConfigurer back to summary

getBlockingExecutionConfigurer	back to summary
protected final BlockingExecutionConfigurer getBlockingExecutionConfigurer() Callback to build and cache the `BlockingExecutionConfigurer`. This method is final, but subclasses can override `configureBlockingExecution`. Since 6.1

protected final BlockingExecutionConfigurer getBlockingExecutionConfigurer()

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

Since: 6.1

getConfigurableWebBindingInitializer	back to summary
protected ConfigurableWebBindingInitializer getConfigurableWebBindingInitializer(FormattingConversionService webFluxConversionService, Validator webFluxValidator) Return the `ConfigurableWebBindingInitializer` to use for initializing all `WebDataBinder` instances.

getCorsConfigurations	back to summary
protected final Map<String, CorsConfiguration> getCorsConfigurations() Callback for building the global CORS configuration. This method is final. Use `addCorsMappings(CorsRegistry)` to customize the CORS config.

getMessageCodesResolver back to summary

getMessageCodesResolver	back to summary
protected MessageCodesResolver getMessageCodesResolver() Override this method to provide a custom `MessageCodesResolver`. Annotations @Nullable

protected MessageCodesResolver getMessageCodesResolver()

Override this method to provide a custom MessageCodesResolver.

Annotations

@Nullable

getPathMatchConfigurer	back to summary
protected final PathMatchConfigurer getPathMatchConfigurer() Callback for building the `PathMatchConfigurer`. This method is final, use `configurePathMatching` to customize path matching.

getValidator back to summary

getValidator	back to summary
protected Validator getValidator() Override this method to provide a custom `Validator`. Annotations @Nullable

protected Validator getValidator()

Override this method to provide a custom Validator.

Annotations

@Nullable

getViewResolverRegistry	back to summary
protected final ViewResolverRegistry getViewResolverRegistry() Callback for building the `ViewResolverRegistry`. This method is final, use `configureViewResolvers` to customize view resolvers.

getWebSocketService	back to summary
protected WebSocketService getWebSocketService() Annotations @Nullable

handlerFunctionAdapter	back to summary
public HandlerFunctionAdapter handlerFunctionAdapter() Annotations @Bean

initWebSocketService	back to summary
private WebSocketService initWebSocketService()

localeContextResolver	back to summary
public LocaleContextResolver localeContextResolver() Annotations @Bean

requestMappingHandlerAdapter	back to summary
public RequestMappingHandlerAdapter requestMappingHandlerAdapter(ReactiveAdapterRegistry reactiveAdapterRegistry, ServerCodecConfigurer serverCodecConfigurer, FormattingConversionService conversionService, Validator validator) Annotations @Bean

requestMappingHandlerMapping	back to summary
public RequestMappingHandlerMapping requestMappingHandlerMapping(RequestedContentTypeResolver contentTypeResolver) Annotations @Bean

resourceHandlerMapping back to summary

resourceHandlerMapping	back to summary
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`. Annotations @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.

Annotations

@Bean

resourceUrlProvider	back to summary
public ResourceUrlProvider resourceUrlProvider() Annotations @Bean

responseBodyResultHandler	back to summary
public ResponseBodyResultHandler responseBodyResultHandler(ReactiveAdapterRegistry reactiveAdapterRegistry, ServerCodecConfigurer serverCodecConfigurer, RequestedContentTypeResolver contentTypeResolver) Annotations @Bean

responseEntityResultHandler	back to summary
public ResponseEntityResultHandler responseEntityResultHandler(ReactiveAdapterRegistry reactiveAdapterRegistry, ServerCodecConfigurer serverCodecConfigurer, RequestedContentTypeResolver contentTypeResolver) Annotations @Bean

responseStatusExceptionHandler	back to summary
public WebExceptionHandler responseStatusExceptionHandler() Annotations @Bean @Order:0

routerFunctionMapping	back to summary
public RouterFunctionMapping routerFunctionMapping(ServerCodecConfigurer serverCodecConfigurer) Annotations @Bean

serverCodecConfigurer back to summary

serverCodecConfigurer	back to summary
public ServerCodecConfigurer serverCodecConfigurer() Return the configurer for HTTP message readers and writers. Use `configureHttpMessageCodecs(ServerCodecConfigurer)` to configure the readers and writers. Annotations @Bean

public ServerCodecConfigurer serverCodecConfigurer()

Return the configurer for HTTP message readers and writers.

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

Annotations

@Bean

serverResponseResultHandler	back to summary
public ServerResponseResultHandler serverResponseResultHandler(ServerCodecConfigurer serverCodecConfigurer) Annotations @Bean

setApplicationContext back to summary

setApplicationContext	back to summary
public void setApplicationContext(ApplicationContext applicationContext) Implements org.springframework.context.ApplicationContextAware.setApplicationContext. Doc from org.springframework.context.ApplicationContextAware.setApplicationContext. 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 `org.springframework.beans.factory.InitializingBean#afterPropertiesSet()` or a custom init-method. Invoked after `ResourceLoaderAware#setResourceLoader`, `ApplicationEventPublisherAware#setApplicationEventPublisher` and `MessageSourceAware`, if applicable. Parameters applicationContext:ApplicationContext the ApplicationContext object to be used by this object Annotations @Override

public void setApplicationContext(ApplicationContext applicationContext)

Implements org.springframework.context.ApplicationContextAware.setApplicationContext.

Doc from org.springframework.context.ApplicationContextAware.setApplicationContext.

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 org.springframework.beans.factory.InitializingBean#afterPropertiesSet() or a custom init-method. Invoked after ResourceLoaderAware#setResourceLoader, ApplicationEventPublisherAware#setApplicationEventPublisher and MessageSourceAware, if applicable.

Parameters

applicationContext:ApplicationContext: the ApplicationContext object to be used by this object

Annotations

@Override

simpleHandlerAdapter	back to summary
public SimpleHandlerAdapter simpleHandlerAdapter() Annotations @Bean

viewResolutionResultHandler	back to summary
public ViewResolutionResultHandler viewResolutionResultHandler(ReactiveAdapterRegistry reactiveAdapterRegistry, RequestedContentTypeResolver contentTypeResolver) Annotations @Bean

webFluxAdapterRegistry back to summary

public ReactiveAdapterRegistry webFluxAdapterRegistry()

Return a ReactiveAdapterRegistry to adapting reactive types.

Annotations

@Bean

webFluxContentTypeResolver	back to summary
public RequestedContentTypeResolver webFluxContentTypeResolver() Annotations @Bean

webFluxConversionService back to summary

public FormattingConversionService webFluxConversionService()

Return a FormattingConversionService for use with annotated controllers.

See addFormatters as an alternative to overriding this method.

Annotations

@Bean

webFluxValidator back to summary

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.

Annotations

@Bean

webFluxWebSocketHandlerAdapter	back to summary
public WebSocketHandlerAdapter webFluxWebSocketHandlerAdapter() Annotations @Bean

webHandler	back to summary
public DispatcherHandler webHandler() Annotations @Bean

org.springframework.web.reactive.config back to summary

private final Class WebFluxConfigurationSupport.EmptyHandlerMapping

Class Inheritance

extends AbstractHandlerMapping

java.lang.Object
org.springframework.context.support.ApplicationObjectSupport
org.springframework.web.reactive.handler.AbstractHandlerMapping
org.springframework.web.reactive.config.WebFluxConfigurationSupport.EmptyHandlerMapping

Field Summary

Inherited from org.springframework.web.reactive.handler.AbstractHandlerMapping:: mappingsLogger

Constructor Summary

Access	Constructor and Description
private	EmptyHandlerMapping()

Method Summary

Modifier and Type	Method and Description
public Mono<Object>	getHandlerInternal(ServerWebExchange current exchange exchange) Implements abstract org.springframework.web.reactive.handler.AbstractHandlerMapping.getHandlerInternal. Look up a handler for the given request, returning an empty `Mono` if no specific one is found.

Inherited from org.springframework.web.reactive.handler.AbstractHandlerMapping:: formatMappingName getCorsConfiguration getCorsProcessor getHandler getOrder getPathPatternParser hasCorsConfigurationSource setBeanName setCorsConfigurations setCorsConfigurationSource setCorsProcessor setOrder setUseCaseSensitiveMatch setUseTrailingSlashMatch

Constructor Detail

EmptyHandlerMapping	back to summary
private EmptyHandlerMapping()

Method Detail

getHandlerInternal back to summary

public Mono<Object> getHandlerInternal(ServerWebExchange exchange)

Implements abstract org.springframework.web.reactive.handler.AbstractHandlerMapping.getHandlerInternal.

Doc from org.springframework.web.reactive.handler.AbstractHandlerMapping.getHandlerInternal.

Look up a handler for the given request, returning an empty Mono if no specific one is found. This method is called by getHandler.

On CORS pre-flight requests this method should return a match not for the pre-flight request but for the expected actual request based on the URL path, the HTTP methods from the "Access-Control-Request-Method" header, and the headers from the "Access-Control-Request-Headers" header.

Parameters

exchange:ServerWebExchange: current exchange

Returns:Mono<Object>

Mono for the matching handler, if any

Annotations

@Override

org.springframework.web.reactive.config back to summary

private final Class WebFluxConfigurationSupport.NoOpValidator

Class Inheritance

extends Object
implements Validator

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

All Implemented Interfaces

org.springframework.validation.Validator

Constructor Summary

Access	Constructor and Description
private	NoOpValidator()

Method Summary

Modifier and Type	Method and Description
public boolean	supports(Class<?> the `Class` that this `Validator` is being asked if it can `validate` clazz) Implements org.springframework.validation.Validator.supports. Can this `Validator` `validate` instances of the supplied `clazz`?
public void	validate(Object the object that is to be validated target, Errors contextual state about the validation process errors) Implements org.springframework.validation.Validator.validate. Validate the given `target` object which must be of a `Class` for which the `supports(Class)` method typically has returned (or would return) `true`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

NoOpValidator	back to summary
private NoOpValidator()

Method Detail

supports back to summary

public boolean supports(Class<?> clazz)

Implements org.springframework.validation.Validator.supports.

Doc from org.springframework.validation.Validator.supports.

Can this Validator validate instances of the supplied clazz?

This method is typically implemented like so:

return Foo.class.isAssignableFrom(clazz);

(Where Foo is the class (or superclass) of the actual object instance that is to be validated.)

Parameters

clazz:Class<?>: the Class that this Validator is being asked if it can validate

Returns:boolean

true if this Validator can indeed validate instances of the supplied clazz

Annotations

@Override

validate back to summary

public void validate(Object target, Errors errors)

Implements org.springframework.validation.Validator.validate.

Doc from org.springframework.validation.Validator.validate.

Validate the given target object which must be of a Class for which the supports(Class) method typically has returned (or would return) true.

The supplied errors instance can be used to report any resulting validation errors, typically as part of a larger binding process which this validator is meant to participate in. Binding errors have typically been pre-registered with the errors instance before this invocation already.

Parameters

target:Object: the object that is to be validated
errors:Errors: contextual state about the validation process

Annotations

@Override

org.springframework.web.reactive.config back to summary

private final Class WebFluxConfigurationSupport.NoUpgradeStrategyWebSocketService

Class Inheritance

extends Object
implements WebSocketService

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

All Implemented Interfaces

org.springframework.web.reactive.socket.server.WebSocketService

Constructor Summary

Access	Constructor and Description
private	NoUpgradeStrategyWebSocketService()

Method Summary

Modifier and Type	Method and Description
public Mono<Void>	handleRequest(ServerWebExchange the current exchange exchange, WebSocketHandler handler for WebSocket session webSocketHandler) Implements org.springframework.web.reactive.socket.server.WebSocketService.handleRequest. Handle the request with the given `WebSocketHandler`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

NoUpgradeStrategyWebSocketService	back to summary
private NoUpgradeStrategyWebSocketService()

Method Detail

handleRequest back to summary

public Mono<Void> handleRequest(ServerWebExchange exchange, WebSocketHandler webSocketHandler)

Implements org.springframework.web.reactive.socket.server.WebSocketService.handleRequest.

Doc from org.springframework.web.reactive.socket.server.WebSocketService.handleRequest.

Handle the request with the given WebSocketHandler.

Parameters

exchange:ServerWebExchange: the current exchange
webSocketHandler:WebSocketHandler: handler for WebSocket session

Returns:Mono<Void>

a Mono<Void> that completes when application handling of the WebSocket session completes.

Annotations

@Override

public Class WebFluxConfigurationSupport

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class WebFluxConfigurationSupport.EmptyHandlerMapping

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class WebFluxConfigurationSupport.NoOpValidator

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private final Class WebFluxConfigurationSupport.NoUpgradeStrategyWebSocketService

Constructor Summary

Method Summary

Constructor Detail

Method Detail