org.keycloak.models

Interface UserSessionProvider

All Superinterfaces:

Provider

public interface UserSessionProvider
extends Provider

Version:

$Revision: 1 $

Author:

Bill Burke

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)
AuthenticatedClientSessionModel	getClientSession(UserSessionModel userSession, ClientModel client, UUID clientSessionId, boolean offline)
long	getOfflineSessionsCount(RealmModel realm, ClientModel client)
UserSessionModel	getOfflineUserSession(RealmModel realm, String userSessionId)
List<UserSessionModel>	getOfflineUserSessions(RealmModel realm, ClientModel client, int first, int max)
List<UserSessionModel>	getOfflineUserSessions(RealmModel realm, UserModel user)
UserLoginFailureModel	getUserLoginFailure(RealmModel realm, String userId)
UserSessionModel	getUserSession(RealmModel realm, String id)
UserSessionModel	getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
List<UserSessionModel>	getUserSessionByBrokerUserId(RealmModel realm, String brokerUserId)
List<UserSessionModel>	getUserSessions(RealmModel realm, ClientModel client)
List<UserSessionModel>	getUserSessions(RealmModel realm, ClientModel client, int firstResult, int maxResults)
List<UserSessionModel>	getUserSessions(RealmModel realm, UserModel 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	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
void	removeUserSessions(RealmModel realm)
void	removeUserSessions(RealmModel realm, UserModel user)

Method Detail

createClientSession

AuthenticatedClientSessionModel createClientSession(RealmModel realm,
                                                    ClientModel client,
                                                    UserSessionModel userSession)

getClientSession

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

createUserSession

UserSessionModel createUserSession(RealmModel realm,
                                   UserModel user,
                                   String loginUsername,
                                   String ipAddress,
                                   String authMethod,
                                   boolean rememberMe,
                                   String brokerSessionId,
                                   String brokerUserId)

createUserSession

UserSessionModel createUserSession(String id,
                                   RealmModel realm,
                                   UserModel user,
                                   String loginUsername,
                                   String ipAddress,
                                   String authMethod,
                                   boolean rememberMe,
                                   String brokerSessionId,
                                   String brokerUserId)

getUserSession

UserSessionModel getUserSession(RealmModel realm,
                                String id)

getUserSessions

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

getUserSessions

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

getUserSessions

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

getUserSessionByBrokerUserId

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

getUserSessionByBrokerSessionId

UserSessionModel getUserSessionByBrokerSessionId(RealmModel realm,
                                                 String brokerSessionId)

getUserSessionWithPredicate

UserSessionModel getUserSessionWithPredicate(RealmModel realm,
                                             String id,
                                             boolean offline,
                                             Predicate<UserSessionModel> predicate)

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)

getActiveUserSessions

long getActiveUserSessions(RealmModel realm,
                           ClientModel client)

getActiveClientSessionStats

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

Returns a summary of client sessions key is client.getId()

Parameters:

realm -

offline -

Returns:

removeUserSession

void removeUserSession(RealmModel realm,
                       UserSessionModel session)

This will remove attached ClientLoginSessionModels too

removeUserSessions

void removeUserSessions(RealmModel realm,
                        UserModel user)

removeExpired

void removeExpired(RealmModel realm)

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

removeUserSessions

void removeUserSessions(RealmModel realm)

getUserLoginFailure

UserLoginFailureModel getUserLoginFailure(RealmModel realm,
                                          String userId)

addUserLoginFailure

UserLoginFailureModel addUserLoginFailure(RealmModel realm,
                                          String userId)

removeUserLoginFailure

void removeUserLoginFailure(RealmModel realm,
                            String userId)

removeAllUserLoginFailures

void removeAllUserLoginFailures(RealmModel realm)

onRealmRemoved

void onRealmRemoved(RealmModel realm)

onClientRemoved

void onClientRemoved(RealmModel realm,
                     ClientModel client)

createOfflineUserSession

UserSessionModel createOfflineUserSession(UserSessionModel userSession)

Newly created userSession won't contain attached AuthenticatedClientSessions

getOfflineUserSession

UserSessionModel getOfflineUserSession(RealmModel realm,
                                       String userSessionId)

removeOfflineUserSession

void removeOfflineUserSession(RealmModel realm,
                              UserSessionModel userSession)

Removes the attached clientSessions as well

createOfflineClientSession

AuthenticatedClientSessionModel createOfflineClientSession(AuthenticatedClientSessionModel clientSession,
                                                           UserSessionModel offlineUserSession)

Will automatically attach newly created offline client session to the offlineUserSession

getOfflineUserSessions

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

getOfflineSessionsCount

long getOfflineSessionsCount(RealmModel realm,
                             ClientModel client)

getOfflineUserSessions

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

importUserSessions

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

Triggered by persister during pre-load. It imports authenticatedClientSessions too

close

void close()

Specified by:

close in interface Provider