org.springframework.messaging.handler.annotation.support

Class AbstractNamedValueMethodArgumentResolver

java.lang.Object

org.springframework.messaging.handler.annotation.support.AbstractNamedValueMethodArgumentResolver

All Implemented Interfaces:

HandlerMethodArgumentResolver

Direct Known Subclasses:

DestinationVariableMethodArgumentResolver, HeaderMethodArgumentResolver

public abstract class AbstractNamedValueMethodArgumentResolver
extends java.lang.Object
implements HandlerMethodArgumentResolver

Abstract base class for resolving method arguments from a named value. Message headers, and path variables are examples of named values. Each may have a name, a required flag, and a default value.

Subclasses define how to do the following:

• Obtain named value information for a method parameter
• Resolve names into argument values
• Handle missing argument values when argument values are required
• Optionally handle a resolved value

A default value string can contain ${...} placeholders and Spring Expression Language #{...} expressions. For this to work a ConfigurableBeanFactory must be supplied to the class constructor.

A ConversionService may be used to apply type conversion to the resolved argument value if it doesn't match the method parameter type.

Since:

4.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractNamedValueMethodArgumentResolver.NamedValueInfo Represents the information about a named value, including name, whether it's required and a default value.

Field Summary

Fields

Modifier and Type	Field and Description
private ConfigurableBeanFactory	configurableBeanFactory
private ConversionService	conversionService
private BeanExpressionContext	expressionContext
private java.util.Map<MethodParameter,AbstractNamedValueMethodArgumentResolver.NamedValueInfo>	namedValueInfoCache

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractNamedValueMethodArgumentResolver(ConversionService cs, ConfigurableBeanFactory beanFactory) Constructor with a ConversionService and a BeanFactory.

Method Summary

Modifier and Type	Method and Description
protected abstract AbstractNamedValueMethodArgumentResolver.NamedValueInfo	createNamedValueInfo(MethodParameter parameter) Create the AbstractNamedValueMethodArgumentResolver.NamedValueInfo object for the given method parameter.
private AbstractNamedValueMethodArgumentResolver.NamedValueInfo	getNamedValueInfo(MethodParameter parameter) Obtain the named value for the given method parameter.
protected abstract void	handleMissingValue(java.lang.String name, MethodParameter parameter, Message<?> message) Invoked when a named value is required, but resolveArgumentInternal(MethodParameter, Message, String) returned null and there is no default value.
private java.lang.Object	handleNullValue(java.lang.String name, java.lang.Object value, java.lang.Class<?> paramType) A null results in a false value for booleans or an exception for other primitives.
protected void	handleResolvedValue(java.lang.Object arg, java.lang.String name, MethodParameter parameter, Message<?> message) Invoked after a value is resolved.
java.lang.Object	resolveArgument(MethodParameter parameter, Message<?> message) Resolves a method parameter into an argument value from a given message.
protected abstract java.lang.Object	resolveArgumentInternal(MethodParameter parameter, Message<?> message, java.lang.String name) Resolves the given parameter type and value name into an argument value.
private java.lang.Object	resolveDefaultValue(java.lang.String defaultValue) Resolves the given default value into an argument value.
private AbstractNamedValueMethodArgumentResolver.NamedValueInfo	updateNamedValueInfo(MethodParameter parameter, AbstractNamedValueMethodArgumentResolver.NamedValueInfo info) Create a new NamedValueInfo based on the given NamedValueInfo with sanitized values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver

supportsParameter

Field Detail

configurableBeanFactory

private final ConfigurableBeanFactory configurableBeanFactory

expressionContext

private final BeanExpressionContext expressionContext

namedValueInfoCache

private java.util.Map<MethodParameter,AbstractNamedValueMethodArgumentResolver.NamedValueInfo> namedValueInfoCache

conversionService

private ConversionService conversionService

Constructor Detail

AbstractNamedValueMethodArgumentResolver

protected AbstractNamedValueMethodArgumentResolver(ConversionService cs,
                                                   ConfigurableBeanFactory beanFactory)

Constructor with a ConversionService and a BeanFactory.

Parameters:

cs - conversion service for converting values to match the target method parameter type

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

Method Detail

resolveArgument

public java.lang.Object resolveArgument(MethodParameter parameter,
                                        Message<?> message)
                                 throws java.lang.Exception

Description copied from interface: HandlerMethodArgumentResolver

Resolves a method parameter into an argument value from a given message.

Specified by:

resolveArgument in interface HandlerMethodArgumentResolver

Parameters:

parameter - the method parameter to resolve. This parameter must have previously been passed to HandlerMethodArgumentResolver.supportsParameter(org.springframework.core.MethodParameter) and it must have returned true

message - the currently processed message

Returns:

the resolved argument value, or null.

Throws:

java.lang.Exception - in case of errors with the preparation of argument values

getNamedValueInfo

private AbstractNamedValueMethodArgumentResolver.NamedValueInfo getNamedValueInfo(MethodParameter parameter)

Obtain the named value for the given method parameter.

createNamedValueInfo

protected abstract AbstractNamedValueMethodArgumentResolver.NamedValueInfo createNamedValueInfo(MethodParameter parameter)

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

Parameters:

parameter - the method parameter

Returns:

the named value information

updateNamedValueInfo

private AbstractNamedValueMethodArgumentResolver.NamedValueInfo updateNamedValueInfo(MethodParameter parameter,
                                                                                     AbstractNamedValueMethodArgumentResolver.NamedValueInfo info)

Create a new NamedValueInfo based on the given NamedValueInfo with sanitized values.

resolveArgumentInternal

protected abstract java.lang.Object resolveArgumentInternal(MethodParameter parameter,
                                                            Message<?> message,
                                                            java.lang.String name)
                                                     throws java.lang.Exception

Resolves the given parameter type and value name into an argument value.

Parameters:

parameter - the method parameter to resolve to an argument value

message - the current request

name - the name of the value being resolved

Returns:

the resolved argument. May be null

Throws:

java.lang.Exception - in case of errors

resolveDefaultValue

private java.lang.Object resolveDefaultValue(java.lang.String defaultValue)

Resolves the given default value into an argument value.

handleMissingValue

protected abstract void handleMissingValue(java.lang.String name,
                                           MethodParameter parameter,
                                           Message<?> message)

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

Parameters:

name - the name for the value

parameter - the method parameter

message - the message being processed

handleNullValue

private java.lang.Object handleNullValue(java.lang.String name,
                                         java.lang.Object value,
                                         java.lang.Class<?> paramType)

A null results in a false value for booleans or an exception for other primitives.

handleResolvedValue

protected void handleResolvedValue(java.lang.Object arg,
                                   java.lang.String name,
                                   MethodParameter parameter,
                                   Message<?> message)

Invoked after a value is resolved.

Parameters:

arg - the resolved argument value

name - the argument name

parameter - the argument parameter type

message - the message