Package org.keycloak.models.sessions.infinispan.changes.remote.updater.user

Class UserSessionUpdater

java.lang.Object

org.keycloak.models.sessions.infinispan.changes.remote.updater.BaseUpdater<String,RemoteUserSessionEntity>

org.keycloak.models.sessions.infinispan.changes.remote.updater.user.UserSessionUpdater

All Implemented Interfaces:

BiFunction<String,RemoteUserSessionEntity,RemoteUserSessionEntity>, Updater<String,RemoteUserSessionEntity>, UserSessionModel

public class UserSessionUpdater
extends BaseUpdater<String,RemoteUserSessionEntity>
implements UserSessionModel

The Updater implementation to keep track of modifications for UserSessionModel.

Nested Class Summary

Nested classes/interfaces inherited from class org.keycloak.models.sessions.infinispan.changes.remote.updater.BaseUpdater

BaseUpdater.UpdaterState

Nested classes/interfaces inherited from interface org.keycloak.models.UserSessionModel

UserSessionModel.SessionPersistenceState, UserSessionModel.State

Field Summary

Fields inherited from interface org.keycloak.models.sessions.infinispan.changes.remote.updater.Updater

NO_VERSION

Fields inherited from interface org.keycloak.models.UserSessionModel

CORRESPONDING_SESSION_ID

Method Summary

Modifier and Type	Method	Description
RemoteUserSessionEntity	apply(String ignored, RemoteUserSessionEntity userSessionEntity)
Expiration	computeExpiration()	Computes the expiration data for Infinispan cache.
AuthenticatedClientSessionModel	getAuthenticatedClientSessionByClient(String clientUUID)	Returns a client session for the given client UUID.
Map<String,AuthenticatedClientSessionModel>	getAuthenticatedClientSessions()	Returns map where key is ID of the client (its UUID) and value is ID respective AuthenticatedClientSessionModel object.
String	getAuthMethod()
String	getBrokerSessionId()	If created via a broker external login, this is an identifier that can be used to match external broker backchannel logout requests to a UserSession
String	getBrokerUserId()
String	getId()
String	getIpAddress()	Note: will not be an address when a proxy does not provide a valid one
int	getLastSessionRefresh()
String	getLoginUsername()
String	getNote(String name)
Map<String,String>	getNotes()
UserSessionModel.SessionPersistenceState	getPersistenceState()
RealmModel	getRealm()
int	getStarted()
UserSessionModel.State	getState()
UserModel	getUser()
void	initialize(UserSessionModel.SessionPersistenceState persistenceState, RealmModel realm, UserModel user, Map<String,AuthenticatedClientSessionModel> clientSessions)	Initializes this class with references to other models classes.
boolean	isInitialized()
boolean	isOffline()
boolean	isRememberMe()
boolean	isTransient()
protected boolean	isUnchanged()
static UpdaterFactory<String,RemoteUserSessionEntity,UserSessionUpdater>	offlineFactory()
static UpdaterFactory<String,RemoteUserSessionEntity,UserSessionUpdater>	onlineFactory()
void	removeAuthenticatedClientSessions(Collection<String> removedClientUUIDS)	Removes authenticated client sessions for all clients whose UUID is present in removedClientUUIDS parameter.
void	removeNote(String name)
void	restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
void	setLastSessionRefresh(int seconds)	Set the last session refresh timestamp for the user session.
void	setNote(String name, String value)
void	setState(UserSessionModel.State state)

Methods inherited from class org.keycloak.models.sessions.infinispan.changes.remote.updater.BaseUpdater

equals, getKey, getValue, getVersionRead, hashCode, isCreated, isDeleted, isReadOnly, markDeleted, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface org.keycloak.models.sessions.infinispan.changes.remote.updater.Updater

hasVersion

Method Details

onlineFactory

public static UpdaterFactory<String,RemoteUserSessionEntity,UserSessionUpdater> onlineFactory()

Returns:

The UpdaterFactory implementation to create online sessions instances of UserSessionModel.

offlineFactory

public static UpdaterFactory<String,RemoteUserSessionEntity,UserSessionUpdater> offlineFactory()

Returns:

The UpdaterFactory implementation to create offline sessions instances of UserSessionModel.

apply

public RemoteUserSessionEntity apply(String ignored,
 RemoteUserSessionEntity userSessionEntity)

Specified by:

apply in interface BiFunction<String,RemoteUserSessionEntity,RemoteUserSessionEntity>

computeExpiration

public Expiration computeExpiration()

Description copied from interface: Updater

Computes the expiration data for Infinispan cache.

Specified by:

computeExpiration in interface Updater<String,RemoteUserSessionEntity>

Returns:

The Expiration data.

getId

public String getId()

Specified by:

getId in interface UserSessionModel

getRealm

