public interface UserSessionsAPI extends UserSessionFinder
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
Modifier and Type | Method and Description |
---|---|
void |
add(UserSession session)
INTERNAL.
|
java.util.List<java.util.UUID> |
findUserSessionsByAttribute(java.lang.String attributeName,
java.lang.Object attributeValue)
Deprecated.
use
getUserSessionsStream() and filter it as needed |
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.
|
java.util.stream.Stream<UserSessionEntity> |
getUserSessionEntitiesStream()
Stream of non-persistent entities representing active user sessions.
|
java.util.Collection<UserSessionEntity> |
getUserSessionInfo()
Deprecated.
use
getUserSessionEntitiesStream() or getUserSessionsStream() methods |
java.util.stream.Stream<UserSession> |
getUserSessionsStream()
Stream of active user sessions.
|
void |
killSession(java.util.UUID id)
INTERNAL.
|
void |
processEviction()
INTERNAL.
|
void |
propagate(java.util.UUID id)
INTERNAL.
|
void |
remove(UserSession session)
INTERNAL.
|
void |
setExpirationTimeoutSec(int value)
INTERNAL.
|
void |
setSendTimeoutSec(int timeout)
INTERNAL.
|
static final java.lang.String NAME
@Nullable UserSession get(java.util.UUID id)
get
in interface UserSessionFinder
id
- session idUserSession getNN(java.util.UUID id)
id
- session idNoUserSessionException
- if not found@Nullable UserSession getAndRefresh(java.util.UUID id)
id
- session idUserSession getAndRefreshNN(java.util.UUID id)
id
- session idNoUserSessionException
- if not found@Nullable UserSession getAndRefresh(java.util.UUID id, boolean propagate)
id
- session idpropagate
- whether to propagate the new "last used" timestamp to the clusterUserSession getAndRefreshNN(java.util.UUID id, boolean propagate)
id
- session idpropagate
- whether to propagate the new "last used" timestamp to the clusterNoUserSessionException
- if not foundjava.util.stream.Stream<UserSessionEntity> getUserSessionEntitiesStream()
java.util.stream.Stream<UserSession> getUserSessionsStream()
void add(UserSession session)
void remove(UserSession session)
void propagate(java.util.UUID id)
id
- session id. If session with this id is not found, does nothing.@Deprecated java.util.Collection<UserSessionEntity> getUserSessionInfo()
getUserSessionEntitiesStream()
or getUserSessionsStream()
methodsvoid killSession(java.util.UUID id)
id
- session id@Deprecated java.util.List<java.util.UUID> findUserSessionsByAttribute(java.lang.String attributeName, java.lang.Object attributeValue)
getUserSessionsStream()
and filter it as neededint getExpirationTimeoutSec()
setExpirationTimeoutSec(int)
void setExpirationTimeoutSec(int value)
value
- timeout in secondsint getSendTimeoutSec()
setSendTimeoutSec(int)
void setSendTimeoutSec(int timeout)
getAndRefresh(java.util.UUID)
,
the user session is sent to the cluster only after the specified timeout.timeout
- in secondsvoid processEviction()