org.springframework.messaging.simp.user

Class UserDestinationResult

java.lang.Object

org.springframework.messaging.simp.user.UserDestinationResult

public class UserDestinationResult
extends java.lang.Object

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

Since:

4.0.2

Author:

Rossen Stoyanchev

See Also:

UserDestinationResolver

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 from the source message.
java.lang.String	getSubscribeDestination() The user destination in the form expected when a client subscribes, e.g.
java.util.Set<java.lang.String>	getTargetDestinations() The target destinations that the source destination was translated to, one per active user session, e.g.
java.lang.String	getUser() The user for this 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,
                             @Nullable
                             java.lang.String user)

Method Detail

getSourceDestination

public java.lang.String getSourceDestination()

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.

Returns:

the "user" destination, never null.

getTargetDestinations

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

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

Returns:

the target destinations, never null but possibly an empty set if there are no active sessions for the user.

getSubscribeDestination

public java.lang.String getSubscribeDestination()

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

Returns:

the subscribe form of the "user" destination, never null.

getUser

@Nullable
public java.lang.String getUser()

The user for this user destination.

Returns:

the user name or null if we have a session id only such as when the user is not authenticated; in such cases it is possible to use sessionId in place of a user name thus removing the need for a user-to-session lookup via SimpUserRegistry.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object