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 org.infinispan.Cache<LoginFailureKey,SessionEntityWrapper<LoginFailureEntity>>	loginFailureCache
protected InfinispanChangelogBasedTransaction<LoginFailureKey,LoginFailureEntity>	loginFailuresTx
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, org.infinispan.Cache<LoginFailureKey,SessionEntityWrapper<LoginFailureEntity>> loginFailureCache)

Method Summary

Modifier and Type	Method and Description
UserLoginFailureModel	addUserLoginFailure(RealmModel realm, String userId)
void	close()
AuthenticatedClientSessionModel	createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession)
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(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)
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, UUID clientSessionId, boolean offline)
protected org.infinispan.Cache<UUID,SessionEntityWrapper<AuthenticatedClientSessionEntity>>	getClientSessionCache(boolean offline)
protected InfinispanChangelogBasedTransaction<UUID,AuthenticatedClientSessionEntity>	getClientSessionTransaction(boolean offline)
protected CrossDCLastSessionRefreshStore	getLastSessionRefreshStore()
protected CrossDCLastSessionRefreshStore	getOfflineLastSessionRefreshStore()
long	getOfflineSessionsCount(RealmModel realm, ClientModel client)
UserSessionAdapter	getOfflineUserSession(RealmModel realm, String userSessionId)
List<UserSessionModel>	getOfflineUserSessions(RealmModel realm, ClientModel client, int first, int max)
List<UserSessionModel>	getOfflineUserSessions(RealmModel realm, UserModel user)
protected PersisterLastSessionRefreshStore	getPersisterLastSessionRefreshStore()
protected InfinispanChangelogBasedTransaction<String,UserSessionEntity>	getTransaction(boolean offline)
UserLoginFailureModel	getUserLoginFailure(RealmModel realm, String userId)
UserSessionModel	getUserSession(RealmModel realm, String id)
protected UserSessionAdapter	getUserSession(RealmModel realm, String id, boolean offline)
UserSessionModel	getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
List<UserSessionModel>	getUserSessionByBrokerUserId(RealmModel realm, String brokerUserId)
protected List<UserSessionModel>	getUserSessionModels(RealmModel realm, int firstResult, int maxResults, boolean offline, UserSessionPredicate predicate)
List<UserSessionModel>	getUserSessions(RealmModel realm, ClientModel client)
List<UserSessionModel>	getUserSessions(RealmModel realm, ClientModel client, int firstResult, int maxResults)
protected List<UserSessionModel>	getUserSessions(RealmModel realm, ClientModel client, int firstResult, int maxResults, boolean offline)
protected List<UserSessionModel>	getUserSessions(RealmModel realm, Predicate<Map.Entry<String,SessionEntityWrapper<UserSessionEntity>>> predicate, boolean offline)
List<UserSessionModel>	getUserSessions(RealmModel realm, UserModel user)
protected long	getUserSessionsCount(RealmModel realm, ClientModel client, boolean offline)
UserSessionModel	getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate) Return userSession of specified ID as long as the predicate passes.
protected UserSessionAdapter	importUserSession(UserSessionModel userSession, boolean offline)
void	importUserSessions(Collection<UserSessionModel> persistentUserSessions, boolean offline) Triggered by persister during pre-load.
void	onClientRemoved(RealmModel realm, ClientModel client)
protected void	onClientRemovedEvent(String realmId, String clientUuid)
void	onRealmRemoved(RealmModel realm)
protected void	onRealmRemovedEvent(String realmId)
protected void	onRemoveAllUserLoginFailuresEvent(String realmId)
protected void	onRemoveUserSessionsEvent(String realmId)
protected void	onUserRemoved(RealmModel realm, UserModel user)
void	removeAllUserLoginFailures(RealmModel realm)
void	removeExpired(RealmModel realm) Implementation doesn't need to propagate removal of expired userSessions to userSessionPersister.
void	removeOfflineUserSession(RealmModel realm, UserSessionModel userSession) Removes the attached clientSessions as well
void	removeUserLoginFailure(RealmModel realm, String userId)
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)

Methods inherited from class java.lang.Object

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

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

loginFailureCache

protected final org.infinispan.Cache<LoginFailureKey,SessionEntityWrapper<LoginFailureEntity>> loginFailureCache

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

loginFailuresTx

protected final InfinispanChangelogBasedTransaction<LoginFailureKey,LoginFailureEntity> loginFailuresTx

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

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,
                                     org.infinispan.Cache<LoginFailureKey,SessionEntityWrapper<LoginFailureEntity>> loginFailureCache)

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

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)

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)

getUserSessions

protected List<UserSessionModel> getUserSessions(RealmModel realm,
                                                 Predicate<Map.Entry<String,SessionEntityWrapper<UserSessionEntity>>> predicate,
                                                 boolean offline)

getClientSession

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

Specified by:

getClientSession in interface UserSessionProvider

getUserSessions

public List<UserSessionModel> getUserSessions(RealmModel realm,
                                              UserModel user)

Specified by:

getUserSessions in interface UserSessionProvider

getUserSessionByBrokerUserId

public List<UserSessionModel> getUserSessionByBrokerUserId(RealmModel realm,
                                                           String brokerUserId)

Specified by:

getUserSessionByBrokerUserId in interface UserSessionProvider

getUserSessionByBrokerSessionId

public UserSessionModel getUserSessionByBrokerSessionId(RealmModel realm,
                                                        String brokerSessionId)

Specified by:

getUserSessionByBrokerSessionId in interface UserSessionProvider

getUserSessions

public List<UserSessionModel> getUserSessions(RealmModel realm,
                                              ClientModel client)

Specified by:

getUserSessions in interface UserSessionProvider

getUserSessions

public List<UserSessionModel> getUserSessions(RealmModel realm,
                                              ClientModel client,
                                              int firstResult,
                                              int maxResults)

Specified by:

getUserSessions in interface UserSessionProvider

getUserSessions

protected List<UserSessionModel> getUserSessions(RealmModel realm,
                                                 ClientModel client,
                                                 int firstResult,
                                                 int maxResults,
                                                 boolean offline)

getUserSessionModels

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

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 have predicate passing (eg. 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)

removeExpired

public void removeExpired(RealmModel realm)

Description copied from interface: UserSessionProvider

Implementation doesn't need to propagate removal of expired userSessions to userSessionPersister. Cleanup on persister will be called separately

Specified by:

removeExpired in interface UserSessionProvider

removeUserSessions

public void removeUserSessions(RealmModel realm)

Specified by:

removeUserSessions in interface UserSessionProvider

onRemoveUserSessionsEvent

protected void onRemoveUserSessionsEvent(String realmId)

getUserLoginFailure

public UserLoginFailureModel getUserLoginFailure(RealmModel realm,
                                                 String userId)

Specified by:

getUserLoginFailure in interface UserSessionProvider

addUserLoginFailure

public UserLoginFailureModel addUserLoginFailure(RealmModel realm,
                                                 String userId)

Specified by:

addUserLoginFailure in interface UserSessionProvider

removeUserLoginFailure

public void removeUserLoginFailure(RealmModel realm,
                                   String userId)

Specified by:

removeUserLoginFailure in interface UserSessionProvider

removeAllUserLoginFailures

public void removeAllUserLoginFailures(RealmModel realm)

Specified by:

removeAllUserLoginFailures in interface UserSessionProvider

onRemoveAllUserLoginFailuresEvent

protected void onRemoveAllUserLoginFailuresEvent(String realmId)

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)

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

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

getOfflineUserSessions

public List<UserSessionModel> getOfflineUserSessions(RealmModel realm,
                                                     UserModel user)

Specified by:

getOfflineUserSessions in interface UserSessionProvider

getOfflineSessionsCount

public long getOfflineSessionsCount(RealmModel realm,
                                    ClientModel client)

Specified by:

getOfflineSessionsCount in interface UserSessionProvider

getOfflineUserSessions

public List<UserSessionModel> getOfflineUserSessions(RealmModel realm,
                                                     ClientModel client,
                                                     int first,
                                                     int max)

Specified by:

getOfflineUserSessions in interface UserSessionProvider

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

protected UserSessionAdapter importUserSession(UserSessionModel userSession,
                                               boolean offline)