spring-framework / org.springframework.messaging.handler.annotation / Payload

Payload

@Target([AnnotationTarget.VALUE_PARAMETER, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.PROPERTY_SETTER]) class Payload

Annotation that binds a method parameter to the payload of a message. Can also be used to associate a payload to a method invocation. The payload may be passed through a MessageConverter to convert it from serialized form with a specific MIME type to an Object matching the target method parameter.

Author
Rossen Stoyanchev

Author
Sam Brannen

Since
4.0

Constructors

<init>

 Payload(value: String, expression: String, required: Boolean)

Annotation that binds a method parameter to the payload of a message. Can also be used to associate a payload to a method invocation. The payload may be passed through a MessageConverter to convert it from serialized form with a specific MIME type to an Object matching the target method parameter.

Properties

expression

 val expression: String

A SpEL expression to be evaluated against the payload object as the root context.

This attribute may or may not be supported depending on whether the message being handled contains a non-primitive Object as its payload or is in serialized form and requires message conversion.

When processing STOMP over WebSocket messages this attribute is not supported.

required

 val required: Boolean

Whether payload content is required.

Default is true, leading to an exception if there is no payload. Switch to false to have null passed when there is no payload.

value

 val value: String

Alias for #expression.