org.springframework.messaging.simp.user

Interface UserSessionRegistry

All Known Implementing Classes:

DefaultUserSessionRegistry

public interface UserSessionRegistry

A registry for looking up active session id's by user.

Used in support of resolving unique session-specific user destinations. See DefaultUserDestinationResolver for more details.

Since:

4.0

Author:

Rossen Stoyanchev

See Also:

DefaultUserDestinationResolver

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getSessionIds(java.lang.String user) Return the active session id's for the given user.
void	registerSessionId(java.lang.String user, java.lang.String sessionId) Register an active session id for the given user.
void	unregisterSessionId(java.lang.String user, java.lang.String sessionId) Unregister the session id for a user.

Method Detail

getSessionIds

java.util.Set<java.lang.String> getSessionIds(java.lang.String user)

Return the active session id's for the given user.

Parameters:

user - the user

Returns:

a set with 0 or more session id's

registerSessionId

void registerSessionId(java.lang.String user,
                       java.lang.String sessionId)

Register an active session id for the given user.

Parameters:

user - the user

sessionId - the session id

unregisterSessionId

void unregisterSessionId(java.lang.String user,
                         java.lang.String sessionId)

Unregister the session id for a user.

Parameters:

user - the user

sessionId - the session id