org.springframework.messaging.simp.user

Class DefaultUserDestinationResolver

java.lang.Object

org.springframework.messaging.simp.user.DefaultUserDestinationResolver

All Implemented Interfaces:

UserDestinationResolver

public class DefaultUserDestinationResolver
extends Object
implements UserDestinationResolver

A default implementation of UserDestinationResolver.

Uses the UserSessionRegistry provided to the constructor to find the sessionIds associated with a user.

Since:

4.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
DefaultUserDestinationResolver(UserSessionRegistry userSessionRegistry) Create an instance that will access user session id information through the provided registry.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkDestination(String destination, String requiredPrefix)
String	getDestinationPrefix() Return the prefix used to identify user destinations.
protected String	getTargetDestination(String origDestination, String targetDestination, String sessionId, String user)
UserSessionRegistry	getUserSessionRegistry() Return the configured UserSessionRegistry.
Set<String>	resolveDestination(Message<?> message) Resolve the destination of the message to a set of actual target destinations to use.
void	setUserDestinationPrefix(String prefix) The prefix used to identify user destinations.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultUserDestinationResolver

public DefaultUserDestinationResolver(UserSessionRegistry userSessionRegistry)

Create an instance that will access user session id information through the provided registry.

Parameters:

userSessionRegistry - the registry, never null

Method Detail

setUserDestinationPrefix

public void setUserDestinationPrefix(String prefix)

The prefix used to identify user destinations. Any destinations that do not start with the given prefix are not be resolved.

The default value is "/user/".

Parameters:

prefix - the prefix to use

getDestinationPrefix

public String getDestinationPrefix()

Return the prefix used to identify user destinations. Any destinations that do not start with the given prefix are not be resolved.

By default "/user/queue/".

getUserSessionRegistry

public UserSessionRegistry getUserSessionRegistry()

Return the configured UserSessionRegistry.

resolveDestination

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

Description copied from interface: UserDestinationResolver

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.

Specified by:

resolveDestination in interface UserDestinationResolver

Parameters:

message - the message to resolve

Returns:

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

checkDestination

protected boolean checkDestination(String destination,
                                   String requiredPrefix)

getTargetDestination

protected String getTargetDestination(String origDestination,
                                      String targetDestination,
                                      String sessionId,
                                      String user)