Spring Framework 6.1.4 · org.springframework.web.reactive.DispatcherHandler

Central dispatcher for HTTP request handlers/controllers. Dispatches to registered handlers for processing a request, providing convenient mapping facilities.

DispatcherHandler discovers the delegate components it needs from Spring configuration. It detects the following in the application context:

HandlerMapping -- map requests to handler objects
HandlerAdapter -- for using any handler interface
HandlerResultHandler -- process handler return values

DispatcherHandler is also designed to be a Spring bean itself and implements ApplicationContextAware for access to the context it runs in. If DispatcherHandler is declared as a bean with the name "webHandler", it is discovered by WebHttpHandlerBuilder#applicationContext(ApplicationContext) which puts together a processing chain together with WebFilter, WebExceptionHandler and others.

A DispatcherHandler bean declaration is included in @EnableWebFlux configuration.

Field Summary

Modifier and Type	Field and Description
private List<HandlerAdapter>	handlerAdapters
private List<HandlerMapping>	handlerMappings
private List<HandlerResultHandler>	resultHandlers

Constructor Summary

Access	Constructor and Description
public	DispatcherHandler() Create a new `DispatcherHandler` which needs to be configured with an `ApplicationContext` through `setApplicationContext`.
public	DispatcherHandler(ApplicationContext the application context to find the handler beans in applicationContext) Create a new `DispatcherHandler` for the given `ApplicationContext`.

Method Summary

Modifier and Type	Method and Description
private <R> Mono<R>	createNotFoundError()
public final List<HandlerMapping>	Returns: immutable list with the configured mappings or `null` getHandlerMappings() Return all `HandlerMapping` beans detected by type in the `injected context` and also `sorted`.
public Mono<Void>	handle(ServerWebExchange the current server exchange exchange) Implements org.springframework.web.server.WebHandler.handle. Handle the web server exchange.
public Mono<Void>	handlePreFlight(ServerWebExchange the exchange for the request exchange) Implements org.springframework.web.cors.reactive.PreFlightRequestHandler.handlePreFlight. Handle a pre-flight request by finding and applying the CORS configuration that matches the expected actual request.
private Mono<Void>	handleRequestWith(ServerWebExchange exchange, Object handler)
private Mono<Void>	handleResult(ServerWebExchange exchange, HandlerResult handlerResult, String description)
private Mono<Void>	handleResultMono(ServerWebExchange exchange, Mono<HandlerResult> resultMono)
protected void	initStrategies(ApplicationContext context)
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.

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

Field Detail

handlerAdapters	back to summary
private List<HandlerAdapter> handlerAdapters Annotations @Nullable

handlerMappings	back to summary
private List<HandlerMapping> handlerMappings Annotations @Nullable

resultHandlers	back to summary
private List<HandlerResultHandler> resultHandlers Annotations @Nullable

Constructor Detail

DispatcherHandler	back to summary
public DispatcherHandler() Create a new `DispatcherHandler` which needs to be configured with an `ApplicationContext` through `setApplicationContext`.

DispatcherHandler back to summary

DispatcherHandler	back to summary
public DispatcherHandler(ApplicationContext applicationContext) Create a new `DispatcherHandler` for the given `ApplicationContext`. Parameters applicationContext:ApplicationContext the application context to find the handler beans in

public DispatcherHandler(ApplicationContext applicationContext)

Create a new DispatcherHandler for the given ApplicationContext.

Parameters

applicationContext:ApplicationContext: the application context to find the handler beans in

Method Detail

createNotFoundError	back to summary
private <R> Mono<R> createNotFoundError()

getHandlerMappings back to summary

getHandlerMappings	back to summary
public final List<HandlerMapping> getHandlerMappings() Return all `HandlerMapping` beans detected by type in the `injected context` and also `sorted`. Note This method may return `null` if invoked prior to `setApplicationContext(ApplicationContext)`. Returns:List<HandlerMapping> immutable list with the configured mappings or `null` Annotations @Nullable

public final List<HandlerMapping> getHandlerMappings()

Return all HandlerMapping beans detected by type in the injected context and also sorted.

Note

This method may return null if invoked prior to setApplicationContext(ApplicationContext).

Returns:List<HandlerMapping>

immutable list with the configured mappings or null

Annotations

@Nullable

handle back to summary

handle	back to summary
public Mono<Void> handle(ServerWebExchange exchange) Implements org.springframework.web.server.WebHandler.handle. Doc from org.springframework.web.server.WebHandler.handle. Handle the web server exchange. Parameters exchange:ServerWebExchange the current server exchange Returns:Mono<Void> `Mono<Void>` to indicate when request handling is complete Annotations @Override

public Mono<Void> handle(ServerWebExchange exchange)

Implements org.springframework.web.server.WebHandler.handle.

Doc from org.springframework.web.server.WebHandler.handle.

Handle the web server exchange.

Parameters

exchange:ServerWebExchange: the current server exchange

Returns:Mono<Void>

Mono<Void> to indicate when request handling is complete

Annotations

@Override

handlePreFlight back to summary

handlePreFlight	back to summary
public Mono<Void> handlePreFlight(ServerWebExchange exchange) Implements org.springframework.web.cors.reactive.PreFlightRequestHandler.handlePreFlight. Doc from org.springframework.web.cors.reactive.PreFlightRequestHandler.handlePreFlight. Handle a pre-flight request by finding and applying the CORS configuration that matches the expected actual request. As a result of handling, the response should be updated with CORS headers or rejected with `org.springframework.http.HttpStatus#FORBIDDEN`. Parameters exchange:ServerWebExchange the exchange for the request Returns:Mono<Void> a completion handle Annotations @Override

public Mono<Void> handlePreFlight(ServerWebExchange exchange)

Implements org.springframework.web.cors.reactive.PreFlightRequestHandler.handlePreFlight.

Doc from org.springframework.web.cors.reactive.PreFlightRequestHandler.handlePreFlight.

Handle a pre-flight request by finding and applying the CORS configuration that matches the expected actual request. As a result of handling, the response should be updated with CORS headers or rejected with org.springframework.http.HttpStatus#FORBIDDEN.

Parameters

exchange:ServerWebExchange: the exchange for the request

Returns:Mono<Void>

a completion handle

Annotations

@Override

handleRequestWith	back to summary
private Mono<Void> handleRequestWith(ServerWebExchange exchange, Object handler)

handleResult	back to summary
private Mono<Void> handleResult(ServerWebExchange exchange, HandlerResult handlerResult, String description)

handleResultMono	back to summary
private Mono<Void> handleResultMono(ServerWebExchange exchange, Mono<HandlerResult> resultMono)

initStrategies	back to summary
protected void initStrategies(ApplicationContext context)

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

public Class DispatcherHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail