Annotation Type SendToUser
@Target({METHOD,TYPE}) @Retention(RUNTIME) @Documented public @interface SendToUser
Annotation that indicates that the return value of a message-handling method should be sent as aMessage
to the specified destination(s) prepended with"/user/{username}"
where the user name is extracted from the headers of the input message being handled.The annotation may also be placed at class-level in which case all methods in the class where the annotation applies will inherit it.
- Since:
- 4.0
- Author:
- Rossen Stoyanchev, Sam Brannen
- See Also:
SendToMethodReturnValueHandler
,UserDestinationMessageHandler
,SimpMessageHeaderAccessor.getUser()
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description boolean
broadcast
Whether messages should be sent to all sessions associated with the user or only to the session of the input message being handled.String[]
destinations
One or more destinations to send a message to.String[]
value
Alias fordestinations()
.
Element Detail
value
@AliasFor("destinations") String[] value
Alias fordestinations()
.- See Also:
destinations()
- Default:
- {}
destinations
@AliasFor("value") String[] destinations
One or more destinations to send a message to.If left unspecified, a default destination is selected based on the destination of the input message being handled.
- Since:
- 4.2
- See Also:
value()
,SendToMethodReturnValueHandler
- Default:
- {}
broadcast
boolean broadcast
Whether messages should be sent to all sessions associated with the user or only to the session of the input message being handled.By default, this is set to
true
in which case messages are broadcast to all sessions.- Default:
- true