org.keycloak.models.sessions.infinispan

Class InfinispanUserSessionProvider

java.lang.Object

org.keycloak.models.sessions.infinispan.InfinispanUserSessionProvider

All Implemented Interfaces:

UserSessionProvider, Provider

public class InfinispanUserSessionProvider
extends Object
implements UserSessionProvider

Author:

Stian Thorgersen

Field Summary

Fields

Modifier and Type	Field and Description
protected org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>>	clientSessionCache
protected InfinispanChangelogBasedTransaction<UUID,AuthenticatedClientSessionEntity>	clientSessionTx
protected SessionEventsSenderTransaction	clusterEventsSenderTx
protected InfinispanKeyGenerator	keyGenerator
protected CrossDCLastSessionRefreshStore	lastSessionRefreshStore
protected boolean	loadOfflineSessionsStatsFromDatabase
protected org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>>	offlineClientSessionCache
protected InfinispanChangelogBasedTransaction<UUID,AuthenticatedClientSessionEntity>	offlineClientSessionTx
protected CrossDCLastSessionRefreshStore	offlineLastSessionRefreshStore
protected org.infinispan.Cache<String,SessionEntityWrapper<UserSessionEntity>>	offlineSessionCache
protected InfinispanChangelogBasedTransaction<String,UserSessionEntity>	offlineSessionTx
protected PersisterLastSessionRefreshStore	persisterLastSessionRefreshStore
protected RemoteCacheInvoker	remoteCacheInvoker
protected KeycloakSession	session
protected org.infinispan.Cache<String,SessionEntityWrapper<UserSessionEntity>>	sessionCache
protected InfinispanChangelogBasedTransaction<String,UserSessionEntity>	sessionTx

Constructor Summary

Constructors

Constructor and Description

InfinispanUserSessionProvider(KeycloakSession session, RemoteCacheInvoker remoteCacheInvoker, CrossDCLastSessionRefreshStore lastSessionRefreshStore, CrossDCLastSessionRefreshStore offlineLastSessionRefreshStore, PersisterLastSessionRefreshStore persisterLastSessionRefreshStore, 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, boolean loadOfflineSessionsStatsFromDatabase)

Method Summary

Modifier and Type	Method and Description
void	close()
AuthenticatedClientSessionModel	createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession)
AuthenticatedClientSessionModel	createOfflineClientSession(AuthenticatedClientSessionModel clientSession, UserSessionModel offlineUserSession)
UserSessionModel	createOfflineUserSession(UserSessionModel userSession)
UserSessionModel	createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
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)
AuthenticatedClientSessionAdapter	getClientSession(UserSessionModel userSession, ClientModel client, UUID clientSessionId, boolean offline)
protected org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>>	getClientSessionCache(boolean offline)
protected InfinispanChangelogBasedTransaction<UUID,AuthenticatedClientSessionEntity>	getClientSessionTransaction(boolean offline)
KeycloakSession	getKeycloakSession()
protected CrossDCLastSessionRefreshStore	getLastSessionRefreshStore()
protected CrossDCLastSessionRefreshStore	getOfflineLastSessionRefreshStore()
long	getOfflineSessionsCount(RealmModel realm, ClientModel client)
UserSessionAdapter	getOfflineUserSession(RealmModel realm, String userSessionId)
UserSessionModel	getOfflineUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
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)
protected PersisterLastSessionRefreshStore	getPersisterLastSessionRefreshStore()
protected InfinispanChangelogBasedTransaction<String,UserSessionEntity>	getTransaction(boolean offline)
UserSessionModel	getUserSession(RealmModel realm, String id)
protected UserSessionAdapter	getUserSession(RealmModel realm, String id, boolean offline)
UserSessionModel	getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
Stream<UserSessionModel>	getUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)
protected Stream<UserSessionModel>	getUserSessionModels(RealmModel realm, Integer firstResult, Integer maxResults, boolean offline, UserSessionPredicate predicate)
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)
Stream<UserSessionModel>	getUserSessionsStream(RealmModel realm, UserModel user)
protected Stream<UserSessionModel>	getUserSessionsStream(RealmModel realm, UserSessionPredicate predicate, boolean offline)
UserSessionModel	getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)
protected UserSessionAdapter	importUserSession(UserSessionModel userSession, boolean offline)
void	importUserSessions(Collection<UserSessionModel> persistentUserSessions, boolean offline)
void	onClientRemoved(RealmModel realm, ClientModel client)
protected void	onClientRemovedEvent(String realmId, String clientUuid)
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)

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

