com.haulmont.cuba.security.app

Class UserSessions

java.lang.Object

com.haulmont.cuba.security.app.UserSessions

All Implemented Interfaces:

UserSessionFinder, UserSessionsAPI

@Component(value="cuba_UserSessions")
public class UserSessions
extends java.lang.Object
implements UserSessionsAPI

User sessions distributed cache.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserSessions.UserSessionInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.util.UUID,UserSessions.UserSessionInfo>	cache
protected ClusterManagerAPI	clusterManager
protected int	expirationTimeout
protected Metadata	metadata
protected UserSession	NO_USER_SESSION
protected int	sendTimeout
protected ServerConfig	serverConfig
protected TimeSource	timeSource
protected int	touchTimeout
protected UserSessionLog	userSessionLog

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

NAME

Constructor Summary

Constructors

Constructor and Description
UserSessions()

Method Summary

Modifier and Type	Method and Description
void	add(UserSession session) INTERNAL.
protected UserSessionEntity	createUserSessionEntity(UserSession session, long since, long lastUsedTs)
java.util.List<java.util.UUID>	findUserSessionsByAttribute(java.lang.String attributeName, java.lang.Object attributeValue)
UserSession	get(java.util.UUID id) Get user session from cache.
UserSession	getAndRefresh(java.util.UUID id) Get user session from cache, updating its "last used" timestamp.
UserSession	getAndRefresh(java.util.UUID id, boolean propagate) Get user session from cache, updating its "last used" timestamp and optionally propagating the new timestamp to the cluster.
UserSession	getAndRefreshNN(java.util.UUID id) Get user session from cache, updating its "last used" timestamp.
UserSession	getAndRefreshNN(java.util.UUID id, boolean propagate) Get user session from cache, updating its "last used" timestamp and optionally propagating the new timestamp to the cluster.
int	getExpirationTimeoutSec() INTERNAL.
UserSession	getNN(java.util.UUID id) Get user session from cache.
int	getSendTimeoutSec() INTERNAL.
protected UserSessions.UserSessionInfo	getSessionInfo(java.util.UUID id)
protected java.util.stream.Stream<UserSessions.UserSessionInfo>	getSessionInfoStream()
java.util.stream.Stream<UserSessionEntity>	getUserSessionEntitiesStream() Stream of non-persistent entities representing active user sessions.
java.util.Collection<UserSessionEntity>	getUserSessionInfo()
java.util.stream.Stream<UserSession>	getUserSessionsStream() Stream of active user sessions.
protected UserSession	internalGet(java.util.UUID id, boolean touch, boolean propagate)
void	killSession(java.util.UUID id) INTERNAL.
void	processEviction() INTERNAL.
void	propagate(java.util.UUID id) INTERNAL.
protected void	putSessionInfo(java.util.UUID id, UserSessions.UserSessionInfo info)
protected void	receiveClusterMessage(UserSessions.UserSessionInfo message)
protected void	receiveClusterState(byte[] state)
void	remove(UserSession session) INTERNAL.
protected UserSessions.UserSessionInfo	removeSessionInfo(java.util.UUID id)
protected byte[]	sendClusterState()
void	setClusterManager(ClusterManagerAPI clusterManager)
void	setConfiguration(Configuration configuration)
void	setExpirationTimeoutSec(int value) INTERNAL.
void	setSendTimeoutSec(int timeout) INTERNAL.
protected long	toMillis(int seconds)

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected java.util.Map<java.util.UUID,UserSessions.UserSessionInfo> cache

expirationTimeout

protected volatile int expirationTimeout

sendTimeout

protected volatile int sendTimeout

touchTimeout

protected volatile int touchTimeout

clusterManager

protected ClusterManagerAPI clusterManager

NO_USER_SESSION

protected UserSession NO_USER_SESSION

serverConfig

protected ServerConfig serverConfig

timeSource

@Inject
protected TimeSource timeSource

metadata

@Inject
protected Metadata metadata

userSessionLog

@Inject
protected UserSessionLog userSessionLog

Constructor Detail

UserSessions

public UserSessions()

Method Detail

setConfiguration

@Inject
public void setConfiguration(Configuration configuration)

setClusterManager

@Inject
public void setClusterManager(ClusterManagerAPI clusterManager)

receiveClusterMessage

protected void receiveClusterMessage(UserSessions.UserSessionInfo message)

receiveClusterState

protected void receiveClusterState(byte[] state)

sendClusterState

protected byte[] sendClusterState()

add

public void add(UserSession session)

Description copied from interface: UserSessionsAPI

INTERNAL. Add a session.

Specified by:

add in interface UserSessionsAPI

remove

public void remove(UserSession session)

Description copied from interface: UserSessionsAPI

INTERNAL. Remove a session.

Specified by:

remove in interface UserSessionsAPI

get

@Nullable
public UserSession get(java.util.UUID id)

Description copied from interface: UserSessionsAPI

Get user session from cache.

Specified by:

get in interface UserSessionFinder

Specified by:

get in interface UserSessionsAPI

Parameters:

id - session id

Returns:

user session instance or null if not found

getNN

public UserSession getNN(java.util.UUID id)

Description copied from interface: UserSessionsAPI

Get user session from cache.

Specified by:

getNN in interface UserSessionsAPI

Parameters:

id - session id

Returns:

