Uses of Interface
org.keycloak.models.UserSessionModel

Packages that use UserSessionModel

Package	Description
org.keycloak.models

Uses of UserSessionModel in org.keycloak.models

Methods in org.keycloak.models that return UserSessionModel

Modifier and Type	Method	Description
UserSessionModel	UserSessionProvider.createOfflineUserSession(UserSessionModel userSession)	Newly created userSession won't contain attached AuthenticatedClientSessions
UserSessionModel	UserSessionProvider.createUserSession(String id, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId, UserSessionModel.SessionPersistenceState persistenceState)	Creates a new user session with the given parameters.
default UserSessionModel	UserSessionProvider.createUserSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)	Deprecated. Use UserSessionProvider.createUserSession(String, RealmModel, UserModel, String, String, String, boolean, String, String, UserSessionModel.SessionPersistenceState) instead.
UserSessionModel	UserSessionProvider.getOfflineUserSession(RealmModel realm, String userSessionId)
UserSessionModel	AuthenticatedClientSessionModel.getUserSession()
UserSessionModel	UserSessionProvider.getUserSession(RealmModel realm, String id)
UserSessionModel	UserSessionProvider.getUserSessionByBrokerSessionId(RealmModel realm, String brokerSessionId)
UserSessionModel	UserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)	Return userSession of specified ID as long as the predicate passes.

Methods in org.keycloak.models that return types with arguments of type UserSessionModel

Modifier and Type	Method	Description
Stream<UserSessionModel>	UserSessionProvider.getOfflineUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)	Obtains the offline user sessions associated with the user that matches the specified brokerUserId.
Stream<UserSessionModel>	UserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)	Obtains the offline user sessions associated with the specified client, starting from the firstResult and containing at most maxResults.
Stream<UserSessionModel>	UserSessionProvider.getOfflineUserSessionsStream(RealmModel realm, UserModel user)	Obtains the offline user sessions associated with the specified user.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionByBrokerUserIdStream(RealmModel realm, String brokerUserId)	Obtains the online user sessions associated with the user that matches the specified brokerUserId.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client)	Obtains the online user sessions associated with the specified client.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionsStream(RealmModel realm, ClientModel client, Integer firstResult, Integer maxResults)	Obtains the online user sessions associated with the specified client, starting from the firstResult and containing at most maxResults.
Stream<UserSessionModel>	UserSessionProvider.getUserSessionsStream(RealmModel realm, UserModel user)	Obtains the online user sessions associated with the specified user.

Methods in org.keycloak.models with parameters of type UserSessionModel

Modifier and Type	Method	Description
AuthenticatedClientSessionModel	UserSessionProvider.createClientSession(RealmModel realm, ClientModel client, UserSessionModel userSession)
AuthenticatedClientSessionModel	UserSessionProvider.createOfflineClientSession(AuthenticatedClientSessionModel clientSession, UserSessionModel offlineUserSession)	Will automatically attach newly created offline client session to the offlineUserSession
UserSessionModel	UserSessionProvider.createOfflineUserSession(UserSessionModel userSession)	Newly created userSession won't contain attached AuthenticatedClientSessions
AuthenticatedClientSessionModel	UserSessionProvider.getClientSession(UserSessionModel userSession, ClientModel client, String clientSessionId, boolean offline)
default AuthenticatedClientSessionModel	UserSessionProvider.getClientSession(UserSessionModel userSession, ClientModel client, UUID clientSessionId, boolean offline)	Deprecated. Use UserSessionProvider.getClientSession(UserSessionModel, ClientModel, String, boolean) instead.
void	UserSessionProvider.removeOfflineUserSession(RealmModel realm, UserSessionModel userSession)	Removes the attached clientSessions as well
void	UserSessionProvider.removeUserSession(RealmModel realm, UserSessionModel session)	This will remove attached ClientLoginSessionModels too

Method parameters in org.keycloak.models with type arguments of type UserSessionModel

Modifier and Type	Method	Description
UserSessionModel	UserSessionProvider.getUserSessionWithPredicate(RealmModel realm, String id, boolean offline, Predicate<UserSessionModel> predicate)	Return userSession of specified ID as long as the predicate passes.
void	UserSessionProvider.importUserSessions(Collection<UserSessionModel> persistentUserSessions, boolean offline)	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated as offline session preloading was removed in KC25.