Resolver for method arguments annotated with @RequestParam from URI query string parameters.

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.

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
private final boolean	useDefaultResolution

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	RequestParamMethodArgumentResolver(ConfigurableBeanFactory a bean factory used for resolving ${...} placeholder and #{...} SpEL expressions in default values, or `null` if default values are not expected to contain expressions factory, ReactiveAdapterRegistry for checking reactive type wrappers registry, boolean in default resolution mode a method argument that is a simple type, as defined in `BeanUtils#isSimpleProperty`, is treated as a request parameter even if it isn't annotated, the request parameter name is derived from the method parameter name. useDefaultResolution) Class constructor with a default resolution mode flag.

public

RequestParamMethodArgumentResolver(ConfigurableBeanFactory

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

factory, ReactiveAdapterRegistry

for checking reactive type wrappers

registry, boolean

in default resolution mode a method argument that is a simple type, as defined in BeanUtils#isSimpleProperty, is treated as a request parameter even if it isn't annotated, the request parameter name is derived from the method parameter name.

useDefaultResolution)

Class constructor with a default resolution mode flag.

Method Summary

Modifier and Type	Method and Description
protected AbstractNamedValueArgumentResolver.NamedValueInfo	createNamedValueInfo(MethodParameter the method parameter parameter) Implements abstract org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver.createNamedValueInfo. Create the `NamedValueInfo` object for the given method parameter.
protected void	handleMissingValue(String the name for the value name, MethodParameter the method parameter parameter, ServerWebExchange the current exchange exchange) Overrides org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver.handleMissingValue. Invoked when a named value is required, but `resolveName(String, MethodParameter, ServerWebExchange)` returned `null` and there is no default value.
protected Object	resolveNamedValue(String name, MethodParameter parameter, ServerWebExchange exchange) Implements abstract org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver.resolveNamedValue. Actually resolve the value synchronously.
private boolean	singleParam(RequestParam requestParam, Class<?> type)
public boolean	supportsParameter(MethodParameter the method parameter param) Implements org.springframework.web.reactive.result.method.HandlerMethodArgumentResolver.supportsParameter. Whether this resolver supports the given method parameter.

Inherited from org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver:: resolveArgument resolveArgumentValue resolveName

Field Detail

useDefaultResolution	back to summary
private final boolean useDefaultResolution

Constructor Detail

RequestParamMethodArgumentResolver back to summary

RequestParamMethodArgumentResolver	back to summary
public RequestParamMethodArgumentResolver(ConfigurableBeanFactory factory, ReactiveAdapterRegistry registry, boolean useDefaultResolution) Class constructor with a default resolution mode flag. Parameters factory:ConfigurableBeanFactory a bean factory used for resolving ${...} placeholder and #{...} SpEL expressions in default values, or `null` if default values are not expected to contain expressions registry:ReactiveAdapterRegistry for checking reactive type wrappers useDefaultResolution:boolean in default resolution mode a method argument that is a simple type, as defined in `BeanUtils#isSimpleProperty`, is treated as a request parameter even if it isn't annotated, the request parameter name is derived from the method parameter name.

public RequestParamMethodArgumentResolver(ConfigurableBeanFactory factory, ReactiveAdapterRegistry registry, boolean useDefaultResolution)

Class constructor with a default resolution mode flag.

Parameters

factory:ConfigurableBeanFactory: a bean factory used for resolving ${...} placeholder and #{...} SpEL expressions in default values, or null if default values are not expected to contain expressions
registry:ReactiveAdapterRegistry: for checking reactive type wrappers
useDefaultResolution:boolean: in default resolution mode a method argument that is a simple type, as defined in BeanUtils#isSimpleProperty, 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

createNamedValueInfo back to summary

createNamedValueInfo	back to summary
protected AbstractNamedValueArgumentResolver.NamedValueInfo createNamedValueInfo(MethodParameter parameter) Implements abstract org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver.createNamedValueInfo. Doc from org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver.createNamedValueInfo. Create the `NamedValueInfo` object for the given method parameter. Implementations typically retrieve the method annotation by means of `MethodParameter#getParameterAnnotation(Class)`. Parameters parameter:MethodParameter the method parameter Returns:AbstractNamedValueArgumentResolver.NamedValueInfo the named value information Annotations @Override

protected AbstractNamedValueArgumentResolver.NamedValueInfo createNamedValueInfo(MethodParameter parameter)

Implements abstract org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver.createNamedValueInfo.

Doc from org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver.createNamedValueInfo.

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

Parameters

parameter:MethodParameter: the method parameter

Returns:AbstractNamedValueArgumentResolver.NamedValueInfo

the named value information

Annotations

@Override

handleMissingValue back to summary

handleMissingValue	back to summary
protected void handleMissingValue(String name, MethodParameter parameter, ServerWebExchange exchange) Overrides org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver.handleMissingValue. Doc from org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver.handleMissingValue. Invoked when a named value is required, but `resolveName(String, MethodParameter, ServerWebExchange)` returned `null` and there is no default value. Subclasses typically throw an exception in this case. Parameters name:String the name for the value parameter:MethodParameter the method parameter exchange:ServerWebExchange the current exchange Annotations @Override

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

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

Doc from org.springframework.web.reactive.result.method.annotation.AbstractNamedValueArgumentResolver.handleMissingValue.

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

Parameters

name:String: the name for the value
parameter:MethodParameter: the method parameter
exchange:ServerWebExchange: the current exchange

Annotations

@Override

resolveNamedValue	back to summary
protected Object resolveNamedValue(String name, MethodParameter parameter, ServerWebExchange exchange) Implements abstract org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver.resolveNamedValue. Doc from org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver.resolveNamedValue. Actually resolve the value synchronously. Annotations @Override

resolveNamedValue

back to summary

protected Object resolveNamedValue(String name, MethodParameter parameter, ServerWebExchange exchange)

Implements abstract org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver.resolveNamedValue.

Doc from org.springframework.web.reactive.result.method.annotation.AbstractNamedValueSyncArgumentResolver.resolveNamedValue.

Actually resolve the value synchronously.

Annotations

@Override

singleParam	back to summary
private boolean singleParam(RequestParam requestParam, Class<?> type)

supportsParameter	back to summary
public boolean supportsParameter(MethodParameter param) Implements org.springframework.web.reactive.result.method.HandlerMethodArgumentResolver.supportsParameter. Doc from org.springframework.web.reactive.result.method.HandlerMethodArgumentResolver.supportsParameter. Whether this resolver supports the given method parameter. Parameters param:MethodParameter the method parameter Annotations @Override

supportsParameter

back to summary

public boolean supportsParameter(MethodParameter param)

Implements org.springframework.web.reactive.result.method.HandlerMethodArgumentResolver.supportsParameter.

Doc from org.springframework.web.reactive.result.method.HandlerMethodArgumentResolver.supportsParameter.

Whether this resolver supports the given method parameter.

Parameters