user session instance

getAndRefresh

@Nullable
public UserSession getAndRefresh(java.util.UUID id)

Description copied from interface: UserSessionsAPI

Get user session from cache, updating its "last used" timestamp.

Specified by:

getAndRefresh in interface UserSessionsAPI

Parameters:

id - session id

Returns:

user session instance or null if not found

getAndRefreshNN

public UserSession getAndRefreshNN(java.util.UUID id)

Description copied from interface: UserSessionsAPI

Get user session from cache, updating its "last used" timestamp.

Specified by:

getAndRefreshNN in interface UserSessionsAPI

Parameters:

id - session id

Returns:

user session instance

getAndRefresh

@Nullable
public UserSession getAndRefresh(java.util.UUID id,
                                           boolean propagate)

Description copied from interface: UserSessionsAPI

Get user session from cache, updating its "last used" timestamp and optionally propagating the new timestamp to the cluster.

Specified by:

getAndRefresh in interface UserSessionsAPI

Parameters:

id - session id

propagate - whether to propagate the new "last used" timestamp to the cluster

Returns:

user session instance or null if not found

getAndRefreshNN

public UserSession getAndRefreshNN(java.util.UUID id,
                                   boolean propagate)

Description copied from interface: UserSessionsAPI

Get user session from cache, updating its "last used" timestamp and optionally propagating the new timestamp to the cluster.

Specified by:

getAndRefreshNN in interface UserSessionsAPI

Parameters:

id - session id

propagate - whether to propagate the new "last used" timestamp to the cluster

Returns:

user session instance

internalGet

@Nullable
protected UserSession internalGet(java.util.UUID id,
                                            boolean touch,
                                            boolean propagate)

propagate

public void propagate(java.util.UUID id)

Description copied from interface: UserSessionsAPI

INTERNAL. Propagates the user session state to the cluster

Specified by:

propagate in interface UserSessionsAPI

Parameters:

id - session id. If session with this id is not found, does nothing.

getExpirationTimeoutSec

public int getExpirationTimeoutSec()

Description copied from interface: UserSessionsAPI

INTERNAL.

Specified by:

getExpirationTimeoutSec in interface UserSessionsAPI

Returns:

session expiration timeout in the cache

See Also:

UserSessionsAPI.setExpirationTimeoutSec(int)

setExpirationTimeoutSec

public void setExpirationTimeoutSec(int value)

Description copied from interface: UserSessionsAPI

INTERNAL. Set session expiration timeout for the cache.

Specified by:

setExpirationTimeoutSec in interface UserSessionsAPI

Parameters:

value - timeout in seconds

getSendTimeoutSec

public int getSendTimeoutSec()

Description copied from interface: UserSessionsAPI

INTERNAL.

Specified by:

getSendTimeoutSec in interface UserSessionsAPI

Returns:

session sending timeout in cluster

See Also:

UserSessionsAPI.setSendTimeoutSec(int)

setSendTimeoutSec

public void setSendTimeoutSec(int timeout)

Description copied from interface: UserSessionsAPI

INTERNAL. Set user session ping timeout in cluster. If ping is performed by UserSessionsAPI.getAndRefresh(java.util.UUID), the user session is sent to the cluster only after the specified timeout.

Specified by:

setSendTimeoutSec in interface UserSessionsAPI

Parameters:

timeout - in seconds

getUserSessionInfo

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

Specified by:

getUserSessionInfo in interface UserSessionsAPI

createUserSessionEntity

protected UserSessionEntity createUserSessionEntity(UserSession session,
                                                    long since,
                                                    long lastUsedTs)

getUserSessionEntitiesStream

public java.util.stream.Stream<UserSessionEntity> getUserSessionEntitiesStream()

Description copied from interface: UserSessionsAPI

Stream of non-persistent entities representing active user sessions.

Specified by:

getUserSessionEntitiesStream in interface UserSessionsAPI

getUserSessionsStream

public java.util.stream.Stream<UserSession> getUserSessionsStream()

Description copied from interface: UserSessionsAPI

Stream of active user sessions.

Specified by:

getUserSessionsStream in interface UserSessionsAPI

killSession

public void killSession(java.util.UUID id)

Description copied from interface: UserSessionsAPI

INTERNAL. Immediately remove a sessions from cache.

Specified by:

killSession in interface UserSessionsAPI

Parameters:

id - session id

findUserSessionsByAttribute

public java.util.List<java.util.UUID> findUserSessionsByAttribute(java.lang.String attributeName,
                                                                  java.lang.Object attributeValue)

Specified by:

findUserSessionsByAttribute in interface UserSessionsAPI

processEviction

public void processEviction()

Description copied from interface: UserSessionsAPI

INTERNAL. Evict timed out sessions from the cache.

Specified by:

processEviction in interface UserSessionsAPI

getSessionInfo

protected UserSessions.UserSessionInfo getSessionInfo(java.util.UUID id)

putSessionInfo

protected void putSessionInfo(java.util.UUID id,
                              UserSessions.UserSessionInfo info)

removeSessionInfo

@Nullable
protected UserSessions.UserSessionInfo removeSessionInfo(java.util.UUID id)

getSessionInfoStream

protected java.util.stream.Stream<UserSessions.UserSessionInfo> getSessionInfoStream()

toMillis

protected long toMillis(int seconds)