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

Class AuthenticatedClientSessionUpdater

java.lang.Object

org.keycloak.models.sessions.infinispan.changes.remote.updater.BaseUpdater<ClientSessionKey,RemoteAuthenticatedClientSessionEntity>

org.keycloak.models.sessions.infinispan.changes.remote.updater.client.AuthenticatedClientSessionUpdater

All Implemented Interfaces:

BiFunction<ClientSessionKey,RemoteAuthenticatedClientSessionEntity,RemoteAuthenticatedClientSessionEntity>, AuthenticatedClientSessionModel, Updater<ClientSessionKey,RemoteAuthenticatedClientSessionEntity>, CommonClientSessionModel

public class AuthenticatedClientSessionUpdater
extends BaseUpdater<ClientSessionKey,RemoteAuthenticatedClientSessionEntity>
implements AuthenticatedClientSessionModel

An Updater implementation that keeps track of AuthenticatedClientSessionModel changes.

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.sessions.CommonClientSessionModel

CommonClientSessionModel.Action, CommonClientSessionModel.ExecutionStatus

Field Summary

Fields inherited from interface org.keycloak.models.AuthenticatedClientSessionModel

REFRESH_TOKEN_LAST_REFRESH_PREFIX, REFRESH_TOKEN_PREFIX, REFRESH_TOKEN_USE_PREFIX, STARTED_AT_NOTE, USER_SESSION_REMEMBER_ME_NOTE, USER_SESSION_STARTED_AT_NOTE

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

NO_VERSION

Method Summary

Modifier and Type	Method	Description
RemoteAuthenticatedClientSessionEntity	apply(ClientSessionKey uuid, RemoteAuthenticatedClientSessionEntity entity)
Expiration	computeExpiration()	Computes the expiration data for Infinispan cache.
void	detachFromUserSession()	Detaches the client session from its user session.
String	getAction()
ClientModel	getClient()
String	getId()
String	getNote(String name)
Map<String,String>	getNotes()
String	getProtocol()
RealmModel	getRealm()
String	getRedirectUri()
int	getStarted()
int	getTimestamp()
UserSessionModel	getUserSession()
int	getUserSessionStarted()
void	initialize(UserSessionModel userSession, ClientModel client, ClientSessionChangeLogTransaction clientTransaction)	Initializes this class with references to other models classes.
boolean	isInitialized()
boolean	isTransient()
protected boolean	isUnchanged()
boolean	isUserSessionRememberMe()
static UpdaterFactory<ClientSessionKey,RemoteAuthenticatedClientSessionEntity,AuthenticatedClientSessionUpdater>	offlineFactory()
static UpdaterFactory<ClientSessionKey,RemoteAuthenticatedClientSessionEntity,AuthenticatedClientSessionUpdater>	onlineFactory()
void	removeNote(String name)
void	restartClientSession()
void	setAction(String action)
void	setNote(String name, String value)
void	setProtocol(String method)
void	setRedirectUri(String uri)
void	setTimestamp(int timestamp)	Set the timestamp for the client session.

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 org.keycloak.models.AuthenticatedClientSessionModel

getCurrentRefreshToken, getCurrentRefreshTokenUseCount, getRefreshToken, getRefreshTokenLastRefresh, getRefreshTokenUseCount, setCurrentRefreshToken, setCurrentRefreshTokenUseCount, setRefreshToken, setRefreshTokenLastRefresh, setRefreshTokenUseCount

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<ClientSessionKey,RemoteAuthenticatedClientSessionEntity,AuthenticatedClientSessionUpdater> onlineFactory()

Returns:

The UpdaterFactory implementation to create online session instances of AuthenticatedClientSessionUpdater.

offlineFactory

public static UpdaterFactory<ClientSessionKey,RemoteAuthenticatedClientSessionEntity,AuthenticatedClientSessionUpdater> offlineFactory()

Returns:

The UpdaterFactory implementation to create offline session instances of AuthenticatedClientSessionUpdater.

