org.springframework.messaging.simp.annotation

Annotation Type SubscribeMapping

@Target(value=METHOD)
 @Retention(value=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 with SendTo or SendToUser, 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.

Since:

4.0

Author:

Rossen Stoyanchev

See Also:

MessageMapping, SendTo, SendToUser

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	value Destination-based mapping expressed by this annotation.

Element Detail

value

public abstract java.lang.String[] value

Destination-based mapping expressed by this annotation.

This is the destination of the STOMP message (e.g. "/positions"). Ant-style path patterns (e.g. "/price.stock.*") and path template variables (e.g. "/price.stock.{ticker}") are also supported.

Default:

{}