org.springframework.messaging.simp.user

Interface UserDestinationResolver

All Known Implementing Classes:

DefaultUserDestinationResolver

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

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.

For example when a user attempts to subscribe to "/user/queue/position-updates", the destination may be resolved to "/queue/position-updates-useri9oqdfzo" yielding a unique queue name that does not collide with any other user attempting to do the same. Subsequently when messages are sent to "/user/{username}/queue/position-updates", the destination is translated to "/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 one or more user/session-specific target destinations.

Method Detail

resolveDestination

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

Resolve the destination of the message to one or more user/session-specific target destinations. If the user has multiple sessions, the method may return more than one target destinations.

Parameters:

message - the message to resolve

Returns:

the resolved unique user destinations or an empty Set if the message destination is not recognized as a user destination