org.springframework.web.reactive.result.method.annotation

Class RequestParamMethodArgumentResolver

java.lang.Object

org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver

org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver

org.springframework.web.reactive.result.method.annotation.RequestParamMethodArgumentResolver

All Implemented Interfaces:

HandlerMethodArgumentResolver, SyncHandlerMethodArgumentResolver

public class RequestParamMethodArgumentResolver
extends AbstractNamedValueSyncArgumentResolver

Resolver for method arguments annotated with @RequestParam.

This resolver can also be created in default resolution mode in which simple types (int, long, etc.) not annotated with @RequestParam are also treated as request parameters with the parameter name derived from the argument name.

If the method parameter type is Map, the name specified in the annotation is used to resolve the request parameter String value. The value is then converted to a Map via type conversion assuming a suitable Converter has been registered. Or if a request parameter name is not specified the RequestParamMapMethodArgumentResolver is used instead to provide access to all request parameters in the form of a map.

Since:

5.0

Author:

Rossen Stoyanchev

See Also:

RequestParamMapMethodArgumentResolver

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	RequestParamMethodArgumentResolver.RequestParamNamedValueInfo

Nested classes/interfaces inherited from class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver

AbstractNamedValueArgumentResolver.NamedValueInfo

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	useDefaultResolution

Constructor Summary

Constructors

Constructor and Description
RequestParamMethodArgumentResolver(ConfigurableBeanFactory beanFactory) Class constructor.
RequestParamMethodArgumentResolver(ConfigurableBeanFactory beanFactory, boolean useDefaultResolution) Class constructor with a default resolution mode flag.

Method Summary

Modifier and Type	Method and Description
protected AbstractNamedValueArgumentResolver.NamedValueInfo	createNamedValueInfo(MethodParameter parameter) Create the AbstractNamedValueArgumentResolver.NamedValueInfo object for the given method parameter.
private MultiValueMap<java.lang.String,java.lang.String>	getRequestParams(ServerWebExchange exchange)
protected void	handleMissingValue(java.lang.String name, MethodParameter parameter, ServerWebExchange exchange) Invoked when a named value is required, but AbstractNamedValueArgumentResolver.resolveName(String, MethodParameter, ServerWebExchange) returned null and there is no default value.
protected java.util.Optional<java.lang.Object>	resolveNamedValue(java.lang.String name, MethodParameter parameter, ServerWebExchange exchange) An abstract method for synchronous resolution of method argument values that sub-classes must implement.
boolean	supportsParameter(MethodParameter parameter)

Methods inherited from class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver

resolveArgumentValue, resolveName

Methods inherited from class org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver

handleMissingValue, handleResolvedValue, resolveArgument

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.reactive.result.method.SyncHandlerMethodArgumentResolver

resolveArgument

Field Detail

useDefaultResolution

private final boolean useDefaultResolution

Constructor Detail

RequestParamMethodArgumentResolver

public RequestParamMethodArgumentResolver(ConfigurableBeanFactory beanFactory)

Class constructor.

Parameters:

beanFactory - a bean factory used for resolving ${...} placeholder and #{...} SpEL expressions in default values, or null if default values are not expected to contain expressions

RequestParamMethodArgumentResolver

public RequestParamMethodArgumentResolver(ConfigurableBeanFactory beanFactory,
                                          boolean useDefaultResolution)

Class constructor with a default resolution mode flag.

Parameters:

beanFactory - a bean factory used for resolving ${...} placeholder and #{...} SpEL expressions in default values, or null if default values are not expected to contain expressions

useDefaultResolution - in default resolution mode a method argument that is a simple type, as defined in BeanUtils.isSimpleProperty(java.lang.Class<?>), is treated as a request parameter even if it isn't annotated, the request parameter name is derived from the method parameter name.

Method Detail

supportsParameter

public boolean supportsParameter(MethodParameter parameter)

createNamedValueInfo

protected AbstractNamedValueArgumentResolver.NamedValueInfo createNamedValueInfo(MethodParameter parameter)

Description copied from class: AbstractNamedValueArgumentResolver

Create the AbstractNamedValueArgumentResolver.NamedValueInfo object for the given method parameter. Implementations typically retrieve the method annotation by means of MethodParameter.getParameterAnnotation(Class).

Specified by:

createNamedValueInfo in class AbstractNamedValueArgumentResolver

Parameters:

parameter - the method parameter

Returns:

the named value information

resolveNamedValue

protected java.util.Optional<java.lang.Object> resolveNamedValue(java.lang.String name,
                                                                 MethodParameter parameter,
                                                                 ServerWebExchange exchange)

Description copied from class: AbstractNamedValueSyncArgumentResolver

An abstract method for synchronous resolution of method argument values that sub-classes must implement.

Specified by:

resolveNamedValue in class AbstractNamedValueSyncArgumentResolver

Parameters:

name - the name of the value being resolved

parameter - the method parameter to resolve to an argument value (pre-nested in case of a Optional declaration)

exchange - the current exchange

Returns:

the resolved argument value, if any

getRequestParams

private MultiValueMap<java.lang.String,java.lang.String> getRequestParams(ServerWebExchange exchange)

handleMissingValue

protected void handleMissingValue(java.lang.String name,
                                  MethodParameter parameter,
                                  ServerWebExchange exchange)

Description copied from class: AbstractNamedValueArgumentResolver

Invoked when a named value is required, but AbstractNamedValueArgumentResolver.resolveName(String, MethodParameter, ServerWebExchange) returned null and there is no default value. Subclasses typically throw an exception in this case.

Overrides:

handleMissingValue in class AbstractNamedValueArgumentResolver

Parameters:

name - the name for the value

parameter - the method parameter

exchange - the current exchange