org.springframework.messaging.simp.user

Class UserSessionRegistryAdapter

java.lang.Object

org.springframework.messaging.simp.user.UserSessionRegistryAdapter

All Implemented Interfaces:

SimpUserRegistry

public class UserSessionRegistryAdapter
extends Object
implements SimpUserRegistry

An adapter that allows a UserSessionRegistry, which is deprecated in favor of SimpUserRegistry, to be used as a SimpUserRegistry. Due to the more limited information available, methods such as getUsers() and findSubscriptions(org.springframework.messaging.simp.user.SimpSubscriptionMatcher) are not supported.

As of 4.2, this adapter is used only in applications that explicitly register a custom UserSessionRegistry bean by overriding AbstractMessageBrokerConfiguration.userSessionRegistry().

Since:

4.2

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor and Description
UserSessionRegistryAdapter(UserSessionRegistry registry)

Method Summary

Modifier and Type	Method and Description
Set<SimpSubscription>	findSubscriptions(SimpSubscriptionMatcher matcher) Find subscriptions with the given matcher.
SimpUser	getUser(String userName) Get the user for the given name.
int	getUserCount() Return the count of all connected users.
Set<SimpUser>	getUsers() Return a snapshot of all connected users.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSessionRegistryAdapter

public UserSessionRegistryAdapter(UserSessionRegistry registry)

Method Detail

getUser

public SimpUser getUser(String userName)

Description copied from interface: SimpUserRegistry

Get the user for the given name.

Specified by:

getUser in interface SimpUserRegistry

Parameters:

userName - the name of the user to look up

Returns:

the user, or null if not connected

getUsers

public Set<SimpUser> getUsers()

Description copied from interface: SimpUserRegistry

Return a snapshot of all connected users.

The returned set is a copy and will not reflect further changes.

Specified by:

getUsers in interface SimpUserRegistry

Returns:

the connected users, or an empty set if none

getUserCount

public int getUserCount()

Description copied from interface: SimpUserRegistry

Return the count of all connected users.

Specified by:

getUserCount in interface SimpUserRegistry

Returns:

the number of connected users

findSubscriptions

public Set<SimpSubscription> findSubscriptions(SimpSubscriptionMatcher matcher)

Description copied from interface: SimpUserRegistry

Find subscriptions with the given matcher.

Specified by:

findSubscriptions in interface SimpUserRegistry

Parameters:

matcher - the matcher to use

Returns:

a set of matching subscriptions, or an empty set if none