Package org.keycloak.models.jpa.session

Class JpaUserSessionPersisterProvider

java.lang.Object

org.keycloak.models.jpa.session.JpaUserSessionPersisterProvider

All Implemented Interfaces:

UserSessionPersisterProvider, Provider

public class JpaUserSessionPersisterProvider
extends Object
implements UserSessionPersisterProvider

Author:

Marek Posolda

Constructor Summary

Constructors

Constructor	Description
JpaUserSessionPersisterProvider(KeycloakSession session, jakarta.persistence.EntityManager em)

Method Summary

Modifier and Type	Method	Description
void	close()
void	createClientSession(AuthenticatedClientSessionModel clientSession, boolean offline)
void	createUserSession(UserSessionModel userSession, boolean offline)
int	getUserSessionsCount(boolean offline)	Retrieves the count of user sessions for all realms.
int	getUserSessionsCount(RealmModel realm, ClientModel clientModel, boolean offline)	Retrieves the count of user client-sessions for the given client
Map<String,Long>	getUserSessionsCountsByClients(RealmModel realm, boolean offline)	Returns a Map containing the number of user-sessions aggregated by client id for the given realm.
AuthenticatedClientSessionModel	loadClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession, boolean offline)	Loads client session from the db by provided user session and client.
UserSessionModel	loadUserSession(RealmModel realm, String userSessionId, boolean offline)	Loads the user session with the given userSessionId.
Stream<UserSessionModel>	loadUserSessionsStream(Integer firstResult, Integer maxResults, boolean offline, String lastUserSessionId)	Called during startup.
Stream<UserSessionModel>	loadUserSessionsStream(RealmModel realm, ClientModel client, boolean offline, Integer firstResult, Integer maxResults)	Loads the user sessions for the given ClientModel in the given RealmModel if present.
Stream<UserSessionModel>	loadUserSessionsStream(RealmModel realm, UserModel user, boolean offline, Integer firstResult, Integer maxResults)	Loads the user sessions for the given UserModel in the given RealmModel if present.
UserSessionModel	loadUserSessionsStreamByBrokerSessionId(RealmModel realm, String brokerSessionId, boolean offline)
void	onClientRemoved(RealmModel realm, ClientModel client)
void	onRealmRemoved(RealmModel realm)
void	onUserRemoved(RealmModel realm, UserModel user)
void	removeClientSession(String userSessionId, String clientUUID, boolean offline)
void	removeExpired(RealmModel realm)
void	removeUserSession(String userSessionId, boolean offline)
void	removeUserSessions(RealmModel realm)	Removes all user sessions from the specified realm.
void	removeUserSessions(RealmModel realm, boolean offline)	Remove the online user sessions for this realm.
void	updateLastSessionRefreshes(RealmModel realm, int lastSessionRefresh, Collection<String> userSessionIds, boolean offline)

Methods inherited from class java.lang.Object

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

Constructor Details

JpaUserSessionPersisterProvider

public JpaUserSessionPersisterProvider(KeycloakSession session,
 jakarta.persistence.EntityManager em)

Method Details

createUserSession

public void createUserSession(UserSessionModel userSession,
 boolean offline)

Specified by:

createUserSession in interface UserSessionPersisterProvider

createClientSession

public void createClientSession(AuthenticatedClientSessionModel clientSession,
 boolean offline)

Specified by:

createClientSession in interface UserSessionPersisterProvider

removeUserSession

public void removeUserSession(String userSessionId,
 boolean offline)

Specified by:

removeUserSession in interface UserSessionPersisterProvider

removeClientSession

public void removeClientSession(String userSessionId,
 String clientUUID,
 boolean offline)

Specified by:

removeClientSession in interface UserSessionPersisterProvider

onRealmRemoved

public void onRealmRemoved(RealmModel realm)

Specified by:

onRealmRemoved in interface UserSessionPersisterProvider

onClientRemoved

public void onClientRemoved(RealmModel realm,
 ClientModel client)

Specified by:

onClientRemoved in interface UserSessionPersisterProvider

onUserRemoved

public void onUserRemoved(RealmModel realm,
 UserModel user)

Specified by:

onUserRemoved in interface UserSessionPersisterProvider

updateLastSessionRefreshes

public void updateLastSessionRefreshes(RealmModel realm,
 int lastSessionRefresh,
 Collection<String> userSessionIds,
 boolean offline)

Specified by:

updateLastSessionRefreshes in interface UserSessionPersisterProvider

removeExpired

public void removeExpired(RealmModel realm)

Specified by:

removeExpired in interface UserSessionPersisterProvider

getUserSessionsCountsByClients

public Map<String,Long> getUserSessionsCountsByClients(RealmModel realm,
 boolean offline)

Description copied from interface: UserSessionPersisterProvider

Returns a Map containing the number of user-sessions aggregated by client id for the given realm.

Specified by:

getUserSessionsCountsByClients in interface UserSessionPersisterProvider

Returns:

the count Map with clientId as key and session count as value

loadUserSession

public UserSessionModel loadUserSession(RealmModel realm,
 String userSessionId,
 boolean offline)

Description copied from interface: UserSessionPersisterProvider

Loads the user session with the given userSessionId.

Specified by:

loadUserSession in interface UserSessionPersisterProvider

Returns:

loadUserSessionsStreamByBrokerSessionId

public UserSessionModel loadUserSessionsStreamByBrokerSessionId(RealmModel realm,
 String brokerSessionId,
 boolean offline)

Specified by:

loadUserSessionsStreamByBrokerSessionId in interface UserSessionPersisterProvider

loadUserSessionsStream

public Stream<UserSessionModel> loadUserSessionsStream(RealmModel realm,
 ClientModel client,
 boolean offline,
 Integer firstResult,
 Integer maxResults)

Description copied from interface: UserSessionPersisterProvider

Loads the user sessions for the given ClientModel in the given RealmModel if present.

Specified by:

loadUserSessionsStream in interface UserSessionPersisterProvider

Returns:

loadUserSessionsStream

public Stream<UserSessionModel> loadUserSessionsStream(RealmModel realm,
 UserModel user,
 boolean offline,
 Integer firstResult,
 Integer maxResults)

Description copied from interface: UserSessionPersisterProvider

Loads the user sessions for the given UserModel in the given RealmModel if present.

Specified by:

loadUserSessionsStream in interface UserSessionPersisterProvider

Returns:

loadUserSessionsStream

public Stream<UserSessionModel> loadUserSessionsStream(Integer firstResult,
 Integer maxResults,
 boolean offline,
 String lastUserSessionId)

Description copied from interface: UserSessionPersisterProvider

Called during startup. For each userSession, it loads also clientSessions.

Specified by:

loadUserSessionsStream in interface UserSessionPersisterProvider

Parameters:

firstResult - Integer Index of the first desired user session. Ignored if negative or null.

maxResults - Integer Maximum number of returned user sessions. Ignored if negative or null.

offline - boolean Flag to include offline sessions.

lastUserSessionId - String Id of the user session. It will return only user sessions with id's lexicographically greater than this. it will compare the id in dictionary order and takes only those created later.

Returns:

Stream of UserSessionModel. Never returns null.

loadClientSession

public AuthenticatedClientSessionModel loadClientSession(RealmModel realm,
 ClientModel client,
 UserSessionModel userSession,
 boolean offline)

Description copied from interface: UserSessionPersisterProvider

Loads client session from the db by provided user session and client.

Specified by:

loadClientSession in interface UserSessionPersisterProvider

Parameters:

realm - RealmModel Realm for the associated client session.

client - ClientModel Client used for the creation of client session.

userSession - UserSessionModel User session for the associated client session.

offline - boolean Flag that indicates the client session should be online/offline.

Returns:

Client session according the provided criteria or null if not found.

getUserSessionsCount

public int getUserSessionsCount(boolean offline)

Description copied from interface: UserSessionPersisterProvider

Retrieves the count of user sessions for all realms.

Specified by:

getUserSessionsCount in interface UserSessionPersisterProvider

Returns:

getUserSessionsCount

public int getUserSessionsCount(RealmModel realm,
 ClientModel clientModel,
 boolean offline)

Description copied from interface: UserSessionPersisterProvider

Retrieves the count of user client-sessions for the given client

Specified by:

getUserSessionsCount in interface UserSessionPersisterProvider

Returns:

removeUserSessions

public void removeUserSessions(RealmModel realm,
 boolean offline)

Description copied from interface: UserSessionPersisterProvider

Remove the online user sessions for this realm.

Specified by:

removeUserSessions in interface UserSessionPersisterProvider

removeUserSessions

public void removeUserSessions(RealmModel realm)

Description copied from interface: UserSessionPersisterProvider

Removes all user sessions from the specified realm.

Specified by:

removeUserSessions in interface UserSessionPersisterProvider

close

public void close()

Specified by:

close in interface Provider