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

Class ModelAttributeMethodArgumentResolver

java.lang.Object

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

All Implemented Interfaces:

HandlerMethodArgumentResolver

public class ModelAttributeMethodArgumentResolver
extends java.lang.Object
implements HandlerMethodArgumentResolver

Resolve @ModelAttribute annotated method arguments.

Model attributes are sourced from the model, or created using a default constructor and then added to the model. Once created the attribute is populated via data binding to the request (form data, query params). Validation also may be applied if the argument is annotated with @javax.validation.Valid or Spring's own @org.springframework.validation.annotation.Validated.

When this handler is created with useDefaultResolution=true any non-simple type argument and return value is regarded as a model attribute with or without the presence of an @ModelAttribute.

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private ReactiveAdapterRegistry	adapterRegistry
private boolean	useDefaultResolution

Constructor Summary

Constructors

Constructor and Description
ModelAttributeMethodArgumentResolver(ReactiveAdapterRegistry registry) Class constructor.
ModelAttributeMethodArgumentResolver(ReactiveAdapterRegistry registry, boolean useDefaultResolution) Class constructor with a default resolution mode flag.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkErrorsArgument(MethodParameter methodParam)
protected java.lang.Object	createAttribute(java.lang.String attributeName, java.lang.Class<?> attributeType, MethodParameter parameter, BindingContext context, ServerWebExchange exchange)
ReactiveAdapterRegistry	getAdapterRegistry() Return the configured ReactiveAdapterRegistry.
private <any>	getAttributeMono(java.lang.String attributeName, java.lang.Class<?> attributeType, MethodParameter param, BindingContext context, ServerWebExchange exchange)
private java.lang.String	getAttributeName(java.lang.Class<?> valueType, MethodParameter parameter)
<any>	resolveArgument(MethodParameter parameter, BindingContext context, ServerWebExchange exchange) The returned Mono may produce one or zero values if the argument does not resolve to any value, which will result in null passed as the argument value.
boolean	supportsParameter(MethodParameter parameter)
protected void	validateIfApplicable(WebExchangeDataBinder binder, MethodParameter parameter)

Methods inherited from class java.lang.Object

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

Field Detail

adapterRegistry

private final ReactiveAdapterRegistry adapterRegistry

useDefaultResolution

private final boolean useDefaultResolution

Constructor Detail

ModelAttributeMethodArgumentResolver

public ModelAttributeMethodArgumentResolver(ReactiveAdapterRegistry registry)

Class constructor.

Parameters:

registry - for adapting to other reactive types from and to Mono

ModelAttributeMethodArgumentResolver

public ModelAttributeMethodArgumentResolver(ReactiveAdapterRegistry registry,
                                            boolean useDefaultResolution)

Class constructor with a default resolution mode flag.

Parameters:

registry - for adapting to other reactive types from and to Mono

useDefaultResolution - if "true", non-simple method arguments and return values are considered model attributes with or without a @ModelAttribute annotation present.

Method Detail

getAdapterRegistry

public ReactiveAdapterRegistry getAdapterRegistry()

Return the configured ReactiveAdapterRegistry.

supportsParameter

public boolean supportsParameter(MethodParameter parameter)

Specified by:

supportsParameter in interface HandlerMethodArgumentResolver

resolveArgument

public <any> resolveArgument(MethodParameter parameter,
                             BindingContext context,
                             ServerWebExchange exchange)

Description copied from interface: HandlerMethodArgumentResolver

The returned Mono may produce one or zero values if the argument does not resolve to any value, which will result in null passed as the argument value.

Specified by:

resolveArgument in interface HandlerMethodArgumentResolver

Parameters:

parameter - the method parameter

context - the binding context to use

exchange - the current exchange

getAttributeName

private java.lang.String getAttributeName(java.lang.Class<?> valueType,
                                          MethodParameter parameter)

getAttributeMono

private <any> getAttributeMono(java.lang.String attributeName,
                               java.lang.Class<?> attributeType,
                               MethodParameter param,
                               BindingContext context,
                               ServerWebExchange exchange)

createAttribute

protected java.lang.Object createAttribute(java.lang.String attributeName,
                                           java.lang.Class<?> attributeType,
                                           MethodParameter parameter,
                                           BindingContext context,
                                           ServerWebExchange exchange)

checkErrorsArgument

protected boolean checkErrorsArgument(MethodParameter methodParam)

validateIfApplicable

protected void validateIfApplicable(WebExchangeDataBinder binder,
                                    MethodParameter parameter)