Class AbstractClientRegistrationPolicyFactory

java.lang.Object
org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory
All Implemented Interfaces:
org.keycloak.component.ComponentFactory<ClientRegistrationPolicy,ClientRegistrationPolicy>, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.ProviderFactory<ClientRegistrationPolicy>, ClientRegistrationPolicyFactory
Direct Known Subclasses:
ClientDisabledClientRegistrationPolicyFactory, ClientScopesClientRegistrationPolicyFactory, ConsentRequiredClientRegistrationPolicyFactory, MaxClientsClientRegistrationPolicyFactory, ProtocolMappersClientRegistrationPolicyFactory, RegistrationWebOriginsPolicyFactory, ScopeClientRegistrationPolicyFactory, TrustedHostClientRegistrationPolicyFactory

public abstract class AbstractClientRegistrationPolicyFactory extends Object implements ClientRegistrationPolicyFactory
Author:
Marek Posolda
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected org.keycloak.models.KeycloakSessionFactory
     
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
     
    List<org.keycloak.provider.ProviderConfigProperty>
    getConfigProperties(org.keycloak.models.KeycloakSession session)
    Get config properties filled for particular session.
    void
    init(org.keycloak.Config.Scope config)
     
    void
    postInit(org.keycloak.models.KeycloakSessionFactory factory)
     
    void
    validateConfiguration(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.component.ComponentModel config)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.keycloak.component.ComponentFactory

    create, create, getCommonProviderConfigProperties, getTypeMetadata, isInternal, onCreate, onUpdate, preRemove

    Methods inherited from interface org.keycloak.provider.ConfiguredProvider

    getConfig, getConfigProperties, getHelpText

    Methods inherited from interface org.keycloak.provider.ProviderFactory

    dependsOn, getConfigMetadata, getId, order
  • Field Details

    • sessionFactory

      protected org.keycloak.models.KeycloakSessionFactory sessionFactory
  • Constructor Details

    • AbstractClientRegistrationPolicyFactory

      public AbstractClientRegistrationPolicyFactory()
  • Method Details

    • init

      public void init(org.keycloak.Config.Scope config)
      Specified by:
      init in interface org.keycloak.provider.ProviderFactory<ClientRegistrationPolicy>
    • postInit

      public void postInit(org.keycloak.models.KeycloakSessionFactory factory)
      Specified by:
      postInit in interface org.keycloak.provider.ProviderFactory<ClientRegistrationPolicy>
    • close

      public void close()
      Specified by:
      close in interface org.keycloak.provider.ProviderFactory<ClientRegistrationPolicy>
    • validateConfiguration

      public void validateConfiguration(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.component.ComponentModel config) throws org.keycloak.component.ComponentValidationException
      Specified by:
      validateConfiguration in interface org.keycloak.component.ComponentFactory<ClientRegistrationPolicy,ClientRegistrationPolicy>
      Throws:
      org.keycloak.component.ComponentValidationException
    • getConfigProperties

      public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties(org.keycloak.models.KeycloakSession session)
      Description copied from interface: ClientRegistrationPolicyFactory
      Get config properties filled for particular session. It assumes the session.getContext() has set realm
      Specified by:
      getConfigProperties in interface ClientRegistrationPolicyFactory
      Returns: