org.keycloak.models.map.userSession

Class MapUserSessionProvider<UK,CK>

java.lang.Object

org.keycloak.models.map.userSession.MapUserSessionProvider<UK,CK>

All Implemented Interfaces:

UserSessionProvider, Provider

public class MapUserSessionProvider<UK,CK>
extends Object
implements UserSessionProvider

Author:

Martin Kanis

Field Summary

Fields

Modifier and Type	Field and Description
protected MapKeycloakTransaction<CK,MapAuthenticatedClientSessionEntity<CK>,AuthenticatedClientSessionModel>	clientSessionTx
protected MapKeycloakTransaction<UK,MapUserSessionEntity<UK>,UserSessionModel>	userSessionTx

Constructor Summary

Constructors

Constructor and Description
MapUserSessionProvider(KeycloakSession session, MapStorage<UK,MapUserSessionEntity<UK>,UserSessionModel> userSessionStore, MapStorage<CK,MapAuthenticatedClientSessionEntity<CK>,AuthenticatedClientSessionModel> clientSessionStore)

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)
AuthenticatedClientSessionModel	getClientSession(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline)
KeycloakSession	getKeycloakSession()
long	getOfflineSessionsCount(RealmModel realm, ClientModel client)
UserSessionModel	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 firstResult, Integer maxResults)
Stream<UserSessionModel>	getOfflineUserSessionsStream(RealmModel realm, UserModel user)
UserSessionModel	getUserSession(RealmModel realm, String id)
UserSessionModel	getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
Stream<UserSessionModel>	getUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)
Stream<UserSessionModel>	getUserSessionsStream(RealmModel realm, ClientModel client)
Stream<UserSessionModel>	getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)
Stream<UserSessionModel>	getUserSessionsStream(RealmModel realm, UserModel user)
UserSessionModel	getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)
void	importUserSessions(Collection<UserSessionModel> persistentUserSessions, boolean offline)
void	onClientRemoved(RealmModel realm, ClientModel client)
void	onRealmRemoved(RealmModel realm)
void	removeAllExpired()
void	removeExpired(RealmModel realm)
void	removeOfflineUserSession(RealmModel realm, UserSessionModel userSession)
void	removeUserSession(RealmModel realm, UserSessionModel session)
void	removeUserSessions(RealmModel realm)
void	removeUserSessions(RealmModel realm, UserModel user)

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, getClientSession, getOfflineUserSessionByBrokerUserId, getOfflineUserSessions, getOfflineUserSessions, getUserLoginFailure, getUserSessionByBrokerUserId, getUserSessions, getUserSessions, getUserSessions, removeAllUserLoginFailures, removeUserLoginFailure

Field Detail

userSessionTx

protected final MapKeycloakTransaction<UK,MapUserSessionEntity<UK>,UserSessionModel> userSessionTx

clientSessionTx

protected final MapKeycloakTransaction<CK,MapAuthenticatedClientSessionEntity<CK>,AuthenticatedClientSessionModel> clientSessionTx

Constructor Detail

MapUserSessionProvider

public MapUserSessionProvider(KeycloakSession session,
                              MapStorage<UK,MapUserSessionEntity<UK>,UserSessionModel> userSessionStore,
                              MapStorage<CK,MapAuthenticatedClientSessionEntity<CK>,AuthenticatedClientSessionModel> clientSessionStore)

Method Detail

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

getClientSession

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

Specified by:

getClientSession 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

getUserSessionsStream

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

Specified by:

getUserSessionsStream 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

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

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

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

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

onRealmRemoved

public void onRealmRemoved(RealmModel realm)

Specified by:

onRealmRemoved in interface UserSessionProvider

onClientRemoved

public void onClientRemoved(RealmModel realm,
                            ClientModel client)

Specified by:

onClientRemoved in interface UserSessionProvider

createOfflineUserSession

public UserSessionModel createOfflineUserSession(UserSessionModel userSession)

Specified by:

createOfflineUserSession in interface UserSessionProvider

getOfflineUserSession

public UserSessionModel getOfflineUserSession(RealmModel realm,
                                              String userSessionId)

Specified by:

getOfflineUserSession 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

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

getOfflineSessionsCount

public long getOfflineSessionsCount(RealmModel realm,
                                    ClientModel client)

Specified by:

getOfflineSessionsCount in interface UserSessionProvider

getOfflineUserSessionsStream

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

Specified by:

getOfflineUserSessionsStream in interface UserSessionProvider

importUserSessions

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

Specified by:

importUserSessions in interface UserSessionProvider

close

public void close()

Specified by:

close in interface UserSessionProvider

Specified by:

close in interface Provider