org.springframework.messaging.simp.user

Interface SimpUser

All Known Implementing Classes:

DefaultSimpUserRegistry.DefaultSimpUser, MultiServerUserRegistry.SimpUserDto, UserSessionRegistryAdapter.SimpleSimpUser

public interface SimpUser

Represents a connected user.

Since:

4.2

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() The unique user name.
SimpSession	getSession(java.lang.String sessionId) Look up the session for the given id.
java.util.Set<SimpSession>	getSessions() Return the sessions for the user.
boolean	hasSessions() Whether the user has any sessions.

Method Detail

getName

java.lang.String getName()

The unique user name.

hasSessions

boolean hasSessions()

Whether the user has any sessions.

getSession

SimpSession getSession(java.lang.String sessionId)

Look up the session for the given id.

Parameters:

sessionId - the session id

Returns:

the matching session of null.

getSessions

java.util.Set<SimpSession> getSessions()

Return the sessions for the user. The returned set is a copy and will never be modified.

Returns:

a set of session ids, or an empty set.