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.

Resolves messages sent to destination patterns "/user/{user-name}/**" as well as subscriptions to destinations "/user/queue/**" where the "/user/" prefix used to recognize such destinations is customizable via setUserDestinationPrefix(String).

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.
String	getSubscriptionDestinationPrefix() Return the prefix used to identify user destinations for (un)subscribe messages.
protected String	getTargetDestination(String originalDestination, String targetDestination, String sessionId, String user)
UserSessionRegistry	getUserSessionRegistry() Return the configured UserSessionRegistry.
Set<String>	resolveDestination(Message<?> message) Resolve the destination of the message to one or more user/session-specific target destinations.
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/".

getSubscriptionDestinationPrefix

public String getSubscriptionDestinationPrefix()

Return the prefix used to identify user destinations for (un)subscribe messages.

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 one or more user/session-specific target destinations. If the user has multiple sessions, the method may return more than one target destinations.

Specified by:

resolveDestination in interface UserDestinationResolver

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

getTargetDestination

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

checkDestination

protected boolean checkDestination(String destination,
                                   String requiredPrefix)