Package org.keycloak.models.cache

Interface CachedRealmModel

All Superinterfaces:
org.keycloak.models.RealmModel, org.keycloak.models.RoleContainerModel, org.keycloak.models.StorageProviderRealmModel
public interface CachedRealmModel extends org.keycloak.models.StorageProviderRealmModel
Cached realms will implement this interface
Version:
$Revision: 1 $
Author:
Bill Burke

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    CachedRealmModel.RealmCachedEvent
     

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

    org.keycloak.models.RealmModel.IdentityProviderRemovedEvent, org.keycloak.models.RealmModel.IdentityProviderUpdatedEvent, org.keycloak.models.RealmModel.RealmAttributeUpdateEvent, org.keycloak.models.RealmModel.RealmCreationEvent, org.keycloak.models.RealmModel.RealmPostCreateEvent, org.keycloak.models.RealmModel.RealmRemovedEvent

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

    org.keycloak.models.RoleContainerModel.RoleRemovedEvent

  • Field Summary

    Fields inherited from interface org.keycloak.models.RealmModel

    COMPARE_BY_NAME

  • Method Summary

    Modifier and Type
    Method
    Description
    ConcurrentHashMap
    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.RealmModel
    getDelegateForUpdate()
    Invalidates the cache for this model and returns a delegate that represents the actual data provider
    void
    invalidate()
    Invalidate the cache for this model

    Methods inherited from interface org.keycloak.models.RealmModel

    addAuthenticationFlow, addAuthenticatorConfig, addAuthenticatorExecution, addClient, addClient, addClientScope, addClientScope, addComponentModel, addDefaultClientScope, addDefaultGroup, addIdentityProvider, addIdentityProviderMapper, addRequiredActionProvider, addRequiredCredential, addToDefaultRoles, createClientInitialAccessModel, createGroup, createGroup, createGroup, createGroup, createOrUpdateRealmLocalizationTexts, decreaseRemainingCount, getAccessCodeLifespan, getAccessCodeLifespanLogin, getAccessCodeLifespanUserAction, getAccessTokenLifespan, getAccessTokenLifespanForImplicitFlow, getAccountTheme, getActionTokenGeneratedByAdminLifespan, getActionTokenGeneratedByUserLifespan, getActionTokenGeneratedByUserLifespan, getAdminPermissionsClient, getAdminTheme, getAlwaysDisplayInConsoleClientsStream, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttributes, getAuthenticationExecutionByFlowId, getAuthenticationExecutionById, getAuthenticationExecutionsStream, getAuthenticationFlowById, getAuthenticationFlowsStream, getAuthenticatorConfigByAlias, getAuthenticatorConfigById, getAuthenticatorConfigsStream, getBrowserFlow, getBrowserSecurityHeaders, getBruteForceStrategy, getCibaPolicy, getClientAuthenticationFlow, getClientByClientId, getClientById, getClientInitialAccesses, getClientInitialAccessModel, getClientOfflineSessionIdleTimeout, getClientOfflineSessionMaxLifespan, getClientScopeById, getClientScopesStream, getClientsCount, getClientSessionIdleTimeout, getClientSessionMaxLifespan, getClientsStream, getClientsStream, getComponent, getComponentsStream, getComponentsStream, getComponentsStream, getDefaultClientScopesStream, getDefaultGroupsStream, getDefaultLocale, getDefaultRole, getDefaultSignatureAlgorithm, getDirectGrantFlow, getDisplayName, getDisplayNameHtml, getDockerAuthenticationFlow, getEmailTheme, getEnabledEventTypesStream, getEventsExpiration, getEventsListenersStream, getFailureFactor, getFirstBrokerLoginFlow, getFlowByAlias, getGroupById, getGroupsCount, getGroupsCountByNameContaining, getGroupsStream, getId, getIdentityProviderByAlias, getIdentityProviderMapperById, getIdentityProviderMapperByName, getIdentityProviderMappersByAliasStream, getIdentityProviderMappersStream, getIdentityProvidersStream, getLoginTheme, getMasterAdminClient, getMaxDeltaTimeSeconds, getMaxFailureWaitSeconds, getMaxSecondaryAuthFailures, getMaxTemporaryLockouts, getMinimumQuickLoginWaitSeconds, getName, getNotBefore, getOAuth2DeviceConfig, getOfflineSessionIdleTimeout, getOfflineSessionMaxLifespan, getOTPPolicy, getParPolicy, getPasswordPolicy, getQuickLoginCheckMilliSeconds, getRealmLocalizationTexts, getRealmLocalizationTextsByLocale, getRefreshTokenMaxReuse, getRegistrationFlow, getRequiredActionConfigByAlias, getRequiredActionConfigById, getRequiredActionConfigsStream, getRequiredActionProviderByAlias, getRequiredActionProviderById, getRequiredActionProvidersStream, getRequiredCredentialsStream, getResetCredentialsFlow, getRoleById, getSmtpConfig, getSslRequired, getSsoSessionIdleTimeout, getSsoSessionIdleTimeoutRememberMe, getSsoSessionMaxLifespan, getSsoSessionMaxLifespanRememberMe, getStorageProviders, getSupportedLocalesStream, getTopLevelGroupsStream, getTopLevelGroupsStream, getUserActionTokenLifespans, getWaitIncrementSeconds, getWebAuthnPolicy, getWebAuthnPolicyPasswordless, importComponentModel, isAdminEventsDetailsEnabled, isAdminEventsEnabled, isAdminPermissionsEnabled, isBruteForceProtected, isDuplicateEmailsAllowed, isEditUsernameAllowed, isEnabled, isEventsEnabled, isIdentityFederationEnabled, isInternationalizationEnabled, isLoginWithEmailAllowed, isOfflineSessionMaxLifespanEnabled, isOrganizationsEnabled, isPermanentLockout, isRegistrationAllowed, isRegistrationEmailAsUsername, isRememberMe, isResetPasswordAllowed, isRevokeRefreshToken, isScimApiEnabled, isUserManagedAccessAllowed, isVerifiableCredentialsEnabled, isVerifyEmail, moveGroup, removeAttribute, removeAuthenticationFlow, removeAuthenticatorConfig, removeAuthenticatorExecution, removeClient, removeClientInitialAccessModel, removeClientScope, removeComponent, removeComponents, removeDefaultClientScope, removeDefaultGroup, removeGroup, removeIdentityProviderByAlias, removeIdentityProviderMapper, removeRealmLocalizationTexts, removeRequiredActionProvider, removeRequiredActionProviderConfig, searchClientByAttributes, searchClientByAuthenticationFlowBindingOverrides, searchClientByClientIdStream, setAccessCodeLifespan, setAccessCodeLifespanLogin, setAccessCodeLifespanUserAction, setAccessTokenLifespan, setAccessTokenLifespanForImplicitFlow, setAccountTheme, setActionTokenGeneratedByAdminLifespan, setActionTokenGeneratedByUserLifespan, setActionTokenGeneratedByUserLifespan, setAdminEventsDetailsEnabled, setAdminEventsEnabled, setAdminPermissionsClient, setAdminPermissionsEnabled, setAdminTheme, setAttribute, setAttribute, setAttribute, setAttribute, setBrowserFlow, setBrowserSecurityHeaders, setBruteForceProtected, setBruteForceStrategy, setClientAuthenticationFlow, setClientOfflineSessionIdleTimeout, setClientOfflineSessionMaxLifespan, setClientSessionIdleTimeout, setClientSessionMaxLifespan, setDefaultLocale, setDefaultRole, setDefaultSignatureAlgorithm, setDirectGrantFlow, setDisplayName, setDisplayNameHtml, setDockerAuthenticationFlow, setDuplicateEmailsAllowed, setEditUsernameAllowed, setEmailTheme, setEnabled, setEnabledEventTypes, setEventsEnabled, setEventsExpiration, setEventsListeners, setFailureFactor, setFirstBrokerLoginFlow, setInternationalizationEnabled, setLoginTheme, setLoginWithEmailAllowed, setMasterAdminClient, setMaxDeltaTimeSeconds, setMaxFailureWaitSeconds, setMaxSecondaryAuthFailures, setMaxTemporaryLockouts, setMinimumQuickLoginWaitSeconds, setName, setNotBefore, setOfflineSessionIdleTimeout, setOfflineSessionMaxLifespan, setOfflineSessionMaxLifespanEnabled, setOrganizationsEnabled, setOTPPolicy, setPasswordPolicy, setPermanentLockout, setQuickLoginCheckMilliSeconds, setRefreshTokenMaxReuse, setRegistrationAllowed, setRegistrationEmailAsUsername, setRegistrationFlow, setRememberMe, setResetCredentialsFlow, setResetPasswordAllowed, setRevokeRefreshToken, setScimApiEnabled, setSmtpConfig, setSslRequired, setSsoSessionIdleTimeout, setSsoSessionIdleTimeoutRememberMe, setSsoSessionMaxLifespan, setSsoSessionMaxLifespanRememberMe, setSupportedLocales, setUserManagedAccessAllowed, setVerifiableCredentialsEnabled, setVerifyEmail, setWaitIncrementSeconds, setWebAuthnPolicy, setWebAuthnPolicyPasswordless, updateAuthenticationFlow, updateAuthenticatorConfig, updateAuthenticatorExecution, updateComponent, updateIdentityProvider, updateIdentityProviderMapper, updateRequiredActionConfig, updateRequiredActionProvider, updateRequiredCredentials

    Methods inherited from interface org.keycloak.models.RoleContainerModel

    addRole, addRole, getRole, getRolesStream, getRolesStream, removeRole, searchForRolesStream

    Methods inherited from interface org.keycloak.models.StorageProviderRealmModel

    getClientStorageProviders, getClientStorageProvidersStream, getRoleStorageProviders, getRoleStorageProvidersStream, getUserStorageProviders, getUserStorageProvidersStream

  • Method Details

    • getDelegateForUpdate

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

    • invalidate

      void invalidate()
      Invalidate the cache for this model

    • getCacheTimestamp

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

    • getCachedWith

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