Class MapUserSessionProvider
- java.lang.Object
-
- org.keycloak.models.map.userSession.MapUserSessionProvider
-
- All Implemented Interfaces:
UserSessionProvider
,Provider
public class MapUserSessionProvider extends Object implements UserSessionProvider
- Author:
- Martin Kanis
-
-
Field Summary
Fields Modifier and Type Field Description protected MapKeycloakTransaction<MapUserSessionEntity,UserSessionModel>
userSessionTx
-
Constructor Summary
Constructors Constructor Description MapUserSessionProvider(KeycloakSession session, MapStorage<MapUserSessionEntity,UserSessionModel> userSessionStore)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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 offlineUserSessionUserSessionModel
createOfflineUserSession(UserSessionModel userSession)
Newly created userSession won't contain attached AuthenticatedClientSessionsUserSessionModel
createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)
UserSessionModel
createUserSession(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)
AuthenticatedClientSessionModel
getClientSession(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline)
KeycloakSession
getKeycloakSession()
Returns currently used Keycloak session.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)
Obtains the offline user sessions associated with the user that matches the specifiedbrokerUserId
.Stream<UserSessionModel>
getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)
Obtains the offline user sessions associated with the specified client, starting from thefirstResult
and containing at mostmaxResults
.Stream<UserSessionModel>
getOfflineUserSessionsStream(RealmModel realm, UserModel user)
Obtains the offline user sessions associated with the specified user.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 specifiedbrokerUserId
.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 thefirstResult
and containing at mostmaxResults
.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.void
importUserSessions(Collection<UserSessionModel> persistentUserSessions, boolean offline)
Triggered by persister during pre-load.void
onClientRemoved(RealmModel realm, ClientModel client)
void
onRealmRemoved(RealmModel realm)
void
removeAllExpired()
Remove expired user sessions and client sessions in all the realmsprotected void
removeAllUserSessions(RealmModel realm)
Removes all online and offline user sessions that belong to the providedRealmModel
.void
removeExpired(RealmModel realm)
Removes expired user sessions owned by this realm from this provider.void
removeOfflineUserSession(RealmModel realm, UserSessionModel userSession)
Removes the attached clientSessions as wellvoid
removeUserSession(RealmModel realm, UserSessionModel session)
This will remove attached ClientLoginSessionModels toovoid
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
getClientSession
-
-
-
-
Field Detail
-
userSessionTx
protected final MapKeycloakTransaction<MapUserSessionEntity,UserSessionModel> userSessionTx
-
-
Constructor Detail
-
MapUserSessionProvider
public MapUserSessionProvider(KeycloakSession session, MapStorage<MapUserSessionEntity,UserSessionModel> userSessionStore)
-
-
Method Detail
-
getKeycloakSession
public KeycloakSession getKeycloakSession()
Description copied from interface:UserSessionProvider
Returns currently used Keycloak session.- Specified by:
getKeycloakSession
in interfaceUserSessionProvider
- Returns:
KeycloakSession
-
createClientSession
public AuthenticatedClientSessionModel createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession)
- Specified by:
createClientSession
in interfaceUserSessionProvider
-
getClientSession
public AuthenticatedClientSessionModel getClientSession(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline)
- Specified by:
getClientSession
in interfaceUserSessionProvider
-
createUserSession
public UserSessionModel createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
- Specified by:
createUserSession
in interfaceUserSessionProvider
-
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 interfaceUserSessionProvider
-
getUserSession
public UserSessionModel getUserSession(RealmModel realm, String id)
- Specified by:
getUserSession
in interfaceUserSessionProvider
-
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 interfaceUserSessionProvider
- Parameters:
realm
- a reference to the realm.user
- the user whose sessions are being searched.- Returns:
- a non-null
Stream
of online user sessions.
-
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 interfaceUserSessionProvider
- 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 thefirstResult
and containing at mostmaxResults
.- Specified by:
getUserSessionsStream
in interfaceUserSessionProvider
- Parameters:
realm
- a reference tot he realm.client
- the client whose user sessions are being searched.firstResult
- first result to return. Ignored if negative ornull
.maxResults
- maximum number of results to return. Ignored if negative ornull
.- 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 specifiedbrokerUserId
.- Specified by:
getUserSessionByBrokerUserIdStream
in interfaceUserSessionProvider
- 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 interfaceUserSessionProvider
-
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 returnsnull
. 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 interfaceUserSessionProvider
-
getActiveUserSessions
public long getActiveUserSessions(RealmModel realm, ClientModel client)
- Specified by:
getActiveUserSessions
in interfaceUserSessionProvider
-
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 interfaceUserSessionProvider
- Returns:
-
removeUserSession
public void removeUserSession(RealmModel realm, UserSessionModel session)
Description copied from interface:UserSessionProvider
This will remove attached ClientLoginSessionModels too- Specified by:
removeUserSession
in interfaceUserSessionProvider
-
removeUserSessions
public void removeUserSessions(RealmModel realm, UserModel user)
- Specified by:
removeUserSessions
in interfaceUserSessionProvider
-
removeAllExpired
public void removeAllExpired()
Description copied from interface:UserSessionProvider
Remove expired user sessions and client sessions in all the realms- Specified by:
removeAllExpired
in interfaceUserSessionProvider
-
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 expireduser sessions
is also propagated to relevant `UserSessionPersister`.- Specified by:
removeExpired
in interfaceUserSessionProvider
- Parameters:
realm
-RealmModel
Realm where all the expired user sessions to be removed from.
-
removeUserSessions
public void removeUserSessions(RealmModel realm)
- Specified by:
removeUserSessions
in interfaceUserSessionProvider
-
onRealmRemoved
public void onRealmRemoved(RealmModel realm)
- Specified by:
onRealmRemoved
in interfaceUserSessionProvider
-
onClientRemoved
public void onClientRemoved(RealmModel realm, ClientModel client)
- Specified by:
onClientRemoved
in interfaceUserSessionProvider
-
createOfflineUserSession
public UserSessionModel createOfflineUserSession(UserSessionModel userSession)
Description copied from interface:UserSessionProvider
Newly created userSession won't contain attached AuthenticatedClientSessions- Specified by:
createOfflineUserSession
in interfaceUserSessionProvider
-
getOfflineUserSession
public UserSessionModel getOfflineUserSession(RealmModel realm, String userSessionId)
- Specified by:
getOfflineUserSession
in interfaceUserSessionProvider
-
removeOfflineUserSession
public void removeOfflineUserSession(RealmModel realm, UserSessionModel userSession)
Description copied from interface:UserSessionProvider
Removes the attached clientSessions as well- Specified by:
removeOfflineUserSession
in interfaceUserSessionProvider
-
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 interfaceUserSessionProvider
-
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 interfaceUserSessionProvider
- 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.
-
getOfflineUserSessionByBrokerSessionId
public UserSessionModel getOfflineUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
- Specified by:
getOfflineUserSessionByBrokerSessionId
in interfaceUserSessionProvider
-
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 specifiedbrokerUserId
.- Specified by:
getOfflineUserSessionByBrokerUserIdStream
in interfaceUserSessionProvider
- 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.
-
getOfflineSessionsCount
public long getOfflineSessionsCount(RealmModel realm, ClientModel client)
- Specified by:
getOfflineSessionsCount
in interfaceUserSessionProvider
-
getOfflineUserSessionsStream
public Stream<UserSessionModel> getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)
Description copied from interface:UserSessionProvider
Obtains the offline user sessions associated with the specified client, starting from thefirstResult
and containing at mostmaxResults
.- Specified by:
getOfflineUserSessionsStream
in interfaceUserSessionProvider
- Parameters:
realm
- a reference tot he realm.client
- the client whose user sessions are being searched.firstResult
- first result to return. Ignored if negative ornull
.maxResults
- maximum number of results to return. Ignored if negative ornull
.- 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 interfaceUserSessionProvider
-
close
public void close()
- Specified by:
close
in interfaceProvider
- Specified by:
close
in interfaceUserSessionProvider
-
getStartupTime
public int getStartupTime(RealmModel realm)
- Specified by:
getStartupTime
in interfaceUserSessionProvider
-
removeAllUserSessions
protected void removeAllUserSessions(RealmModel realm)
Removes all online and offline user sessions that belong to the providedRealmModel
.- Parameters:
realm
-
-
-