com.haulmont.cuba.security.app

Class UserSessionServiceBean

java.lang.Object

com.haulmont.cuba.security.app.UserSessionServiceBean

All Implemented Interfaces:

UserSessionService

@Service(value="cuba_UserSessionService")
public class UserSessionServiceBean
extends java.lang.Object
implements UserSessionService

Service facade to active UserSessions management.

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.security.app.UserSessionService

UserSessionService.Filter

Field Summary

Fields

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

Fields inherited from interface com.haulmont.cuba.security.app.UserSessionService

NAME

Constructor Summary

Constructors

Constructor and Description
UserSessionServiceBean()

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()
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.

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_ATTR_PREFIX

public static final java.lang.String MESSAGE_ATTR_PREFIX

See Also:

Constant Field Values

Constructor Detail

UserSessionServiceBean

public UserSessionServiceBean()

Method Detail

getUserSession

public UserSession getUserSession(java.util.UUID sessionId)

Description copied from interface: UserSessionService

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.

Specified by:

getUserSession in interface UserSessionService

Parameters:

sessionId - a session identifier

Returns:

an active user session instance copy, if exists

setSessionAttribute

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

Description copied from interface: UserSessionService

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

Specified by:

setSessionAttribute in interface UserSessionService

Parameters:

sessionId - an active session identifier

name - attribute name

value - attribute value

removeSessionAttribute

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

Description copied from interface: UserSessionService

Remove a session attribute, propagating changes to the cluster.

Specified by:

removeSessionAttribute in interface UserSessionService

Parameters:

sessionId - an active session identifier

name - attribute name

setSessionLocale

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

Description copied from interface: UserSessionService

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

Specified by:

setSessionLocale in interface UserSessionService

Parameters:

sessionId - an active session identifier

locale - user locale

setSessionTimeZone

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

Description copied from interface: UserSessionService

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

Specified by:

setSessionTimeZone in interface UserSessionService

Parameters:

sessionId - an active session identifier

timeZone - user time zone

setSessionAddress

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

Description copied from interface: UserSessionService

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

Specified by:

setSessionAddress in interface UserSessionService

Parameters:

sessionId - an active session identifier

address - client's address

setSessionClientInfo

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

Description copied from interface: UserSessionService

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

Specified by:

setSessionClientInfo in interface UserSessionService

Parameters:

sessionId - an active session identifier

clientInfo - client's info

getUserSessionInfo

public java.util.Collection<UserSessionEntity> getUserSessionInfo()

Specified by:

getUserSessionInfo in interface UserSessionService

loadUserSessionEntities

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

Description copied from interface: UserSessionService

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

Specified by:

loadUserSessionEntities in interface UserSessionService

Parameters:

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

Returns:

list of entities

killSession

public void killSession(java.util.UUID id)

Description copied from interface: UserSessionService

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

Specified by:

killSession in interface UserSessionService

Parameters:

id - an active session identifier

postMessage

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

Description copied from interface: UserSessionService

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

Specified by:

postMessage in interface UserSessionService

Parameters:

sessionIds - list of session identifiers

message - the message text

getMessages

@Nullable
public java.lang.String getMessages()

Description copied from interface: UserSessionService

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

Specified by:

getMessages in interface UserSessionService

Returns:

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

getPermissionValue

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

Description copied from interface: UserSessionService

Get effective user permission.

Specified by:

getPermissionValue in interface UserSessionService

Parameters:

user - user

permissionType - type of permission

target - permission target

Returns:

effective permission value