public RealmModel getRealm()

Specified by:

getRealm in interface UserSessionModel

getBrokerSessionId

public String getBrokerSessionId()

Description copied from interface: UserSessionModel

If created via a broker external login, this is an identifier that can be used to match external broker backchannel logout requests to a UserSession

Specified by:

getBrokerSessionId in interface UserSessionModel

Returns:

getBrokerUserId

public String getBrokerUserId()

Specified by:

getBrokerUserId in interface UserSessionModel

getUser

public UserModel getUser()

Specified by:

getUser in interface UserSessionModel

getLoginUsername

public String getLoginUsername()

Specified by:

getLoginUsername in interface UserSessionModel

getIpAddress

public String getIpAddress()

Description copied from interface: UserSessionModel

Note: will not be an address when a proxy does not provide a valid one

Specified by:

getIpAddress in interface UserSessionModel

Returns:

the ip address

getAuthMethod

public String getAuthMethod()

Specified by:

getAuthMethod in interface UserSessionModel

isRememberMe

public boolean isRememberMe()

Specified by:

isRememberMe in interface UserSessionModel

getStarted

public int getStarted()

Specified by:

getStarted in interface UserSessionModel

getLastSessionRefresh

public int getLastSessionRefresh()

Specified by:

getLastSessionRefresh in interface UserSessionModel

setLastSessionRefresh

public void setLastSessionRefresh(int seconds)

Description copied from interface: UserSessionModel

Set the last session refresh timestamp for the user session. If the timestamp is smaller or equal than the current timestamp, the operation is ignored.

Specified by:

setLastSessionRefresh in interface UserSessionModel

isOffline

public boolean isOffline()

Specified by:

isOffline in interface UserSessionModel

getAuthenticatedClientSessions

public Map<String,AuthenticatedClientSessionModel> getAuthenticatedClientSessions()

Description copied from interface: UserSessionModel

Returns map where key is ID of the client (its UUID) and value is ID respective AuthenticatedClientSessionModel object.

Specified by:

getAuthenticatedClientSessions in interface UserSessionModel

Returns:

removeAuthenticatedClientSessions

public void removeAuthenticatedClientSessions(Collection<String> removedClientUUIDS)

Description copied from interface: UserSessionModel

Removes authenticated client sessions for all clients whose UUID is present in removedClientUUIDS parameter.

Specified by:

removeAuthenticatedClientSessions in interface UserSessionModel

getAuthenticatedClientSessionByClient

public AuthenticatedClientSessionModel getAuthenticatedClientSessionByClient(String clientUUID)

Description copied from interface: UserSessionModel

Returns a client session for the given client UUID.

Specified by:

getAuthenticatedClientSessionByClient in interface UserSessionModel

Returns:

getNote

public String getNote(String name)

Specified by:

getNote in interface UserSessionModel

setNote

public void setNote(String name,
 String value)

Specified by:

setNote in interface UserSessionModel

removeNote

public void removeNote(String name)

Specified by:

removeNote in interface UserSessionModel

getNotes

public Map<String,String> getNotes()

Specified by:

getNotes in interface UserSessionModel

getState

public UserSessionModel.State getState()

Specified by:

getState in interface UserSessionModel

setState

public void setState(UserSessionModel.State state)

Specified by:

setState in interface UserSessionModel

restartSession

public void restartSession(RealmModel realm,
 UserModel user,
 String loginUsername,
 String ipAddress,
 String authMethod,
 boolean rememberMe,
 String brokerSessionId,
 String brokerUserId)

Specified by:

restartSession in interface UserSessionModel

getPersistenceState

public UserSessionModel.SessionPersistenceState getPersistenceState()

Specified by:

getPersistenceState in interface UserSessionModel

Returns:

Persistence state of the session

isTransient

public boolean isTransient()

Specified by:

isTransient in interface Updater<String,RemoteUserSessionEntity>

Overrides:

isTransient in class BaseUpdater<String,RemoteUserSessionEntity>

Returns:

true if the entity is transient and shouldn't be stored in the Infinispan cache.

isUnchanged

protected boolean isUnchanged()

Specified by:

isUnchanged in class BaseUpdater<String,RemoteUserSessionEntity>

Returns:

true if the entity was changed after being created/read.

initialize

public void initialize(UserSessionModel.SessionPersistenceState persistenceState,
 RealmModel realm,
 UserModel user,
 Map<String,AuthenticatedClientSessionModel> clientSessions)

Initializes this class with references to other models classes.

Parameters:

persistenceState - The UserSessionModel.SessionPersistenceState.

realm - The RealmModel to where this user session belongs.

user - The UserModel associated to this user session.

clientSessions - The Map associated to this use session.

isInitialized

public boolean isInitialized()

Returns:

true if it is already initialized.