com.haulmont.cuba.security.app

Interface UserSessionService

All Known Implementing Classes:

UserSessionServiceBean

public interface UserSessionService

Service interface to active UserSessions management.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserSessionService.Filter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessages() Poll for messages left for the current user session.
java.lang.Integer	getPermissionValue(User user, PermissionType permissionType, java.lang.String target) Get effective user permission.
UserSession	getUserSession(java.util.UUID sessionId) Get a UserSession by its identifier.
java.util.Collection<UserSessionEntity>	getUserSessionInfo() Deprecated. Use loadUserSessionEntities(Filter) method passing a filter
void	killSession(java.util.UUID id) Disconnect a session.
java.util.Collection<UserSessionEntity>	loadUserSessionEntities(UserSessionService.Filter filter) Load list of non-persistent entities representing active user sessions.
void	postMessage(java.util.List<java.util.UUID> sessionIds, java.lang.String message) Post a message to the list of active user sessions.
void	removeSessionAttribute(java.util.UUID sessionId, java.lang.String name) Remove a session attribute, propagating changes to the cluster.
void	setSessionAddress(java.util.UUID sessionId, java.lang.String address) Set client's address into the session, propagating changes to the cluster.
void	setSessionAttribute(java.util.UUID sessionId, java.lang.String name, java.io.Serializable value) Set a session attribute value, propagating changes to the cluster.
void	setSessionClientInfo(java.util.UUID sessionId, java.lang.String clientInfo) Set client's information into the session, propagating changes to the cluster.
void	setSessionLocale(java.util.UUID sessionId, java.util.Locale locale) Set user locale into the session, propagating changes to the cluster.
void	setSessionTimeZone(java.util.UUID sessionId, java.util.TimeZone timeZone) Set user time zone into the session, propagating changes to the cluster.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getUserSession

UserSession getUserSession(java.util.UUID sessionId)

Get a UserSession by its identifier.

When called from the client tier, returns a copy of the session object, so any modifications of its state affect nothing.

Parameters:

sessionId - a session identifier

Returns:

an active user session instance copy, if exists

Throws:

NoUserSessionException - in case of a session with the specified ID doesn't exist

java.lang.RuntimeException - if the session is system

setSessionAttribute

void setSessionAttribute(java.util.UUID sessionId,
                         java.lang.String name,
                         java.io.Serializable value)

Set a session attribute value, propagating changes to the cluster.

Parameters:

sessionId - an active session identifier

name - attribute name

value - attribute value

Throws:

NoUserSessionException - in case of a session with the specified ID doesn't exist

java.lang.RuntimeException - if the session is system

removeSessionAttribute

void removeSessionAttribute(java.util.UUID sessionId,
                            java.lang.String name)

Remove a session attribute, propagating changes to the cluster.

Parameters:

sessionId - an active session identifier

name - attribute name

Throws:

NoUserSessionException - in case of a session with the specified ID doesn't exist

java.lang.RuntimeException - if the session is system

setSessionLocale

void setSessionLocale(java.util.UUID sessionId,
                      java.util.Locale locale)

Set user locale into the session, propagating changes to the cluster.

Parameters:

sessionId - an active session identifier

locale - user locale

Throws:

NoUserSessionException - in case of a session with the specified ID doesn't exist

java.lang.RuntimeException - if the session is system

setSessionTimeZone

void setSessionTimeZone(java.util.UUID sessionId,
                        java.util.TimeZone timeZone)

Set user time zone into the session, propagating changes to the cluster.

Parameters:

sessionId - an active session identifier

timeZone - user time zone

Throws:

NoUserSessionException - in case of a session with the specified ID doesn't exist

java.lang.RuntimeException - if the session is system

setSessionAddress

void setSessionAddress(java.util.UUID sessionId,
                       java.lang.String address)

Set client's address into the session, propagating changes to the cluster.

Parameters:

sessionId - an active session identifier

address - client's address

Throws:

NoUserSessionException - in case of a session with the specified ID doesn't exist

java.lang.RuntimeException - if the session is system

setSessionClientInfo

void setSessionClientInfo(java.util.UUID sessionId,
                          java.lang.String clientInfo)

Set client's information into the session, propagating changes to the cluster.

Parameters:

sessionId - an active session identifier

clientInfo - client's info

Throws:

NoUserSessionException - in case of a session with the specified ID doesn't exist

java.lang.RuntimeException - if the session is system

getUserSessionInfo

@Deprecated
java.util.Collection<UserSessionEntity> getUserSessionInfo()

Deprecated. Use loadUserSessionEntities(Filter) method passing a filter

killSession

void killSession(java.util.UUID id)

Disconnect a session. Returns silently if there is no active session with the specified ID or the session is system.

Parameters:

id - an active session identifier

postMessage

void postMessage(java.util.List<java.util.UUID> sessionIds,
                 java.lang.String message)

Post a message to the list of active user sessions. If a session is not found or is system, it is ignored.

Parameters:

sessionIds - list of session identifiers

message - the message text

getMessages

@Nullable
java.lang.String getMessages()

Poll for messages left for the current user session. Can also be used for session ping to prevent expiring on user idle time.

Returns:

all messages sent to the current session in one string separated by carriage returns

getPermissionValue

java.lang.Integer getPermissionValue(User user,
                                     PermissionType permissionType,
                                     java.lang.String target)

Get effective user permission.

Parameters:

user - user

permissionType - type of permission

target - permission target

Returns:

effective permission value

loadUserSessionEntities

java.util.Collection<UserSessionEntity> loadUserSessionEntities(UserSessionService.Filter filter)

Load list of non-persistent entities representing active user sessions.

Parameters:

filter - can be used to limit the loaded list. Pass UserSessionService.Filter.ALL to load all.

Returns:

list of entities