Package org.keycloak.models.cache

Interface CachedUserModel

All Superinterfaces:
org.keycloak.models.Model, org.keycloak.models.RoleMapperModel, org.keycloak.models.UserModel
public interface CachedUserModel extends org.keycloak.models.UserModel
Cached users will implement this interface
Version:
$Revision: 1 $
Author:
Bill Burke

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.keycloak.models.UserModel

    org.keycloak.models.UserModel.RequiredAction, org.keycloak.models.UserModel.UserPreRemovedEvent, org.keycloak.models.UserModel.UserRemovedEvent

  • Field Summary

    Fields inherited from interface org.keycloak.models.UserModel

    COMPARE_BY_USERNAME, CREATED_AFTER, CREATED_BEFORE, CREATED_TIMESTAMP, DID, DISABLED_REASON, EMAIL, EMAIL_PENDING, EMAIL_VERIFIED, ENABLED, EXACT, FIRST_NAME, GROUPS, ID, IDP_ALIAS, IDP_USER_ID, INCLUDE_SERVICE_ACCOUNT, IS_TEMP_ADMIN_ATTR_NAME, LAST_NAME, LOCALE, SEARCH, USERNAME

  • Method Summary

    Modifier and Type
    Method
    Description
    ConcurrentMap
    getCachedWith()
    Returns a map that contains custom things that are cached along with this model.
    long
    getCacheTimestamp()
    When was the model was loaded from database.
    org.keycloak.models.UserModel
    getDelegateForUpdate()
    Invalidates the cache for this user and returns a delegate that represents the actual data provider
    void
    invalidate()
    Invalidate the cache for this model
    boolean
    isMarkedForEviction()
     

    Methods inherited from interface org.keycloak.models.Model

    getId

    Methods inherited from interface org.keycloak.models.RoleMapperModel

    deleteRoleMapping, getClientRoleMappingsStream, getRealmRoleMappingsStream, getRoleMappingsStream, grantRole, hasDirectRole, hasRole

    Methods inherited from interface org.keycloak.models.UserModel

    addRequiredAction, addRequiredAction, credentialManager, getAttributes, getAttributeStream, getCreatedTimestamp, getEmail, getFederationLink, getFirstAttribute, getFirstName, getGroupsCount, getGroupsCountByNameContaining, getGroupsStream, getGroupsStream, getLastModifiedTimestamp, getLastName, getRequiredActionsStream, getServiceAccountClientLink, getUsername, isEmailVerified, isEnabled, isFederated, isMemberOf, joinGroup, joinGroup, leaveGroup, removeAttribute, removeRequiredAction, removeRequiredAction, setAttribute, setCreatedTimestamp, setEmail, setEmailVerified, setEnabled, setFederationLink, setFirstName, setLastModifiedTimestamp, setLastName, setServiceAccountClientLink, setSingleAttribute, setUsername

  • Method Details

    • getDelegateForUpdate

      org.keycloak.models.UserModel getDelegateForUpdate()
      Invalidates the cache for this user and returns a delegate that represents the actual data provider
      Returns:

    • isMarkedForEviction

      boolean isMarkedForEviction()

    • invalidate

      void invalidate()
      Invalidate the cache for this model

    • getCacheTimestamp

      long getCacheTimestamp()
      When was the model was loaded from database.
      Returns:

    • getCachedWith

      ConcurrentMap getCachedWith()
      Returns a map that contains custom things that are cached along with this model. You can write to this map.
      Returns: