keycloak
公開メンバ関数 | 全メンバ一覧
org.keycloak.models.UserSessionProvider インタフェース
org.keycloak.models.UserSessionProvider の継承関係図
Inheritance graph
org.keycloak.models.UserSessionProvider 連携図
Collaboration graph

公開メンバ関数

AuthenticatedClientSessionModel createClientSession (RealmModel realm, ClientModel client, UserSessionModel userSession)
 
AuthenticatedClientSessionModel getClientSession (UserSessionModel userSession, ClientModel client, UUID clientSessionId, boolean offline)
 
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)
 
UserSessionModel getUserSession (RealmModel realm, String id)
 
List< UserSessionModelgetUserSessions (RealmModel realm, UserModel user)
 
List< UserSessionModelgetUserSessions (RealmModel realm, ClientModel client)
 
List< UserSessionModelgetUserSessions (RealmModel realm, ClientModel client, int firstResult, int maxResults)
 
List< UserSessionModelgetUserSessionByBrokerUserId (RealmModel realm, String brokerUserId)
 
UserSessionModel getUserSessionByBrokerSessionId (RealmModel realm, String brokerSessionId)
 
UserSessionModel getUserSessionWithPredicate (RealmModel realm, String id, boolean offline, Predicate< UserSessionModel > predicate)
 
long getActiveUserSessions (RealmModel realm, ClientModel client)
 
Map< String, Long > getActiveClientSessionStats (RealmModel realm, boolean offline)
 
void removeUserSession (RealmModel realm, UserSessionModel session)
 
void removeUserSessions (RealmModel realm, UserModel user)
 
void removeExpired (RealmModel realm)
 
void removeUserSessions (RealmModel realm)
 
UserLoginFailureModel getUserLoginFailure (RealmModel realm, String userId)
 
UserLoginFailureModel addUserLoginFailure (RealmModel realm, String userId)
 
void removeUserLoginFailure (RealmModel realm, String userId)
 
void removeAllUserLoginFailures (RealmModel realm)
 
void onRealmRemoved (RealmModel realm)
 
void onClientRemoved (RealmModel realm, ClientModel client)
 
UserSessionModel createOfflineUserSession (UserSessionModel userSession)
 
UserSessionModel getOfflineUserSession (RealmModel realm, String userSessionId)
 
void removeOfflineUserSession (RealmModel realm, UserSessionModel userSession)
 
AuthenticatedClientSessionModel createOfflineClientSession (AuthenticatedClientSessionModel clientSession, UserSessionModel offlineUserSession)
 
List< UserSessionModelgetOfflineUserSessions (RealmModel realm, UserModel user)
 
long getOfflineSessionsCount (RealmModel realm, ClientModel client)
 
List< UserSessionModelgetOfflineUserSessions (RealmModel realm, ClientModel client, int first, int max)
 
UserSessionModel importUserSession (UserSessionModel persistentUserSession, boolean offline, boolean importAuthenticatedClientSessions)
 
void close ()
 

詳解

著者
Bill Burke
バージョン
Revision
1

関数詳解

◆ addUserLoginFailure()

UserLoginFailureModel org.keycloak.models.UserSessionProvider.addUserLoginFailure ( RealmModel  realm,
String  userId 
)

◆ close()

void org.keycloak.models.UserSessionProvider.close ( )

◆ createClientSession()

AuthenticatedClientSessionModel org.keycloak.models.UserSessionProvider.createClientSession ( RealmModel  realm,
ClientModel  client,
UserSessionModel  userSession 
)

◆ createOfflineClientSession()

AuthenticatedClientSessionModel org.keycloak.models.UserSessionProvider.createOfflineClientSession ( AuthenticatedClientSessionModel  clientSession,
UserSessionModel  offlineUserSession 
)

Will automatically attach newly created offline client session to the offlineUserSession

org.keycloak.models.sessions.infinispan.InfinispanUserSessionProviderで実装されています。

◆ createOfflineUserSession()

UserSessionModel org.keycloak.models.UserSessionProvider.createOfflineUserSession ( UserSessionModel  userSession)

Newly created userSession won't contain attached AuthenticatedClientSessions

org.keycloak.models.sessions.infinispan.InfinispanUserSessionProviderで実装されています。

◆ createUserSession() [1/2]

UserSessionModel org.keycloak.models.UserSessionProvider.createUserSession ( RealmModel  realm,
UserModel  user,
String  loginUsername,
String  ipAddress,
String  authMethod,
boolean  rememberMe,
String  brokerSessionId,
String  brokerUserId 
)

◆ createUserSession() [2/2]

UserSessionModel org.keycloak.models.UserSessionProvider.createUserSession ( String  id,
RealmModel  realm,
UserModel  user,
String  loginUsername,
String  ipAddress,
String  authMethod,
boolean  rememberMe,
String  brokerSessionId,
String  brokerUserId 
)

◆ getActiveClientSessionStats()

Map<String, Long> org.keycloak.models.UserSessionProvider.getActiveClientSessionStats ( RealmModel  realm,
boolean  offline 
)

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

引数
realm
offline
戻り値

org.keycloak.models.sessions.infinispan.InfinispanUserSessionProviderで実装されています。

◆ getActiveUserSessions()

long org.keycloak.models.UserSessionProvider.getActiveUserSessions ( RealmModel  realm,
ClientModel  client 
)

◆ getClientSession()

AuthenticatedClientSessionModel org.keycloak.models.UserSessionProvider.getClientSession ( UserSessionModel  userSession,
ClientModel  client,
UUID  clientSessionId,
boolean  offline 
)

◆ getOfflineSessionsCount()

long org.keycloak.models.UserSessionProvider.getOfflineSessionsCount ( RealmModel  realm,
ClientModel  client 
)

◆ getOfflineUserSession()

UserSessionModel org.keycloak.models.UserSessionProvider.getOfflineUserSession ( RealmModel  realm,
String  userSessionId 
)

◆ getOfflineUserSessions() [1/2]

List<UserSessionModel> org.keycloak.models.UserSessionProvider.getOfflineUserSessions ( RealmModel  realm,
UserModel  user 
)

◆ getOfflineUserSessions() [2/2]

List<UserSessionModel> org.keycloak.models.UserSessionProvider.getOfflineUserSessions ( RealmModel  realm,
ClientModel  client,
int  first,
int  max 
)

◆ getUserLoginFailure()

UserLoginFailureModel org.keycloak.models.UserSessionProvider.getUserLoginFailure ( RealmModel  realm,
String  userId 
)

◆ getUserSession()

UserSessionModel org.keycloak.models.UserSessionProvider.getUserSession ( RealmModel  realm,
String  id 
)

◆ getUserSessionByBrokerSessionId()

UserSessionModel org.keycloak.models.UserSessionProvider.getUserSessionByBrokerSessionId ( RealmModel  realm,
String  brokerSessionId 
)

◆ getUserSessionByBrokerUserId()

List<UserSessionModel> org.keycloak.models.UserSessionProvider.getUserSessionByBrokerUserId ( RealmModel  realm,
String  brokerUserId 
)

◆ getUserSessions() [1/3]

List<UserSessionModel> org.keycloak.models.UserSessionProvider.getUserSessions ( RealmModel  realm,
UserModel  user 
)

◆ getUserSessions() [2/3]

List<UserSessionModel> org.keycloak.models.UserSessionProvider.getUserSessions ( RealmModel  realm,
ClientModel  client 
)

◆ getUserSessions() [3/3]

List<UserSessionModel> org.keycloak.models.UserSessionProvider.getUserSessions ( RealmModel  realm,
ClientModel  client,
int  firstResult,
int  maxResults 
)

◆ getUserSessionWithPredicate()

UserSessionModel org.keycloak.models.UserSessionProvider.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)

org.keycloak.models.sessions.infinispan.InfinispanUserSessionProviderで実装されています。

◆ importUserSession()

UserSessionModel org.keycloak.models.UserSessionProvider.importUserSession ( UserSessionModel  persistentUserSession,
boolean  offline,
boolean  importAuthenticatedClientSessions 
)

Triggered by persister during pre-load. It optionally imports authenticatedClientSessions too if requested. Otherwise the imported UserSession will have empty list of AuthenticationSessionModel

org.keycloak.models.sessions.infinispan.InfinispanUserSessionProviderで実装されています。

◆ onClientRemoved()

void org.keycloak.models.UserSessionProvider.onClientRemoved ( RealmModel  realm,
ClientModel  client 
)

◆ onRealmRemoved()

void org.keycloak.models.UserSessionProvider.onRealmRemoved ( RealmModel  realm)

◆ removeAllUserLoginFailures()

void org.keycloak.models.UserSessionProvider.removeAllUserLoginFailures ( RealmModel  realm)

◆ removeExpired()

void org.keycloak.models.UserSessionProvider.removeExpired ( RealmModel  realm)

Implementation should propagate removal of expired userSessions to userSessionPersister too

org.keycloak.models.sessions.infinispan.InfinispanUserSessionProviderで実装されています。

◆ removeOfflineUserSession()

void org.keycloak.models.UserSessionProvider.removeOfflineUserSession ( RealmModel  realm,
UserSessionModel  userSession 
)

Removes the attached clientSessions as well

org.keycloak.models.sessions.infinispan.InfinispanUserSessionProviderで実装されています。

◆ removeUserLoginFailure()

void org.keycloak.models.UserSessionProvider.removeUserLoginFailure ( RealmModel  realm,
String  userId 
)

◆ removeUserSession()

void org.keycloak.models.UserSessionProvider.removeUserSession ( RealmModel  realm,
UserSessionModel  session 
)

This will remove attached ClientLoginSessionModels too

org.keycloak.models.sessions.infinispan.InfinispanUserSessionProviderで実装されています。

◆ removeUserSessions() [1/2]

void org.keycloak.models.UserSessionProvider.removeUserSessions ( RealmModel  realm,
UserModel  user 
)

◆ removeUserSessions() [2/2]

void org.keycloak.models.UserSessionProvider.removeUserSessions ( RealmModel  realm)

このインタフェース詳解は次のファイルから抽出されました: