Package org.keycloak.authentication.authenticators.resetcred

Class AbstractSetRequiredActionAuthenticator

java.lang.Object
org.keycloak.authentication.authenticators.resetcred.AbstractSetRequiredActionAuthenticator
All Implemented Interfaces:
org.keycloak.authentication.Authenticator, org.keycloak.authentication.AuthenticatorFactory, org.keycloak.authentication.ConfigurableAuthenticatorFactory, org.keycloak.provider.ConfiguredProvider, org.keycloak.provider.Provider, org.keycloak.provider.ProviderFactory<org.keycloak.authentication.Authenticator>
Direct Known Subclasses:
ResetOTP, ResetPassword
public abstract class AbstractSetRequiredActionAuthenticator extends Object implements org.keycloak.authentication.Authenticator, org.keycloak.authentication.AuthenticatorFactory
Version:
$Revision: 1 $
Author:
Bill Burke

  • Field Summary

    Fields inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

    REQUIREMENT_CHOICES

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractSetRequiredActionAuthenticator()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    action(org.keycloak.authentication.AuthenticationFlowContext context)
     
    void
    close()
     
    boolean
    configuredFor(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
     
    org.keycloak.authentication.Authenticator
    create(org.keycloak.models.KeycloakSession session)
     
    List<org.keycloak.provider.ProviderConfigProperty>
    getConfigProperties()
     
    String
    getReferenceCategory()
     
    org.keycloak.models.AuthenticationExecutionModel.Requirement[]
    getRequirementChoices()
     
    void
    init(org.keycloak.Config.Scope config)
     
    boolean
    isConfigurable()
     
    boolean
    isUserSetupAllowed()
     
    void
    postInit(org.keycloak.models.KeycloakSessionFactory factory)
     
    boolean
    requiresUser()
     
    void
    setRequiredActions(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
     

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

    areRequiredActionsEnabled, authenticate, getRequiredActions

    Methods inherited from interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

    getDisplayType, getOptionalReferenceCategories

    Methods inherited from interface org.keycloak.provider.ConfiguredProvider

    getConfig, getHelpText

    Methods inherited from interface org.keycloak.provider.ProviderFactory

    dependsOn, getConfigMetadata, getId, order

  • Constructor Details

    • AbstractSetRequiredActionAuthenticator

      public AbstractSetRequiredActionAuthenticator()

  • Method Details

    • action

      public void action(org.keycloak.authentication.AuthenticationFlowContext context)
      Specified by:
      action in interface org.keycloak.authentication.Authenticator

    • requiresUser

      public boolean requiresUser()
      Specified by:
      requiresUser in interface org.keycloak.authentication.Authenticator

    • setRequiredActions

      public void setRequiredActions(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
      Specified by:
      setRequiredActions in interface org.keycloak.authentication.Authenticator

    • getReferenceCategory

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

    • isConfigurable

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

    • getRequirementChoices

      public org.keycloak.models.AuthenticationExecutionModel.Requirement[] getRequirementChoices()
      Specified by:
      getRequirementChoices in interface org.keycloak.authentication.ConfigurableAuthenticatorFactory

    • isUserSetupAllowed

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

    • getConfigProperties

      public List<org.keycloak.provider.ProviderConfigProperty> getConfigProperties()
      Specified by:
      getConfigProperties in interface org.keycloak.provider.ConfiguredProvider

    • 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.Authenticator>

    • create

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

    • init

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

    • postInit

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

    • configuredFor

      public boolean configuredFor(org.keycloak.models.KeycloakSession session, org.keycloak.models.RealmModel realm, org.keycloak.models.UserModel user)
      Specified by:
      configuredFor in interface org.keycloak.authentication.Authenticator