addUserLoginFailure, getOfflineUserSessionByBrokerUserId, getOfflineUserSessions, getOfflineUserSessions, getUserLoginFailure, getUserSessionByBrokerUserId, getUserSessions, getUserSessions, getUserSessions, removeAllUserLoginFailures, removeUserLoginFailure

Field Detail

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 InfinispanChangelogBasedTransaction<String,UserSessionEntity> sessionTx

offlineSessionTx

protected final InfinispanChangelogBasedTransaction<String,UserSessionEntity> offlineSessionTx

clientSessionTx

protected final InfinispanChangelogBasedTransaction<UUID,AuthenticatedClientSessionEntity> clientSessionTx

offlineClientSessionTx

protected final InfinispanChangelogBasedTransaction<UUID,AuthenticatedClientSessionEntity> offlineClientSessionTx

clusterEventsSenderTx

protected final SessionEventsSenderTransaction clusterEventsSenderTx

lastSessionRefreshStore

protected final CrossDCLastSessionRefreshStore lastSessionRefreshStore

offlineLastSessionRefreshStore

protected final CrossDCLastSessionRefreshStore offlineLastSessionRefreshStore

persisterLastSessionRefreshStore

protected final PersisterLastSessionRefreshStore persisterLastSessionRefreshStore

remoteCacheInvoker

protected final RemoteCacheInvoker remoteCacheInvoker

keyGenerator

protected final InfinispanKeyGenerator keyGenerator

loadOfflineSessionsStatsFromDatabase

protected final boolean loadOfflineSessionsStatsFromDatabase

Constructor Detail

InfinispanUserSessionProvider

public InfinispanUserSessionProvider(KeycloakSession session,
                                     RemoteCacheInvoker remoteCacheInvoker,
                                     CrossDCLastSessionRefreshStore lastSessionRefreshStore,
                                     CrossDCLastSessionRefreshStore offlineLastSessionRefreshStore,
                                     PersisterLastSessionRefreshStore persisterLastSessionRefreshStore,
                                     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,
                                     boolean loadOfflineSessionsStatsFromDatabase)

Method Detail

getCache

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

getTransaction

protected InfinispanChangelogBasedTransaction<String,UserSessionEntity> getTransaction(boolean offline)

getClientSessionCache

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

getClientSessionTransaction

protected InfinispanChangelogBasedTransaction<UUID,AuthenticatedClientSessionEntity> getClientSessionTransaction(boolean offline)

getLastSessionRefreshStore

protected CrossDCLastSessionRefreshStore getLastSessionRefreshStore()

getOfflineLastSessionRefreshStore

protected CrossDCLastSessionRefreshStore getOfflineLastSessionRefreshStore()

getPersisterLastSessionRefreshStore

protected PersisterLastSessionRefreshStore getPersisterLastSessionRefreshStore()

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(RealmModel realm,
                                          UserModel user,
                                          String loginUsername,
                                          String ipAddress,
                                          String authMethod,
                                          boolean rememberMe,
                                          String brokerSessionId,
                                          String brokerUserId)

Specified by:

createUserSession 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

getUserSession

protected UserSessionAdapter getUserSession(RealmModel realm,
                                            String id,
                                            boolean offline)

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

getClientSession

public AuthenticatedClientSessionAdapter getClientSession(UserSessionModel userSession,
                                                          ClientModel client,
                                                          UUID 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)

getUserSessionModels

protected Stream<UserSessionModel> getUserSessionModels(RealmModel realm,
                                                        Integer firstResult,
                                                        Integer maxResults,
                                                        boolean offline,
                                                        UserSessionPredicate predicate)

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

onClientRemovedEvent

protected void onClientRemovedEvent(String realmId,
                                    String clientUuid)

onUserRemoved

protected void onUserRemoved(RealmModel realm,
                             UserModel user)

close

public void close()

Specified by:

close in interface UserSessionProvider

Specified by:

close in interface Provider

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

getOfflineUserSessionByBrokerSessionId

public UserSessionModel getOfflineUserSessionByBrokerSessionId(RealmModel realm,
                                                               String brokerSessionId)

Specified by:

getOfflineUserSessionByBrokerSessionId 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

protected UserSessionAdapter importUserSession(UserSessionModel userSession,
                                               boolean offline)