org.springframework.messaging.simp.user

Class UserDestinationResult

java.lang.Object

org.springframework.messaging.simp.user.UserDestinationResult

public class UserDestinationResult
extends java.lang.Object

A simple container for the result of parsing and translating a "user" destination in some source message into a set of actual target destinations by calling UserDestinationResolver.

Since:

4.0.2

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
UserDestinationResult(java.lang.String sourceDestination, java.util.Set<java.lang.String> targetDestinations, java.lang.String subscribeDestination, java.lang.String user)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSourceDestination() The "user" destination as found in the headers of the source message.
java.lang.String	getSubscribeDestination() The canonical form of the user destination as would be required to subscribe.
java.util.Set<java.lang.String>	getTargetDestinations() The result of parsing the source destination and translating it into a set of actual target destinations to use.
java.lang.String	getUser() The user associated with the user destination.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UserDestinationResult

public UserDestinationResult(java.lang.String sourceDestination,
                             java.util.Set<java.lang.String> targetDestinations,
                             java.lang.String subscribeDestination,
                             java.lang.String user)

Method Detail

getSourceDestination

public java.lang.String getSourceDestination()

The "user" destination as found in the headers of the source message.

Returns:

a destination, never null

getTargetDestinations

public java.util.Set<java.lang.String> getTargetDestinations()

The result of parsing the source destination and translating it into a set of actual target destinations to use.

Returns:

a set of destination values, possibly an empty set

getSubscribeDestination

public java.lang.String getSubscribeDestination()

The canonical form of the user destination as would be required to subscribe. This may be useful to ensure that messages received by clients contain the original destination they used to subscribe.

Returns:

a destination, never null

getUser

public java.lang.String getUser()

The user associated with the user destination.

Returns:

the user name, never null

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object