Package org.keycloak.models.cache

Interface CachedRealmModel

All Superinterfaces:

LegacyRealmModel, RealmModel, RoleContainerModel

All Known Implementing Classes:

RealmAdapter

public interface CachedRealmModel
extends LegacyRealmModel

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

RealmModel.IdentityProviderRemovedEvent, RealmModel.IdentityProviderUpdatedEvent, RealmModel.RealmCreationEvent, RealmModel.RealmPostCreateEvent, RealmModel.RealmRemovedEvent, RealmModel.SearchableFields

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

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.
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.LegacyRealmModel

getClientStorageProviders, getClientStorageProvidersStream, getRoleStorageProviders, getRoleStorageProvidersStream, getUserStorageProviders, getUserStorageProvidersStream

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, getAdminTheme, getAlwaysDisplayInConsoleClientsStream, getAttribute, getAttribute, getAttribute, getAttribute, getAttributes, getAuthenticationExecutionByFlowId, getAuthenticationExecutionById, getAuthenticationExecutionsStream, getAuthenticationFlowById, getAuthenticationFlowsStream, getAuthenticatorConfigByAlias, getAuthenticatorConfigById, getAuthenticatorConfigsStream, getBrowserFlow, getBrowserSecurityHeaders, 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, getFlowByAlias, getGroupById, getGroupsCount, getGroupsCountByNameContaining, getGroupsStream, getId, getIdentityProviderByAlias, getIdentityProviderMapperById, getIdentityProviderMapperByName, getIdentityProviderMappersByAliasStream, getIdentityProviderMappersStream, getIdentityProvidersStream, getLoginTheme, getMasterAdminClient, getMaxDeltaTimeSeconds, getMaxFailureWaitSeconds, getMinimumQuickLoginWaitSeconds, getName, getNotBefore, getOAuth2DeviceConfig, getOfflineSessionIdleTimeout, getOfflineSessionMaxLifespan, getOTPPolicy, getParPolicy, getPasswordPolicy, getQuickLoginCheckMilliSeconds, getRealmLocalizationTexts, getRealmLocalizationTextsByLocale, getRefreshTokenMaxReuse, getRegistrationFlow, getRequiredActionProviderByAlias, getRequiredActionProviderById, getRequiredActionProvidersStream, getRequiredCredentialsStream, getResetCredentialsFlow, getRoleById, getSmtpConfig, getSslRequired, getSsoSessionIdleTimeout, getSsoSessionIdleTimeoutRememberMe, getSsoSessionMaxLifespan, getSsoSessionMaxLifespanRememberMe, getStorageProviders, getSupportedLocalesStream, getTopLevelGroupsStream, getTopLevelGroupsStream, getUserActionTokenLifespans, getWaitIncrementSeconds, getWebAuthnPolicy, getWebAuthnPolicyPasswordless, importComponentModel, isAdminEventsDetailsEnabled, isAdminEventsEnabled, isBruteForceProtected, isDuplicateEmailsAllowed, isEditUsernameAllowed, isEnabled, isEventsEnabled, isIdentityFederationEnabled, isInternationalizationEnabled, isLoginWithEmailAllowed, isOfflineSessionMaxLifespanEnabled, isPermanentLockout, isRegistrationAllowed, isRegistrationEmailAsUsername, isRememberMe, isResetPasswordAllowed, isRevokeRefreshToken, isUserManagedAccessAllowed, isVerifyEmail, moveGroup, removeAttribute, removeAuthenticationFlow, removeAuthenticatorConfig, removeAuthenticatorExecution, removeClient, removeClientInitialAccessModel, removeClientScope, removeComponent, removeComponents, removeDefaultClientScope, removeDefaultGroup, removeGroup, removeIdentityProviderByAlias, removeIdentityProviderMapper, removeRealmLocalizationTexts, removeRequiredActionProvider, searchClientByAttributes, searchClientByClientIdStream, searchForGroupByNameStream, setAccessCodeLifespan, setAccessCodeLifespanLogin, setAccessCodeLifespanUserAction, setAccessTokenLifespan, setAccessTokenLifespanForImplicitFlow, setAccountTheme, setActionTokenGeneratedByAdminLifespan, setActionTokenGeneratedByUserLifespan, setActionTokenGeneratedByUserLifespan, setAdminEventsDetailsEnabled, setAdminEventsEnabled, setAdminTheme, setAttribute, setAttribute, setAttribute, setAttribute, setBrowserFlow, setBrowserSecurityHeaders, setBruteForceProtected, setClientAuthenticationFlow, setClientOfflineSessionIdleTimeout, setClientOfflineSessionMaxLifespan, setClientSessionIdleTimeout, setClientSessionMaxLifespan, setDefaultLocale, setDefaultRole, setDefaultSignatureAlgorithm, setDirectGrantFlow, setDisplayName, setDisplayNameHtml, setDockerAuthenticationFlow, setDuplicateEmailsAllowed, setEditUsernameAllowed, setEmailTheme, setEnabled, setEnabledEventTypes, setEventsEnabled, setEventsExpiration, setEventsListeners, setFailureFactor, setInternationalizationEnabled, setLoginTheme, setLoginWithEmailAllowed, setMasterAdminClient, setMaxDeltaTimeSeconds, setMaxFailureWaitSeconds, setMinimumQuickLoginWaitSeconds, setName, setNotBefore, setOfflineSessionIdleTimeout, setOfflineSessionMaxLifespan, setOfflineSessionMaxLifespanEnabled, setOTPPolicy, setPasswordPolicy, setPermanentLockout, setQuickLoginCheckMilliSeconds, setRefreshTokenMaxReuse, setRegistrationAllowed, setRegistrationEmailAsUsername, setRegistrationFlow, setRememberMe, setResetCredentialsFlow, setResetPasswordAllowed, setRevokeRefreshToken, setSmtpConfig, setSslRequired, setSsoSessionIdleTimeout, setSsoSessionIdleTimeoutRememberMe, setSsoSessionMaxLifespan, setSsoSessionMaxLifespanRememberMe, setSupportedLocales, setUserManagedAccessAllowed, setVerifyEmail, setWaitIncrementSeconds, setWebAuthnPolicy, setWebAuthnPolicyPasswordless, updateAuthenticationFlow, updateAuthenticatorConfig, updateAuthenticatorExecution, updateComponent, updateIdentityProvider, updateIdentityProviderMapper, updateRequiredActionProvider, updateRequiredCredentials

Methods inherited from interface org.keycloak.models.RoleContainerModel

addDefaultRole, addRole, addRole, getDefaultRoles, getDefaultRolesStream, getRole, getRolesStream, getRolesStream, removeDefaultRoles, removeRole, searchForRolesStream, updateDefaultRoles

Method Detail

getDelegateForUpdate

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: