Package org.keycloak.models.sessions.infinispan

Class PersistentUserSessionProvider

java.lang.Object

org.keycloak.models.sessions.infinispan.PersistentUserSessionProvider

All Implemented Interfaces:

SessionRefreshStore, UserSessionProvider, Provider

public class PersistentUserSessionProvider
extends Object
implements UserSessionProvider, SessionRefreshStore

Author:

Stian Thorgersen

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>>	clientSessionCache
protected final ClientSessionPersistentChangelogBasedTransaction	clientSessionTx
protected final SessionEventsSenderTransaction	clusterEventsSenderTx
protected final InfinispanKeyGenerator	keyGenerator
protected final CrossDCLastSessionRefreshStore	lastSessionRefreshStore
protected final org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>>	offlineClientSessionCache
protected final CrossDCLastSessionRefreshStore	offlineLastSessionRefreshStore
protected final org.infinispan.Cache<String,SessionEntityWrapper<UserSessionEntity>>	offlineSessionCache
protected final KeycloakSession	session
protected final org.infinispan.Cache<String,SessionEntityWrapper<UserSessionEntity>>	sessionCache
protected final UserSessionPersistentChangelogBasedTransaction	sessionTx

Constructor Summary

Constructors

Constructor

Description

PersistentUserSessionProvider(KeycloakSession session, RemoteCacheInvoker remoteCacheInvoker, CrossDCLastSessionRefreshStore lastSessionRefreshStore, CrossDCLastSessionRefreshStore offlineLastSessionRefreshStore, InfinispanKeyGenerator keyGenerator, org.infinispan.Cache<String,SessionEntityWrapper<UserSessionEntity>> sessionCache, org.infinispan.Cache<String,SessionEntityWrapper<UserSessionEntity>> offlineSessionCache, org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>> clientSessionCache, org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>> offlineClientSessionCache, ArrayBlockingQueue<PersistentUpdate> asyncQueuePersistentUpdate, SerializeExecutionsByKey<String> serializerSession, SerializeExecutionsByKey<String> serializerOfflineSession, SerializeExecutionsByKey<UUID> serializerClientSession, SerializeExecutionsByKey<UUID> serializerOfflineClientSession)

Method Summary

Modifier and Type	Method	Description
void	close()
AuthenticatedClientSessionModel	createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession)
static UUID	createClientSessionUUID(String userSessionId, String clientId)
AuthenticatedClientSessionModel	createOfflineClientSession(AuthenticatedClientSessionModel clientSession, UserSessionModel offlineUserSession)	Will automatically attach newly created offline client session to the offlineUserSession
UserSessionModel	createOfflineUserSession(UserSessionModel userSession)	Newly created userSession won't contain attached AuthenticatedClientSessions
UserSessionModel	createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)	Creates a new user session with the given parameters.
Map<String,Long>	getActiveClientSessionStats(RealmModel realm, boolean offline)	Returns a summary of client sessions key is client.getId()
long	getActiveUserSessions(RealmModel realm, ClientModel client)
protected org.infinispan.Cache<String,SessionEntityWrapper<UserSessionEntity>>	getCache(boolean offline)
AuthenticatedClientSessionAdapter	getClientSession(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline)
protected org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>>	getClientSessionCache(boolean offline)
KeycloakSession	getKeycloakSession()	Returns currently used Keycloak session.
CrossDCLastSessionRefreshStore	getLastSessionRefreshStore()
CrossDCLastSessionRefreshStore	getOfflineLastSessionRefreshStore()
long	getOfflineSessionsCount(RealmModel realm, ClientModel client)
UserSessionAdapter	getOfflineUserSession(RealmModel realm, String userSessionId)
Stream<UserSessionModel>	getOfflineUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)	Obtains the offline user sessions associated with the user that matches the specified brokerUserId.
Stream<UserSessionModel>	getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer first, Integer max)	Obtains the offline user sessions associated with the specified client, starting from the firstResult and containing at most maxResults.
Stream<UserSessionModel>	getOfflineUserSessionsStream(RealmModel realm, UserModel user)	Obtains the offline user sessions associated with the specified user.
PersisterLastSessionRefreshStore	getPersisterLastSessionRefreshStore()
int	getStartupTime(RealmModel realm)
UserSessionModel	getUserSession(RealmModel realm, String id)
UserSessionModel	getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
Stream<UserSessionModel>	getUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)	Obtains the online user sessions associated with the user that matches the specified brokerUserId.
protected long	getUserSessionsCount(RealmModel realm, ClientModel client, boolean offline)
Stream<UserSessionModel>	getUserSessionsStream(RealmModel realm, ClientModel client)	Obtains the online user sessions associated with the specified client.
Stream<UserSessionModel>	getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)	Obtains the online user sessions associated with the specified client, starting from the firstResult and containing at most maxResults.
protected Stream<UserSessionModel>	getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults, boolean offline)
protected Stream<UserSessionModel>	getUserSessionsStream(RealmModel realm, UserSessionPredicate predicate, boolean offline)
Stream<UserSessionModel>	getUserSessionsStream(RealmModel realm, UserModel user)	Obtains the online user sessions associated with the specified user.
UserSessionModel	getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)	Return userSession of specified ID as long as the predicate passes.
SessionEntityWrapper<UserSessionEntity>	importUserSession(UserSessionModel persistentUserSession, boolean offline)
void	importUserSessions(Collection<UserSessionModel> persistentUserSessions, boolean offline)	Triggered by persister during pre-load.
void	migrate(String modelVersion)
void	migrateNonPersistentSessionsToPersistentSessions()	Copy over all sessions in Infinispan to the persistent user sessions in the database.
void	onClientRemoved(RealmModel realm, ClientModel client)
void	onRealmRemoved(RealmModel realm)
protected void	onRealmRemovedEvent(String realmId)
protected void	onRemoveUserSessionsEvent(String realmId)
protected void	onUserRemoved(RealmModel realm, UserModel user)
void	removeAllExpired()	Remove expired user sessions and client sessions in all the realms
void	removeExpired(RealmModel realm)	Removes expired user sessions owned by this realm from this provider.
void	removeLocalUserSessions(String realmId, boolean offline)
void	removeOfflineUserSession(RealmModel realm, UserSessionModel userSession)	Removes the attached clientSessions as well
void	removeUserSession(RealmModel realm, UserSessionModel session)	This will remove attached ClientLoginSessionModels too
protected void	removeUserSession(UserSessionEntity sessionEntity, boolean offline)
void	removeUserSessions(RealmModel realm)
void	removeUserSessions(RealmModel realm, UserModel user)
protected void	removeUserSessions(RealmModel realm, UserModel user, boolean offline)
SessionEntityWrapper<UserSessionEntity>	wrapPersistentEntity(RealmModel realm, boolean offline, UserSessionModel persistentUserSession)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.models.UserSessionProvider

createUserSession, getClientSession

Field Details

session

protected final KeycloakSession session

sessionCache

protected final org.infinispan.Cache<String,SessionEntityWrapper<UserSessionEntity>> sessionCache

offlineSessionCache

protected final org.infinispan.Cache<String,SessionEntityWrapper<UserSessionEntity>> offlineSessionCache

clientSessionCache

protected final org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>> clientSessionCache

offlineClientSessionCache

protected final org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>> offlineClientSessionCache

sessionTx

protected final UserSessionPersistentChangelogBasedTransaction sessionTx

clientSessionTx

protected final ClientSessionPersistentChangelogBasedTransaction clientSessionTx

clusterEventsSenderTx

protected final SessionEventsSenderTransaction clusterEventsSenderTx

lastSessionRefreshStore

protected final CrossDCLastSessionRefreshStore lastSessionRefreshStore

offlineLastSessionRefreshStore

protected final CrossDCLastSessionRefreshStore offlineLastSessionRefreshStore

keyGenerator

protected final InfinispanKeyGenerator keyGenerator

Constructor Details

PersistentUserSessionProvider