apply

public RemoteAuthenticatedClientSessionEntity apply(ClientSessionKey uuid,
 RemoteAuthenticatedClientSessionEntity entity)

Specified by:

apply in interface BiFunction<ClientSessionKey,RemoteAuthenticatedClientSessionEntity,RemoteAuthenticatedClientSessionEntity>

computeExpiration

public Expiration computeExpiration()

Description copied from interface: Updater

Computes the expiration data for Infinispan cache.

Specified by:

computeExpiration in interface Updater<ClientSessionKey,RemoteAuthenticatedClientSessionEntity>

Returns:

The Expiration data.

getId

public String getId()

Specified by:

getId in interface AuthenticatedClientSessionModel

getStarted

public int getStarted()

Specified by:

getStarted in interface AuthenticatedClientSessionModel

getUserSessionStarted

public int getUserSessionStarted()

Specified by:

getUserSessionStarted in interface AuthenticatedClientSessionModel

isUserSessionRememberMe

public boolean isUserSessionRememberMe()

Specified by:

isUserSessionRememberMe in interface AuthenticatedClientSessionModel

getTimestamp

public int getTimestamp()

Specified by:

getTimestamp in interface AuthenticatedClientSessionModel

setTimestamp

public void setTimestamp(int timestamp)

Description copied from interface: AuthenticatedClientSessionModel

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

Specified by:

setTimestamp in interface AuthenticatedClientSessionModel

detachFromUserSession

public void detachFromUserSession()

Description copied from interface: AuthenticatedClientSessionModel

Detaches the client session from its user session.

Specified by:

detachFromUserSession in interface AuthenticatedClientSessionModel

getUserSession

public UserSessionModel getUserSession()

Specified by:

getUserSession in interface AuthenticatedClientSessionModel

getNote

public String getNote(String name)

Specified by:

getNote in interface AuthenticatedClientSessionModel

setNote

public void setNote(String name,
 String value)

Specified by:

setNote in interface AuthenticatedClientSessionModel

removeNote

public void removeNote(String name)

Specified by:

removeNote in interface AuthenticatedClientSessionModel

getNotes

public Map<String,String> getNotes()

Specified by:

getNotes in interface AuthenticatedClientSessionModel

getRedirectUri

public String getRedirectUri()

Specified by:

getRedirectUri in interface CommonClientSessionModel

setRedirectUri

public void setRedirectUri(String uri)

Specified by:

setRedirectUri in interface CommonClientSessionModel

getRealm

public RealmModel getRealm()

Specified by:

getRealm in interface CommonClientSessionModel

getClient

public ClientModel getClient()

Specified by:

getClient in interface CommonClientSessionModel

getAction

public String getAction()

Specified by:

getAction in interface CommonClientSessionModel

setAction

public void setAction(String action)

Specified by:

setAction in interface CommonClientSessionModel

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface CommonClientSessionModel

setProtocol

public void setProtocol(String method)

Specified by:

setProtocol in interface CommonClientSessionModel

restartClientSession

public void restartClientSession()

Specified by:

restartClientSession in interface AuthenticatedClientSessionModel

isTransient

public boolean isTransient()

Specified by:

isTransient in interface Updater<ClientSessionKey,RemoteAuthenticatedClientSessionEntity>

Overrides:

isTransient in class BaseUpdater<ClientSessionKey,RemoteAuthenticatedClientSessionEntity>

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<ClientSessionKey,RemoteAuthenticatedClientSessionEntity>

Returns:

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

initialize

public void initialize(UserSessionModel userSession,
 ClientModel client,
 ClientSessionChangeLogTransaction clientTransaction)

Initializes this class with references to other models classes.

Parameters:

userSession - The UserSessionModel associated with this client session.

client - The ClientModel associated with this client session.

clientTransaction - The ClientSessionChangeLogTransaction to perform the changes in this class into the RemoteCache.

isInitialized

public boolean isInitialized()

Returns:

true if it is already initialized.