org.springframework.web.reactive.result.method

Class InvocableHandlerMethod

java.lang.Object

org.springframework.web.method.HandlerMethod

org.springframework.web.reactive.result.method.InvocableHandlerMethod

public class InvocableHandlerMethod
extends HandlerMethod

Extension of HandlerMethod that invokes the underlying method with argument values resolved from the current HTTP request through a list of HandlerMethodArgumentResolver.

Since:

5.0

Author:

Rossen Stoyanchev, Juergen Hoeller

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.web.method.HandlerMethod

HandlerMethod.HandlerMethodParameter

Field Summary

Fields inherited from class org.springframework.web.method.HandlerMethod

logger

Constructor Summary

Constructors

Constructor and Description
InvocableHandlerMethod(HandlerMethod handlerMethod)
InvocableHandlerMethod(Object bean, Method method)

Method Summary

Modifier and Type	Method and Description
ParameterNameDiscoverer	getParameterNameDiscoverer() Return the configured parameter name discoverer.
List<HandlerMethodArgumentResolver>	getResolvers() Return the configured argument resolvers.
reactor.core.publisher.Mono<HandlerResult>	invoke(ServerWebExchange exchange, BindingContext bindingContext, Object... providedArgs) Invoke the method for the given exchange.
void	setArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) Configure the argument resolvers to use to use for resolving method argument values against a ServerWebExchange.
void	setParameterNameDiscoverer(ParameterNameDiscoverer nameDiscoverer) Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g.
void	setReactiveAdapterRegistry(ReactiveAdapterRegistry registry) Configure a reactive registry.

Methods inherited from class org.springframework.web.method.HandlerMethod

createWithResolvedBean, equals, getBean, getBeanType, getBridgedMethod, getMethod, getMethodAnnotation, getMethodParameters, getResolvedFromHandlerMethod, getResponseStatus, getResponseStatusReason, getReturnType, getReturnValueType, getShortLogMessage, hashCode, hasMethodAnnotation, isVoid, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InvocableHandlerMethod

public InvocableHandlerMethod(HandlerMethod handlerMethod)

InvocableHandlerMethod

public InvocableHandlerMethod(Object bean,
                              Method method)

Method Detail

setArgumentResolvers

public void setArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers)

Configure the argument resolvers to use to use for resolving method argument values against a ServerWebExchange.

getResolvers

public List<HandlerMethodArgumentResolver> getResolvers()

Return the configured argument resolvers.

setParameterNameDiscoverer

public void setParameterNameDiscoverer(ParameterNameDiscoverer nameDiscoverer)

Set the ParameterNameDiscoverer for resolving parameter names when needed (e.g. default request attribute name).

Default is a DefaultParameterNameDiscoverer.

getParameterNameDiscoverer

public ParameterNameDiscoverer getParameterNameDiscoverer()

Return the configured parameter name discoverer.

setReactiveAdapterRegistry

public void setReactiveAdapterRegistry(ReactiveAdapterRegistry registry)

Configure a reactive registry. This is needed for cases where the response is fully handled within the controller in combination with an async void return value.

By default this is an instance of ReactiveAdapterRegistry with default settings.

Parameters:

registry - the registry to use

invoke

public reactor.core.publisher.Mono<HandlerResult> invoke(ServerWebExchange exchange,
                                                         BindingContext bindingContext,
                                                         Object... providedArgs)

Invoke the method for the given exchange.

Parameters:

exchange - the current exchange

bindingContext - the binding context to use

providedArgs - optional list of argument values to match by type

Returns:

a Mono with a HandlerResult.