public PersistentUserSessionProvider(KeycloakSession session,
 RemoteCacheInvoker remoteCacheInvoker,
 CrossDCLastSessionRefreshStore lastSessionRefreshStore,
 CrossDCLastSessionRefreshStore offlineLastSessionRefreshStore,
 InfinispanKeyGenerator keyGenerator,
 org.infinispan.Cache<String,SessionEntityWrapper<UserSessionEntity>> sessionCache,
 org.infinispan.Cache<String,SessionEntityWrapper<UserSessionEntity>> offlineSessionCache,
 org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>> clientSessionCache,
 org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>> offlineClientSessionCache,
 ArrayBlockingQueue<PersistentUpdate> asyncQueuePersistentUpdate,
 SerializeExecutionsByKey<String> serializerSession,
 SerializeExecutionsByKey<String> serializerOfflineSession,
 SerializeExecutionsByKey<UUID> serializerClientSession,
 SerializeExecutionsByKey<UUID> serializerOfflineClientSession)

Method Details

getCache

protected org.infinispan.Cache<String,SessionEntityWrapper<UserSessionEntity>> getCache(boolean offline)

getClientSessionCache

protected org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>> getClientSessionCache(boolean offline)

getLastSessionRefreshStore

public CrossDCLastSessionRefreshStore getLastSessionRefreshStore()

Specified by:

getLastSessionRefreshStore in interface SessionRefreshStore

getOfflineLastSessionRefreshStore

public CrossDCLastSessionRefreshStore getOfflineLastSessionRefreshStore()

Specified by:

getOfflineLastSessionRefreshStore in interface SessionRefreshStore

getPersisterLastSessionRefreshStore

public PersisterLastSessionRefreshStore getPersisterLastSessionRefreshStore()

Specified by:

getPersisterLastSessionRefreshStore in interface SessionRefreshStore

getKeycloakSession

public KeycloakSession getKeycloakSession()

Description copied from interface: UserSessionProvider

Returns currently used Keycloak session.

Specified by:

getKeycloakSession in interface UserSessionProvider

Returns:

KeycloakSession

createClientSession

public AuthenticatedClientSessionModel createClientSession(RealmModel realm,
 ClientModel client,
 UserSessionModel userSession)

Specified by:

createClientSession in interface UserSessionProvider

createUserSession

public UserSessionModel createUserSession(String id,
 RealmModel realm,
 UserModel user,
 String loginUsername,
 String ipAddress,
 String authMethod,
 boolean rememberMe,
 String brokerSessionId,
 String brokerUserId,
 UserSessionModel.SessionPersistenceState persistenceState)

Description copied from interface: UserSessionProvider

Creates a new user session with the given parameters.

Specified by:

createUserSession in interface UserSessionProvider

Parameters:

id - identifier. Is generated if null

realm - the realm

user - user associated with the created user session

Returns:

Model of the created user session

getUserSession

public UserSessionModel getUserSession(RealmModel realm,
 String id)

Specified by:

getUserSession in interface UserSessionProvider

getUserSessionsStream

protected Stream<UserSessionModel> getUserSessionsStream(RealmModel realm,
 UserSessionPredicate predicate,
 boolean offline)

getClientSession

public AuthenticatedClientSessionAdapter getClientSession(UserSessionModel userSession,
 ClientModel client,
 String clientSessionId,
 boolean offline)

Specified by:

getClientSession in interface UserSessionProvider

getUserSessionsStream

public Stream<UserSessionModel> getUserSessionsStream(RealmModel realm,
 UserModel user)

Description copied from interface: UserSessionProvider

Obtains the online user sessions associated with the specified user.

Specified by:

getUserSessionsStream in interface UserSessionProvider

Parameters:

realm - a reference to the realm.

user - the user whose sessions are being searched.

Returns:

a non-null Stream of online user sessions.

getUserSessionByBrokerUserIdStream

public Stream<UserSessionModel> getUserSessionByBrokerUserIdStream(RealmModel realm,
 String brokerUserId)

Description copied from interface: UserSessionProvider

Obtains the online user sessions associated with the user that matches the specified brokerUserId.

Specified by:

getUserSessionByBrokerUserIdStream in interface UserSessionProvider

Parameters:

realm - a reference to the realm.

brokerUserId - the id of the broker user whose sessions are being searched.

Returns:

a non-null Stream of online user sessions.

getUserSessionByBrokerSessionId

public UserSessionModel getUserSessionByBrokerSessionId(RealmModel realm,
 String brokerSessionId)

Specified by:

getUserSessionByBrokerSessionId in interface UserSessionProvider

getUserSessionsStream

public Stream<UserSessionModel> getUserSessionsStream(RealmModel realm,
 ClientModel client)

Description copied from interface: UserSessionProvider

Obtains the online user sessions associated with the specified client.

Specified by:

getUserSessionsStream in interface UserSessionProvider

Parameters:

realm - a reference to the realm.

client - the client whose user sessions are being searched.

Returns:

a non-null Stream of online user sessions.

getUserSessionsStream

public Stream<UserSessionModel> getUserSessionsStream(RealmModel realm,
 ClientModel client,
 Integer firstResult,
 Integer maxResults)

Description copied from interface: UserSessionProvider

Obtains the online user sessions associated with the specified client, starting from the firstResult and containing at most maxResults.

Specified by:

getUserSessionsStream in interface UserSessionProvider

Parameters:

realm - a reference to the realm.

client - the client whose user sessions are being searched.

firstResult - first result to return. Ignored if negative or null.

maxResults - maximum number of results to return. Ignored if negative or null.

Returns:

a non-null Stream of online user sessions.

getUserSessionsStream

protected Stream<UserSessionModel> getUserSessionsStream(RealmModel realm,
 ClientModel client,
 Integer firstResult,
 Integer maxResults,
 boolean offline)

getUserSessionWithPredicate

public UserSessionModel getUserSessionWithPredicate(RealmModel realm,
 String id,
 boolean offline,
 Predicate<UserSessionModel> predicate)

Description copied from interface: UserSessionProvider

Return userSession of specified ID as long as the predicate passes. Otherwise, returns null. If predicate doesn't pass, implementation can do some best-effort actions to try to have predicate passing (e.g. download userSession from other DC)

Specified by:

getUserSessionWithPredicate in interface UserSessionProvider

getActiveUserSessions

public long getActiveUserSessions(RealmModel realm,
 ClientModel client)

Specified by:

getActiveUserSessions in interface UserSessionProvider

getActiveClientSessionStats

public Map<String,Long> getActiveClientSessionStats(RealmModel realm,
 boolean offline)

Description copied from interface: UserSessionProvider

Returns a summary of client sessions key is client.getId()

Specified by:

getActiveClientSessionStats in interface UserSessionProvider

Returns:

getUserSessionsCount

protected long getUserSessionsCount(RealmModel realm,
 ClientModel client,
 boolean offline)

removeUserSession

public void removeUserSession(RealmModel realm,
 UserSessionModel session)

Description copied from interface: UserSessionProvider

This will remove attached ClientLoginSessionModels too

Specified by:

removeUserSession in interface UserSessionProvider

removeUserSessions

public void removeUserSessions(RealmModel realm,
 UserModel user)

Specified by:

removeUserSessions in interface UserSessionProvider

removeUserSessions

protected void removeUserSessions(RealmModel realm,
 UserModel user,
 boolean offline)

removeAllExpired

public void removeAllExpired()

Description copied from interface: UserSessionProvider

Remove expired user sessions and client sessions in all the realms

Specified by:

removeAllExpired in interface UserSessionProvider

removeExpired

public void removeExpired(RealmModel realm)

Description copied from interface: UserSessionProvider

Removes expired user sessions owned by this realm from this provider. If this `UserSessionProvider` uses `UserSessionPersister`, the removal of the expired user sessions is also propagated to relevant `UserSessionPersister`.

Specified by:

removeExpired in interface UserSessionProvider

Parameters:

realm - RealmModel Realm where all the expired user sessions to be removed from.

removeUserSessions

public void removeUserSessions(RealmModel realm)

Specified by:

removeUserSessions in interface UserSessionProvider

onRemoveUserSessionsEvent

protected void onRemoveUserSessionsEvent(String realmId)

removeLocalUserSessions

public void removeLocalUserSessions(String realmId,
 boolean offline)

onRealmRemoved

public void onRealmRemoved(RealmModel realm)

Specified by:

onRealmRemoved in interface UserSessionProvider

onRealmRemovedEvent

protected void onRealmRemovedEvent(String realmId)

onClientRemoved

public void onClientRemoved(RealmModel realm,
 ClientModel client)

Specified by:

onClientRemoved in interface UserSessionProvider

onUserRemoved

protected void onUserRemoved(RealmModel realm,
 UserModel user)

close

public void close()

Specified by:

close in interface Provider

Specified by:

close in interface UserSessionProvider

getStartupTime

