Package org.keycloak.models.cache
Interface UserCache
-
- All Superinterfaces:
Provider
,UserBulkUpdateProvider
,UserLookupProvider
,UserProvider
,UserQueryProvider
,UserRegistrationProvider
- All Known Subinterfaces:
UserCache.Streams
- All Known Implementing Classes:
UserCacheSession
public interface UserCache extends UserProvider
All these methods effect an entire cluster of Keycloak instances.- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
UserCache.Streams
TheUserCache.Streams
interface differs fromUserCache
in that it extends theUserProvider.Streams
interface, allowing implementations ofUserCache
to focus on theStream
-based methods in theUserProvider
interface.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clear()
Clear cache entirely.void
evict(RealmModel realm)
Evict users of a specific realmvoid
evict(RealmModel realm, UserModel user)
Evict user from cache.-
Methods inherited from interface org.keycloak.storage.user.UserBulkUpdateProvider
grantToAllUsers
-
Methods inherited from interface org.keycloak.storage.user.UserLookupProvider
getUserByEmail, getUserByEmail, getUserById, getUserById, getUserByUsername, getUserByUsername
-
Methods inherited from interface org.keycloak.models.UserProvider
addConsent, addFederatedIdentity, addUser, close, getConsentByClient, getConsents, getConsentsStream, getFederatedIdentities, getFederatedIdentitiesStream, getFederatedIdentity, getFederatedIdentity, getNotBeforeOfUser, getServiceAccount, getUserByFederatedIdentity, getUserByFederatedIdentity, getUsers, getUsers, getUsersStream, getUsersStream, preRemove, preRemove, preRemove, preRemove, preRemove, preRemove, preRemove, preRemove, removeFederatedIdentity, removeImportedUsers, revokeConsentForClient, setNotBeforeForUser, unlinkUsers, updateConsent, updateFederatedIdentity
-
Methods inherited from interface org.keycloak.storage.user.UserQueryProvider
getGroupMembers, getGroupMembers, getGroupMembersStream, getGroupMembersStream, getRoleMembers, getRoleMembers, getRoleMembersStream, getRoleMembersStream, getUsers, getUsers, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersStream, getUsersStream, searchForUser, searchForUser, searchForUser, searchForUser, searchForUserByUserAttribute, searchForUserByUserAttributeStream, searchForUserStream, searchForUserStream, searchForUserStream, searchForUserStream
-
Methods inherited from interface org.keycloak.storage.user.UserRegistrationProvider
addUser, removeUser
-
-
-
-
Method Detail
-
evict
void evict(RealmModel realm, UserModel user)
Evict user from cache.- Parameters:
user
-
-
evict
void evict(RealmModel realm)
Evict users of a specific realm- Parameters:
realm
-
-
clear
void clear()
Clear cache entirely.
-
-