Package org.keycloak.models.cache

Interface UserCache

All Superinterfaces:
org.keycloak.provider.Provider, org.keycloak.storage.user.UserBulkUpdateProvider, org.keycloak.storage.user.UserCountMethodsProvider, org.keycloak.storage.user.UserLookupProvider, org.keycloak.models.UserProvider, org.keycloak.storage.user.UserQueryMethodsProvider, org.keycloak.storage.user.UserQueryProvider, org.keycloak.storage.user.UserRegistrationProvider
public interface UserCache extends org.keycloak.models.UserProvider
All these methods effect an entire cluster of Keycloak instances.
Version:
$Revision: 1 $
Author:
Bill Burke

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Clear cache entirely.
    void
    evict(org.keycloak.models.RealmModel realm)
    Evict users of a specific realm
    void
    evict(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
    Evict user from cache.

    Methods inherited from interface org.keycloak.provider.Provider

    close

    Methods inherited from interface org.keycloak.storage.user.UserBulkUpdateProvider

    grantToAllUsers

    Methods inherited from interface org.keycloak.storage.user.UserCountMethodsProvider

    getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersCount, getUsersCount

    Methods inherited from interface org.keycloak.storage.user.UserLookupProvider

    getUserByCredential, getUserByEmail, getUserById, getUserByUsername

    Methods inherited from interface org.keycloak.models.UserProvider

    addConsent, addFederatedIdentity, addIssuedVerifiableCredential, addUser, addVerifiableCredential, getConsentByClient, getConsentsStream, getFederatedIdentitiesStream, getFederatedIdentity, getIssuedVerifiableCredentialsStreamByUser, getNotBeforeOfUser, getServiceAccount, getUserByFederatedIdentity, getUserCredentialManager, getVerifiableCredentialByClientScope, getVerifiableCredentialById, getVerifiableCredentialsByUser, preRemove, preRemove, preRemove, preRemove, preRemove, preRemove, preRemove, preRemove, removeExpiredIssuedVerifiableCredentials, removeFederatedIdentity, removeImportedUsers, removeIssuedVerifiableCredential, removeVerifiableCredential, revokeConsentForClient, setNotBeforeForUser, unlinkUsers, updateConsent, updateFederatedIdentity, updateVerifiableCredential

    Methods inherited from interface org.keycloak.storage.user.UserQueryMethodsProvider

    getGroupMembersStream, getGroupMembersStream, getGroupMembersStream, getRoleMembersStream, getRoleMembersStream, searchForUserByUserAttributeStream, searchForUserStream, searchForUserStream, searchForUserStream, searchForUserStream

    Methods inherited from interface org.keycloak.storage.user.UserRegistrationProvider

    addUser, removeUser

  • Method Details

    • evict

      void evict(org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
      Evict user from cache.
      Parameters:
      user -

    • evict

      void evict(org.keycloak.models.RealmModel realm)
      Evict users of a specific realm
      Parameters:
      realm -

    • clear

      void clear()
      Clear cache entirely.