Annotation Type SubscribeMapping
@Target(METHOD) @Retention(RUNTIME) @Documented public @interface SubscribeMapping
Annotation for mapping subscription messages onto specific handler methods based on the destination of a subscription. Supported with STOMP over WebSocket only (e.g. STOMP SUBSCRIBE frame).This is a method-level annotation that can be combined with a type-level
@MessageMapping
.Supports the same method arguments as
@MessageMapping
; however, subscription messages typically do not have a body.The return value also follows the same rules as for
@MessageMapping
, except if the method is not annotated withSendTo
orSendToUser
, the message is sent directly back to the connected user and does not pass through the message broker. This is useful for implementing a request-reply pattern.NOTE: When using controller interfaces (e.g. for AOP proxying), make sure to consistently put all your mapping annotations - such as
@MessageMapping
and@SubscribeMapping
- on the controller interface rather than on the implementation class.- Since:
- 4.0
- Author:
- Rossen Stoyanchev
- See Also:
MessageMapping
,SendTo
,SendToUser