Package org.keycloak.authentication.authenticators.client

Class AbstractClientAuthenticator

java.lang.Object
org.keycloak.authentication.authenticators.client.AbstractClientAuthenticator
All Implemented Interfaces:
org.keycloak.authentication.ClientAuthenticator, org.keycloak.authentication.ClientAuthenticatorFactory, org.keycloak.authentication.ConfigurableAuthenticatorFactory, org.keycloak.provider.ConfiguredPerClientProvider, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.authentication.ClientAuthenticator>
Direct Known Subclasses:
AttestationBasedClientAuthenticator, ClientIdAndSecretAuthenticator, FederatedJWTClientAuthenticator, JWTClientAuthenticator, JWTClientSecretAuthenticator, X509ClientAuthenticator
public abstract class AbstractClientAuthenticator extends Object implements org.keycloak.authentication.ClientAuthenticator, org.keycloak.authentication.ClientAuthenticatorFactory
Author:
Marek Posolda

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final org.jboss.logging.Logger
    logger
     

    Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

    REQUIREMENT_CHOICES

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractClientAuthenticator()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
     
    org.keycloak.authentication.ClientAuthenticator
    create()
     
    org.keycloak.authentication.ClientAuthenticator
    create(org.keycloak.models.KeycloakSession session)
     
    String
    getReferenceCategory()
     
    void
    init(org.keycloak.Config.Scope config)
     
    boolean
    isUserSetupAllowed()
     
    void
    postInit(org.keycloak.models.KeycloakSessionFactory factory)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.keycloak.authentication.ClientAuthenticator

    authenticateClient

    Methods inherited from interface org.keycloak.authentication.ClientAuthenticatorFactory

    getAdapterConfiguration, getProtocolAuthenticatorMethod, getProtocolAuthenticatorMethods, isConfigurable, setClientAuthenticationMethod, supportsSecret

    Methods inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

    getDisplayType, getOptionalReferenceCategories, getRequirementChoices

    Methods inherited from interface org.keycloak.provider.ConfiguredPerClientProvider

    getConfigPropertiesPerClient

    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

    • logger

      protected final org.jboss.logging.Logger logger

  • Constructor Details

    • AbstractClientAuthenticator

      public AbstractClientAuthenticator()

  • Method Details

    • create

      public org.keycloak.authentication.ClientAuthenticator create()
      Specified by:
      create in interface org.keycloak.authentication.ClientAuthenticatorFactory

    • close

      public void close()
      Specified by:
      close in interface org.keycloak.provider.Provider
      Specified by:
      close in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.ClientAuthenticator>

    • create

      public org.keycloak.authentication.ClientAuthenticator create(org.keycloak.models.KeycloakSession session)
      Specified by:
      create in interface org.keycloak.provider.ProviderFactory<org.keycloak.authentication.ClientAuthenticator>

    • init

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

    • postInit

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

    • isUserSetupAllowed

      public boolean isUserSetupAllowed()
      Specified by:
      isUserSetupAllowed in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

    • getReferenceCategory

      public String getReferenceCategory()
      Specified by:
      getReferenceCategory in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory