spring-framework / org.springframework.messaging.simp.user / UserDestinationResult

UserDestinationResult

open class UserDestinationResult

Contains the result from parsing a "user" destination from a source message and translating it to target destinations (one per active user session).

Author
Rossen Stoyanchev

Since
4.0.2

See Also
org.springframework.messaging.simp.user.UserDestinationResolver

Constructors

<init>

UserDestinationResult(sourceDestination: String, targetDestinations: MutableSet<String>, subscribeDestination: String, user: String)

Functions

getSourceDestination

open fun getSourceDestination(): String

The "user" destination from the source message. This may look like "/user/queue/position-updates" when subscribing or "/user/{username}/queue/position-updates" when sending a message.

getSubscribeDestination

open fun getSubscribeDestination(): String

The user destination in the form expected when a client subscribes, e.g. "/user/queue/position-updates".

getTargetDestinations

open fun getTargetDestinations(): MutableSet<String>

The target destinations that the source destination was translated to, one per active user session, e.g. "/queue/position-updates-useri9oqdfzo".

getUser

open fun getUser(): String

The user for this user destination.

toString

open fun toString(): String