Package org.keycloak.storage.client

Class AbstractClientStorageAdapter

java.lang.Object
org.keycloak.storage.client.UnsupportedOperationsClientStorageAdapter
org.keycloak.storage.client.AbstractClientStorageAdapter
All Implemented Interfaces:
org.keycloak.models.ClientModel, org.keycloak.models.ClientScopeModel, org.keycloak.models.OrderedModel, org.keycloak.models.ProtocolMapperContainerModel, org.keycloak.models.RoleContainerModel, org.keycloak.models.ScopeContainerModel
Direct Known Subclasses:
AbstractReadOnlyClientStorageAdapter
public abstract class AbstractClientStorageAdapter extends UnsupportedOperationsClientStorageAdapter
Helper base class for ClientModel implementations for ClientStorageProvider implementations. Contains default implementations of some methods
Version:
$Revision: 1 $
Author:
Bill Burke

  • Nested Class Summary

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

    org.keycloak.models.ClientModel.ClientCreationEvent, org.keycloak.models.ClientModel.ClientIdChangeEvent, org.keycloak.models.ClientModel.ClientProtocolUpdatedEvent, org.keycloak.models.ClientModel.ClientRemovedEvent, org.keycloak.models.ClientModel.ClientUpdatedEvent

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

    org.keycloak.models.ClientScopeModel.ClientScopeCreatedEvent, org.keycloak.models.ClientScopeModel.ClientScopeRemovedEvent

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

    org.keycloak.models.OrderedModel.OrderedModelComparator<OM extends org.keycloak.models.OrderedModel>

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

    org.keycloak.models.RoleContainerModel.RoleRemovedEvent

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.keycloak.storage.client.ClientStorageProviderModel
    component
     
    protected org.keycloak.models.RealmModel
    realm
     
    protected org.keycloak.models.KeycloakSession
    session
     

    Fields inherited from interface org.keycloak.models.ClientModel

    LOGO_URI, POLICY_URI, PRIVATE_KEY, PUBLIC_KEY, TOS_URI, TYPE, X509CERTIFICATE

    Fields inherited from interface org.keycloak.models.ClientScopeModel

    ALLOW_USER_DATA_ACCESS, CONSENT_SCREEN_TEXT, DISPLAY_ON_CONSENT_SCREEN, DYNAMIC_SCOPE_REGEXP, GUI_ORDER, INCLUDE_IN_OPENID_PROVIDER_METADATA, INCLUDE_IN_TOKEN_SCOPE, IS_ALWAYS_CONSENT, IS_DYNAMIC_SCOPE, IS_PARAMETERIZED_SCOPE, IS_REPEATABLE_SCOPE, PARAMETERIZED_SCOPE_REGEXP, PARAMETERIZED_SCOPE_TYPE, VALUE_SEPARATOR

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractClientStorageAdapter(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.storage.client.ClientStorageProviderModel component)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getId()
    Creates federated id based on getClientId() method
    final org.keycloak.models.RealmModel
    getRealm()
     
    Map<String,Integer>
    getRegisteredNodes()
    This is for logout.
    boolean
    isSurrogateAuthRequired()
    This method really isn't used by anybody anywhere.
    void
    registerNode(String nodeHost, int registrationTime)
    This is for logout.
    void
    setSurrogateAuthRequired(boolean surrogateAuthRequired)
    This method really isn't used by anybody anywhere.
    void
    unregisterNode(String nodeHost)
    This is for logout.
    void
    updateClient()
    Overriding implementations should call super.updateClient() as this fires off an update event.

    Methods inherited from class org.keycloak.storage.client.UnsupportedOperationsClientStorageAdapter

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

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.keycloak.models.ClientModel

    addClientScope, addClientScopes, addRedirectUri, addWebOrigin, getAttribute, getAttributes, getAuthenticationFlowBindingOverride, getAuthenticationFlowBindingOverrides, getBaseUrl, getClientAuthenticatorType, getClientId, getClientScopes, getConsentScreenText, getCreatedTimestamp, getDescription, getDynamicClientScope, getLastModifiedTimestamp, getManagementUrl, getName, getNodeReRegistrationTimeout, getNotBefore, getParameterizedClientScope, getProtocol, getRedirectUris, getRegistrationToken, getRootUrl, getSecret, getType, getWebOrigins, hasDirectScope, isAlwaysDisplayInConsole, isBearerOnly, isConsentRequired, isDirectAccessGrantsEnabled, isDisplayOnConsentScreen, isEnabled, isFrontchannelLogout, isFullScopeAllowed, isImplicitFlowEnabled, isPublicClient, isServiceAccountsEnabled, isStandardFlowEnabled, removeAttribute, removeAuthenticationFlowBindingOverride, removeClientScope, removeRedirectUri, removeWebOrigin, setAlwaysDisplayInConsole, setAttribute, setAuthenticationFlowBindingOverride, setBaseUrl, setBearerOnly, setClientAuthenticatorType, setClientId, setConsentRequired, setDescription, setDirectAccessGrantsEnabled, setEnabled, setFrontchannelLogout, setFullScopeAllowed, setImplicitFlowEnabled, setManagementUrl, setName, setNodeReRegistrationTimeout, setNotBefore, setProtocol, setPublicClient, setRedirectUris, setRegistrationToken, setRootUrl, setSecret, setServiceAccountsEnabled, setStandardFlowEnabled, setType, setWebOrigins, validateSecret

    Methods inherited from interface org.keycloak.models.ClientScopeModel

    getDynamicScopeRegexp, getGuiOrder, getParameterFromScope, getParameterizedScopeRegexp, getParameterizedScopeType, isAllowUserDataAccess, isAlwaysConsent, isDynamicScope, isIncludeInOpenIDProviderMetadata, isIncludeInTokenScope, isParameterizedScope, setConsentScreenText, setDisplayOnConsentScreen, setGuiOrder, setIncludeInOpenIDProviderMetadata, setIncludeInTokenScope, setIsDynamicScope, setIsParameterizedScope

    Methods inherited from interface org.keycloak.models.ProtocolMapperContainerModel

    addProtocolMapper, getProtocolMapperById, getProtocolMapperByName, getProtocolMapperByType, getProtocolMappersStream, removeProtocolMapper, updateProtocolMapper

    Methods inherited from interface org.keycloak.models.ScopeContainerModel

    addScopeMapping, deleteScopeMapping, getRealmScopeMappingsStream, getScopeMappingsStream, hasScope

  • Field Details

    • session

      protected org.keycloak.models.KeycloakSession session

    • realm

      protected org.keycloak.models.RealmModel realm

    • component

      protected org.keycloak.storage.client.ClientStorageProviderModel component

  • Constructor Details

    • AbstractClientStorageAdapter

      public AbstractClientStorageAdapter(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.storage.client.ClientStorageProviderModel component)

  • Method Details

    • getId

      public String getId()
      Creates federated id based on getClientId() method
      Returns:

    • getRealm

      public final org.keycloak.models.RealmModel getRealm()

    • isSurrogateAuthRequired

      public boolean isSurrogateAuthRequired()
      This method really isn't used by anybody anywhere. Legacy feature never supported.
      Returns:

    • setSurrogateAuthRequired

      public void setSurrogateAuthRequired(boolean surrogateAuthRequired)
      This method really isn't used by anybody anywhere. Legacy feature never supported.

    • getRegisteredNodes

      public Map<String,Integer> getRegisteredNodes()
      This is for logout. Empty implementation for now. Can override if you can store this information somewhere.
      Returns:

    • registerNode

      public void registerNode(String nodeHost, int registrationTime)
      This is for logout. Empty implementation for now. Can override if you can store this information somewhere.

    • unregisterNode

      public void unregisterNode(String nodeHost)
      This is for logout. Empty implementation for now. Can override if you can store this information somewhere.

    • updateClient

      public void updateClient()
      Overriding implementations should call super.updateClient() as this fires off an update event.