Spring Framework 6.1.4 · org.springframework.messaging.handler.annotation.support.PayloadMethodArgumentResolver

A resolver to extract and convert the payload of a message using a MessageConverter.

Validation is applied if the method argument is annotated with org.springframework.validation.annotation.Validated or @jakarta.validation.Valid. Validation failure results in an MethodArgumentNotValidException.

This HandlerMethodArgumentResolver should be ordered last as it supports all types and does not require the Payload annotation.

Field Summary

Modifier and Type	Field and Description
private final MessageConverter	converter
private final boolean	useDefaultResolution
private final Validator	validator

Constructor Summary

Access	Constructor and Description
public	PayloadMethodArgumentResolver(MessageConverter the MessageConverter to use (required) messageConverter) Create a new `PayloadArgumentResolver` with the given `MessageConverter`.
public	PayloadMethodArgumentResolver(MessageConverter the MessageConverter to use (required) messageConverter, Validator the Validator to use (optional) validator) Create a new `PayloadArgumentResolver` with the given `MessageConverter` and `Validator`.
public	PayloadMethodArgumentResolver(MessageConverter the MessageConverter to use (required) messageConverter, Validator the Validator to use (optional) validator, boolean if "true" (the default) this resolver supports all parameters; if "false" then only arguments with the `@Payload` annotation are supported. useDefaultResolution) Create a new `PayloadArgumentResolver` with the given `MessageConverter` and `Validator`.

Method Summary

Modifier and Type	Method and Description
private String	getParameterName(MethodParameter param)
protected boolean	isEmptyPayload(Object the payload to check (can be `null`) payload) Specify if the given `payload` is empty.
public Object	resolveArgument(MethodParameter the method parameter to resolve. This parameter must have previously been passed to `supportsParameter(org.springframework.core.MethodParameter)` which must have returned `true`. parameter, Message<?> the currently processed message message) Implements org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver.resolveArgument. Resolves a method parameter into an argument value from a given message.
protected Class<?>	Returns: the target type to use resolveTargetClass(MethodParameter the target method parameter parameter, Message<?> the message being processed message) Resolve the target class to convert the payload to.
public boolean	supportsParameter(MethodParameter the method parameter to check parameter) Implements org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver.supportsParameter. Whether the given method parameter is supported by this resolver.
protected void	validate(Message<?> the currently processed message message, MethodParameter the method parameter parameter, Object the target payload object target) Validate the payload if applicable.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

converter	back to summary
private final MessageConverter converter

useDefaultResolution	back to summary
private final boolean useDefaultResolution

validator	back to summary
private final Validator validator Annotations @Nullable

Constructor Detail

PayloadMethodArgumentResolver back to summary

PayloadMethodArgumentResolver	back to summary
public PayloadMethodArgumentResolver(MessageConverter messageConverter) Create a new `PayloadArgumentResolver` with the given `MessageConverter`. Parameters messageConverter:MessageConverter the MessageConverter to use (required)

public PayloadMethodArgumentResolver(MessageConverter messageConverter)

Create a new PayloadArgumentResolver with the given MessageConverter.

Parameters

messageConverter:MessageConverter: the MessageConverter to use (required)

PayloadMethodArgumentResolver back to summary

PayloadMethodArgumentResolver	back to summary
public PayloadMethodArgumentResolver(MessageConverter messageConverter, Validator validator) Create a new `PayloadArgumentResolver` with the given `MessageConverter` and `Validator`. Parameters messageConverter:MessageConverter the MessageConverter to use (required) validator:Validator the Validator to use (optional)

public PayloadMethodArgumentResolver(MessageConverter messageConverter, Validator validator)

Create a new PayloadArgumentResolver with the given MessageConverter and Validator.

Parameters

messageConverter:MessageConverter: the MessageConverter to use (required)
validator:Validator: the Validator to use (optional)

PayloadMethodArgumentResolver back to summary

PayloadMethodArgumentResolver	back to summary
public PayloadMethodArgumentResolver(MessageConverter messageConverter, Validator validator, boolean useDefaultResolution) Create a new `PayloadArgumentResolver` with the given `MessageConverter` and `Validator`. Parameters messageConverter:MessageConverter the MessageConverter to use (required) validator:Validator the Validator to use (optional) useDefaultResolution:boolean if "true" (the default) this resolver supports all parameters; if "false" then only arguments with the `@Payload` annotation are supported.

public PayloadMethodArgumentResolver(MessageConverter messageConverter, Validator validator, boolean useDefaultResolution)

Create a new PayloadArgumentResolver with the given MessageConverter and Validator.

Parameters

messageConverter:MessageConverter: the MessageConverter to use (required)
validator:Validator: the Validator to use (optional)
useDefaultResolution:boolean: if "true" (the default) this resolver supports all parameters; if "false" then only arguments with the @Payload annotation are supported.

Method Detail

getParameterName	back to summary
private String getParameterName(MethodParameter param)

isEmptyPayload back to summary

isEmptyPayload	back to summary
protected boolean isEmptyPayload(Object payload) Specify if the given `payload` is empty. Parameters payload:Object the payload to check (can be `null`)

protected boolean isEmptyPayload(Object payload)

Specify if the given payload is empty.

Parameters

payload:Object: the payload to check (can be null)

resolveArgument back to summary

resolveArgument	back to summary
public Object resolveArgument(MethodParameter parameter, Message<?> message) throws Exception Implements org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver.resolveArgument. Doc from org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver.resolveArgument. Resolves a method parameter into an argument value from a given message. Parameters parameter:MethodParameter the method parameter to resolve. This parameter must have previously been passed to `supportsParameter(org.springframework.core.MethodParameter)` which must have returned `true`. message:Message<?> the currently processed message Returns:Object the resolved argument value, or `null` Annotations @Override @Nullable Exceptions Exception: in case of errors with the preparation of argument values

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

Implements org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver.resolveArgument.

Doc from org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver.resolveArgument.

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

Parameters

parameter:MethodParameter: the method parameter to resolve. This parameter must have previously been passed to supportsParameter(org.springframework.core.MethodParameter) which must have returned true.
message:Message<?>: the currently processed message

Returns:Object

the resolved argument value, or null

Annotations

@Override
@Nullable

Exceptions

Exception:: in case of errors with the preparation of argument values

resolveTargetClass back to summary

resolveTargetClass	back to summary
protected Class<?> resolveTargetClass(MethodParameter parameter, Message<?> message) Resolve the target class to convert the payload to. By default this is simply `MethodParameter#getParameterType()` but that can be overridden to select a more specific target type after also taking into account the "Content-Type", e.g. return `String` if target type is `Object` and `"Content-Type:text/**"`. Parameters parameter:MethodParameter the target method parameter message:Message<?> the message being processed Returns:Class<?> the target type to use Since 5.2

protected Class<?> resolveTargetClass(MethodParameter parameter, Message<?> message)

Resolve the target class to convert the payload to.

By default this is simply MethodParameter#getParameterType() but that can be overridden to select a more specific target type after also taking into account the "Content-Type", e.g. return String if target type is Object and "Content-Type:text/**".

Parameters

parameter:MethodParameter: the target method parameter
message:Message<?>: the message being processed

Returns:Class<?>

the target type to use

Since

5.2

supportsParameter back to summary

supportsParameter	back to summary
public boolean supportsParameter(MethodParameter parameter) Implements org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver.supportsParameter. Doc from org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver.supportsParameter. Whether the given method parameter is supported by this resolver. Parameters parameter:MethodParameter the method parameter to check Returns:boolean `true` if this resolver supports the supplied parameter; `false` otherwise Annotations @Override

public boolean supportsParameter(MethodParameter parameter)

Implements org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver.supportsParameter.

Doc from org.springframework.messaging.handler.invocation.HandlerMethodArgumentResolver.supportsParameter.

Whether the given method parameter is supported by this resolver.

Parameters

parameter:MethodParameter: the method parameter to check

Returns:boolean

true if this resolver supports the supplied parameter; false otherwise

Annotations

@Override

validate	back to summary
protected void validate(Message<?> message, MethodParameter parameter, Object target) Validate the payload if applicable. Parameters message:Message<?> the currently processed message parameter:MethodParameter the method parameter target:Object the target payload object Exceptions MethodArgumentNotValidException: in case of binding errors

validate

back to summary

protected void validate(Message<?> message, MethodParameter parameter, Object target)

Validate the payload if applicable.

Parameters

message:Message<?>: the currently processed message
parameter:MethodParameter: the method parameter
target:Object: the target payload object

Exceptions

MethodArgumentNotValidException:: in case of binding errors

public Class PayloadMethodArgumentResolver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail