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 and Description
JpaUserSessionPersisterProvider(KeycloakSession session, javax.persistence.EntityManager em)

Method Summary

Modifier and Type	Method and Description
void	close()
void	createClientSession(AuthenticatedClientSessionModel clientSession, boolean offline)
void	createUserSession(UserSessionModel userSession, boolean offline)
int	getUserSessionsCount(boolean offline)
Stream<UserSessionModel>	loadUserSessionsStream(Integer firstResult, Integer maxResults, boolean offline, Integer lastCreatedOn, String lastUserSessionId) Called during startup.
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	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

Methods inherited from interface org.keycloak.models.session.UserSessionPersisterProvider

loadUserSessions

Constructor Detail

JpaUserSessionPersisterProvider

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

Method Detail

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

loadUserSessionsStream

public Stream<UserSessionModel> loadUserSessionsStream(Integer firstResult,
                                                       Integer maxResults,
                                                       boolean offline,
                                                       Integer lastCreatedOn,
                                                       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.

lastCreatedOn - Integer Timestamp when the user session was created. It will return only user sessions created later.

lastUserSessionId - String Id of the user session. In case of equal lastCreatedOn it will compare the id in dictionary order and takes only those created later.

Returns:

Stream of UserSessionModel. Never returns null.

getUserSessionsCount

public int getUserSessionsCount(boolean offline)

Specified by:

getUserSessionsCount in interface UserSessionPersisterProvider

close

public void close()

Specified by:

close in interface Provider