Package org.springframework.web.socket.messaging

Class DefaultSimpUserRegistry

java.lang.Object

org.springframework.web.socket.messaging.DefaultSimpUserRegistry

All Implemented Interfaces:

EventListener, ApplicationListener<ApplicationEvent>, SmartApplicationListener, Ordered, SimpUserRegistry

public class DefaultSimpUserRegistry
extends Object
implements SimpUserRegistry, SmartApplicationListener

A default implementation of SimpUserRegistry that relies on AbstractSubProtocolEvent application context events to keep track of connected users and their subscriptions.

Since:

4.2

Author:

Rossen Stoyanchev, Sam Brannen

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
DefaultSimpUserRegistry()

Method Summary

Modifier and Type	Method	Description
Set<SimpSubscription>	findSubscriptions(SimpSubscriptionMatcher matcher)	Find subscriptions with the given matcher.
int	getOrder()	Determine this listener's order in a set of listeners for the same event.
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.
void	onApplicationEvent(ApplicationEvent event)	Handle an application event.
void	setOrder(int order)	Specify the order value for this registry.
boolean	supportsEventType(Class<? extends ApplicationEvent> eventType)	Determine whether this listener actually supports the given event type.
boolean	supportsSourceType(Class<?> sourceType)	Determine whether this listener actually supports the given source type.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.event.SmartApplicationListener

getListenerId

Constructor Details

DefaultSimpUserRegistry

public DefaultSimpUserRegistry()

Method Details

setOrder

public void setOrder(int order)

Specify the order value for this registry.

Default is Ordered.LOWEST_PRECEDENCE.

Since:

5.0.8

getOrder

public int getOrder()

Description copied from interface: SmartApplicationListener

Determine this listener's order in a set of listeners for the same event.

The default implementation returns Ordered.LOWEST_PRECEDENCE.

Specified by:

getOrder in interface Ordered

Specified by:

getOrder in interface SmartApplicationListener

Returns:

the order value

See Also:

• Ordered.HIGHEST_PRECEDENCE
• Ordered.LOWEST_PRECEDENCE

supportsEventType

public boolean supportsEventType(Class<? extends ApplicationEvent> eventType)

Description copied from interface: SmartApplicationListener

Determine whether this listener actually supports the given event type.

Specified by:

supportsEventType in interface SmartApplicationListener

Parameters:

eventType - the event type (never null)

onApplicationEvent

public void onApplicationEvent(ApplicationEvent event)

Description copied from interface: ApplicationListener

Handle an application event.

Specified by:

onApplicationEvent in interface ApplicationListener<ApplicationEvent>

Parameters:

event - the event to respond to

supportsSourceType

public boolean supportsSourceType(@Nullable
 Class<?> sourceType)

Description copied from interface: SmartApplicationListener

Determine whether this listener actually supports the given source type.

The default implementation always returns true.

Specified by:

supportsSourceType in interface SmartApplicationListener

Parameters:

sourceType - the source type, or null if no source

getUser

@Nullable
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

toString

public String toString()

Overrides:

toString in class Object