Spring Framework 6.1.4 · org.springframework.web.reactive.function.server.support.RouterFunctionMapping

Modifier and Type	Field and Description
private List<HttpMessageReader<?>>	messageReaders
private RouterFunction<?>	routerFunction

Access	Constructor and Description
public	RouterFunctionMapping() Create an empty `RouterFunctionMapping`.
public	RouterFunctionMapping(RouterFunction<?> the router function to use for mapping routerFunction) Create a `RouterFunctionMapping` with the given `RouterFunction`.

Method Summary

Modifier and Type	Method and Description
public void	afterPropertiesSet() Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.
protected Mono<?>	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.
public RouterFunction<?>	Returns: the router function or `null` getRouterFunction() Return the configured `RouterFunction`.
protected void	initRouterFunctions() Initialized the router functions by detecting them in the application context.
private void	logRouterFunctions(List<RouterFunction<?>> routerFunctions)
private List<RouterFunction<?>>	routerFunctions()
private void	setAttributes(Map<String, Object> attributes, ServerRequest serverRequest, HandlerFunction<?> handlerFunction)
public void	setMessageReaders(List<HttpMessageReader<?>> messageReaders) Configure HTTP message readers to de-serialize the request body with.

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

Field Detail

messageReaders	back to summary
private List<HttpMessageReader<?>> messageReaders

routerFunction	back to summary
private RouterFunction<?> routerFunction Annotations @Nullable

Constructor Detail

RouterFunctionMapping back to summary

RouterFunctionMapping	back to summary
public RouterFunctionMapping() Create an empty `RouterFunctionMapping`. If this constructor is used, this mapping will detect all `RouterFunction` instances available in the application context.

public RouterFunctionMapping()

Create an empty RouterFunctionMapping.

If this constructor is used, this mapping will detect all RouterFunction instances available in the application context.

RouterFunctionMapping back to summary

RouterFunctionMapping	back to summary
public RouterFunctionMapping(RouterFunction<?> routerFunction) Create a `RouterFunctionMapping` with the given `RouterFunction`. If this constructor is used, no application context detection will occur. Parameters routerFunction:RouterFunction<?> the router function to use for mapping

public RouterFunctionMapping(RouterFunction<?> routerFunction)

Create a RouterFunctionMapping with the given RouterFunction.

If this constructor is used, no application context detection will occur.

Parameters

routerFunction:RouterFunction<?>: the router function to use for mapping

Method Detail

afterPropertiesSet back to summary

afterPropertiesSet	back to summary
public void afterPropertiesSet() throws Exception Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet. Invoked by the containing `BeanFactory` after it has set all bean properties and satisfied `BeanFactoryAware`, `ApplicationContextAware` etc. This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set. Annotations @Override Exceptions Exception: in the event of misconfiguration (such as failure to set an essential property) or if initialization fails for any other reason

public void afterPropertiesSet() throws Exception

Implements org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Doc from org.springframework.beans.factory.InitializingBean.afterPropertiesSet.

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Annotations

@Override

Exceptions

Exception:: in the event of misconfiguration (such as failure to set an essential property) or if initialization fails for any other reason

getHandlerInternal back to summary

getHandlerInternal	back to summary
protected Mono<?> 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<?> `Mono` for the matching handler, if any Annotations @Override

protected Mono<?> 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<?>

Mono for the matching handler, if any

Annotations

@Override

getRouterFunction back to summary

getRouterFunction	back to summary
public RouterFunction<?> getRouterFunction() Return the configured `RouterFunction`. Note When router functions are detected from the ApplicationContext, this method may return `null` if invoked prior to `afterPropertiesSet()`. Returns:RouterFunction<?> the router function or `null` Annotations @Nullable

public RouterFunction<?> getRouterFunction()

Return the configured RouterFunction.

Note

When router functions are detected from the ApplicationContext, this method may return null if invoked prior to afterPropertiesSet().

Returns:RouterFunction<?>

the router function or null

Annotations

@Nullable

initRouterFunctions	back to summary
protected void initRouterFunctions() Initialized the router functions by detecting them in the application context.

logRouterFunctions	back to summary
private void logRouterFunctions(List<RouterFunction<?>> routerFunctions)

routerFunctions	back to summary
private List<RouterFunction<?>> routerFunctions()

setAttributes	back to summary
private void setAttributes(Map<String, Object> attributes, ServerRequest serverRequest, HandlerFunction<?> handlerFunction) Annotations @SuppressWarnings:unchecked, removal

setMessageReaders back to summary

setMessageReaders	back to summary
public void setMessageReaders(List<HttpMessageReader<?>> messageReaders) Configure HTTP message readers to de-serialize the request body with. By default this is set to the `ServerCodecConfigurer`'s defaults.

public void setMessageReaders(List<HttpMessageReader<?>> messageReaders)

Configure HTTP message readers to de-serialize the request body with.

By default this is set to the ServerCodecConfigurer's defaults.

public Class RouterFunctionMapping

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail