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 org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>>	offlineClientSessionCache
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, 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)
UserSessionModel	createOfflineUserSession(UserSessionModel userSession)
UserSessionModel	createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)
Map<String,Long>	getActiveClientSessionStats(RealmModel realm, boolean offline)
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()
long	getOfflineSessionsCount(RealmModel realm, ClientModel client)
UserSessionAdapter	getOfflineUserSession(RealmModel realm, String userSessionId)
Stream<UserSessionModel>	getOfflineUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)
Stream<UserSessionModel>	getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer first, Integer max)
Stream<UserSessionModel>	getOfflineUserSessionsStream(RealmModel realm, UserModel 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)
protected long	getUserSessionsCount(RealmModel realm, ClientModel client, boolean offline)
Stream<UserSessionModel>	getUserSessionsStream(RealmModel realm, ClientModel client)
Stream<UserSessionModel>	getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer 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)
UserSessionModel	getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)
<T extends SessionEntity, K> Map<K,SessionEntityWrapper<T>>	importSessionsWithExpiration(Map<K,SessionEntityWrapper<T>> sessionsById, org.infinispan.commons.api.BasicCache<K,SessionEntityWrapper<T>> cache, SessionFunction<T> lifespanMsCalculator, SessionFunction<T> maxIdleTimeMsCalculator)
SessionEntityWrapper<UserSessionEntity>	importUserSession(UserSessionModel persistentUserSession, boolean offline)
void	importUserSessions(Collection<UserSessionModel> persistentUserSessions, boolean offline)
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()
void	removeExpired(RealmModel realm)
void	removeLocalUserSessions(String realmId, boolean offline)
void	removeOfflineUserSession(RealmModel realm, UserSessionModel userSession)
void	removeUserSession(RealmModel realm, UserSessionModel session)
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, getUserSessionIfClientExists

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

keyGenerator

protected final InfinispanKeyGenerator keyGenerator

Constructor Details

PersistentUserSessionProvider

public PersistentUserSessionProvider(KeycloakSession session,
 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)

getPersisterLastSessionRefreshStore

public PersisterLastSessionRefreshStore getPersisterLastSessionRefreshStore()

Specified by:

getPersisterLastSessionRefreshStore in interface SessionRefreshStore

getKeycloakSession

public KeycloakSession getKeycloakSession()

Specified by:

getKeycloakSession in interface UserSessionProvider

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)

Specified by:

createUserSession in interface UserSessionProvider

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)

Specified by:

getUserSessionsStream in interface UserSessionProvider

getUserSessionByBrokerUserIdStream

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

Specified by:

getUserSessionByBrokerUserIdStream in interface UserSessionProvider

getUserSessionByBrokerSessionId

public UserSessionModel getUserSessionByBrokerSessionId(RealmModel realm,
 String brokerSessionId)

Specified by:

getUserSessionByBrokerSessionId in interface UserSessionProvider

getUserSessionsStream

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

Specified by:

getUserSessionsStream in interface UserSessionProvider

getUserSessionsStream

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

Specified by:

getUserSessionsStream in interface UserSessionProvider

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)

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)

Specified by:

getActiveClientSessionStats in interface UserSessionProvider

getUserSessionsCount

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

removeUserSession

public void removeUserSession(RealmModel realm,
 UserSessionModel session)

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()

Specified by:

removeAllExpired in interface UserSessionProvider

removeExpired

public void removeExpired(RealmModel realm)

Specified by:

removeExpired in interface UserSessionProvider

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)

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)

Specified by:

getOfflineUserSessionByBrokerUserIdStream in interface UserSessionProvider

removeOfflineUserSession

public void removeOfflineUserSession(RealmModel realm,
 UserSessionModel userSession)

Specified by:

removeOfflineUserSession in interface UserSessionProvider

createOfflineClientSession

public AuthenticatedClientSessionModel createOfflineClientSession(AuthenticatedClientSessionModel clientSession,
 UserSessionModel offlineUserSession)

Specified by:

createOfflineClientSession in interface UserSessionProvider

getOfflineUserSessionsStream

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

Specified by:

getOfflineUserSessionsStream in interface UserSessionProvider

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)

Specified by:

getOfflineUserSessionsStream in interface UserSessionProvider

importUserSessions

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

Specified by:

importUserSessions in interface UserSessionProvider

importUserSession

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

importSessionsWithExpiration

public <T extends SessionEntity,
K>
Map<K,SessionEntityWrapper<T>> importSessionsWithExpiration(Map<K,SessionEntityWrapper<T>> sessionsById,
 org.infinispan.commons.api.BasicCache<K,SessionEntityWrapper<T>> cache,
 SessionFunction<T> lifespanMsCalculator,
 SessionFunction<T> maxIdleTimeMsCalculator)

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.