public int getStartupTime(RealmModel realm)

Specified by:

getStartupTime in interface UserSessionProvider

removeUserSession

protected void removeUserSession(UserSessionEntity sessionEntity,
 boolean offline)

createOfflineUserSession

public UserSessionModel createOfflineUserSession(UserSessionModel userSession)

Description copied from interface: UserSessionProvider

Newly created userSession won't contain attached AuthenticatedClientSessions

Specified by:

createOfflineUserSession in interface UserSessionProvider

getOfflineUserSession

public UserSessionAdapter getOfflineUserSession(RealmModel realm,
 String userSessionId)

Specified by:

getOfflineUserSession in interface UserSessionProvider

getOfflineUserSessionByBrokerUserIdStream

public Stream<UserSessionModel> getOfflineUserSessionByBrokerUserIdStream(RealmModel realm,
 String brokerUserId)

Description copied from interface: UserSessionProvider

Obtains the offline user sessions associated with the user that matches the specified brokerUserId.

Specified by:

getOfflineUserSessionByBrokerUserIdStream in interface UserSessionProvider

Parameters:

realm - a reference to the realm.

brokerUserId - the id of the broker user whose sessions are being searched.

Returns:

a non-null Stream of offline user sessions.

removeOfflineUserSession

public void removeOfflineUserSession(RealmModel realm,
 UserSessionModel userSession)

Description copied from interface: UserSessionProvider

Removes the attached clientSessions as well

Specified by:

removeOfflineUserSession in interface UserSessionProvider

createOfflineClientSession

public AuthenticatedClientSessionModel createOfflineClientSession(AuthenticatedClientSessionModel clientSession,
 UserSessionModel offlineUserSession)

Description copied from interface: UserSessionProvider

Will automatically attach newly created offline client session to the offlineUserSession

Specified by:

createOfflineClientSession in interface UserSessionProvider

getOfflineUserSessionsStream

public Stream<UserSessionModel> getOfflineUserSessionsStream(RealmModel realm,
 UserModel user)

Description copied from interface: UserSessionProvider

Obtains the offline user sessions associated with the specified user.

Specified by:

getOfflineUserSessionsStream in interface UserSessionProvider

Parameters:

realm - a reference to the realm.

user - the user whose offline sessions are being searched.

Returns:

a non-null Stream of offline user sessions.

getOfflineSessionsCount

public long getOfflineSessionsCount(RealmModel realm,
 ClientModel client)

Specified by:

getOfflineSessionsCount in interface UserSessionProvider

getOfflineUserSessionsStream

public Stream<UserSessionModel> getOfflineUserSessionsStream(RealmModel realm,
 ClientModel client,
 Integer first,
 Integer max)

Description copied from interface: UserSessionProvider

Obtains the offline user sessions associated with the specified client, starting from the firstResult and containing at most maxResults.

Specified by:

getOfflineUserSessionsStream in interface UserSessionProvider

Parameters:

realm - a reference to the realm.

client - the client whose user sessions are being searched.

first - first result to return. Ignored if negative or null.

max - maximum number of results to return. Ignored if negative or null.

Returns:

a non-null Stream of offline user sessions.

importUserSessions

public void importUserSessions(Collection<UserSessionModel> persistentUserSessions,
 boolean offline)

Description copied from interface: UserSessionProvider

Triggered by persister during pre-load. It imports authenticatedClientSessions too.

Specified by:

importUserSessions in interface UserSessionProvider

importUserSession

public SessionEntityWrapper<UserSessionEntity> importUserSession(UserSessionModel persistentUserSession,
 boolean offline)

wrapPersistentEntity

public SessionEntityWrapper<UserSessionEntity> wrapPersistentEntity(RealmModel realm,
 boolean offline,
 UserSessionModel persistentUserSession)

createClientSessionUUID

public static UUID createClientSessionUUID(String userSessionId,
 String clientId)

migrate

public void migrate(String modelVersion)

Specified by:

migrate in interface UserSessionProvider

migrateNonPersistentSessionsToPersistentSessions

public void migrateNonPersistentSessionsToPersistentSessions()

Copy over all sessions in Infinispan to the persistent user sessions in the database. This method is public so people can use it to build their custom migrations or re-import sessions when necessary in a future version of Keycloak.