org.springframework.messaging.simp.user

Interface UserDestinationResolver

All Known Implementing Classes:

DefaultUserDestinationResolver

public interface UserDestinationResolver

A strategy for resolving unique, user destinations per session. User destinations provide a user with the ability to subscribe to a queue unique to their session as well others with the ability to send messages to those queues.

When a user attempts to subscribe to "/user/queue/position-updates", the "/user" prefix is removed and a unique suffix added, resulting in something like "/queue/position-updates-useri9oqdfzo" where the suffix is based on the user's session and ensures it does not collide with any other users attempting to subscribe to "/user/queue/position-updates".

When a message is sent to a user with a destination such as "/user/{username}/queue/position-updates", the "/user/{username}" prefix is removed and the suffix added, resulting in something like "/queue/position-updates-useri9oqdfzo".

Since:

4.0

Author:

Rossen Stoyanchev

See Also:

UserDestinationMessageHandler

Method Summary

Modifier and Type	Method and Description
Set<String>	resolveDestination(Message<?> message) Resolve the destination of the message to a set of actual target destinations to use.

Method Detail

resolveDestination

Set<String> resolveDestination(Message<?> message)

Resolve the destination of the message to a set of actual target destinations to use. If the message is SUBSCRIBE/UNSUBSCRIBE, the returned set will contain only target destination. If the message represents data being sent to a user, the returned set may contain multiple target destinations, one for each active session of the target user.

Parameters:

message - the message to resolve

Returns:

the resolved unique user destination(s) or an empty Set