org.keycloak.authentication.authenticators.console

## Class ConsolePasswordAuthenticator

- java.lang.Object
- - org.keycloak.authentication.AbstractFormAuthenticator
  - - org.keycloak.authentication.authenticators.browser.AbstractUsernameFormAuthenticator
    - - org.keycloak.authentication.authenticators.console.ConsoleUsernamePasswordAuthenticator
      - - org.keycloak.authentication.authenticators.console.ConsolePasswordAuthenticator

- All Implemented Interfaces:
    Authenticator, Provider

      public final class ConsolePasswordAuthenticator
      extends ConsoleUsernamePasswordAuthenticator

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static ConsolePasswordAuthenticator` | `SINGLETON`

    - ### Fields inherited from class org.keycloak.authentication.authenticators.browser.AbstractUsernameFormAuthenticator

      `ATTEMPTED_USERNAME, REGISTRATION_FORM_ACTION`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `ConsolePasswordAuthenticator()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `action(AuthenticationFlowContext context)` Called from a form action invocation.
    `protected ConsoleDisplayMode` | `challenge(AuthenticationFlowContext context)`
    `boolean` | `requiresUser()` Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?

    - ### Methods inherited from class org.keycloak.authentication.authenticators.console.ConsoleUsernamePasswordAuthenticator

      `authenticate, challenge, close, configuredFor, setDuplicateUserChallenge, setRequiredActions`

    - ### Methods inherited from class org.keycloak.authentication.authenticators.browser.AbstractUsernameFormAuthenticator

      `challenge, createLoginForm, dummyHash, enabledUser, getDefaultChallengeMessage, isTemporarilyDisabledByBruteForce, runDefaultDummyHash, tempDisabledError, tempDisabledFieldError, testInvalidUser, validatePassword, validatePassword, validateUser, validateUserAndPassword`

    - ### 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, getRequiredActions`

- - ### Field Detail

    - #### SINGLETON

          public static ConsolePasswordAuthenticator SINGLETON

  - ### Constructor Detail

    - #### ConsolePasswordAuthenticator

          public ConsolePasswordAuthenticator()

  - ### Method Detail

    - #### challenge

          protected ConsoleDisplayMode challenge(AuthenticationFlowContext context)

      Overrides:
        `challenge` in class `ConsoleUsernamePasswordAuthenticator`

    - #### action

          public void action(AuthenticationFlowContext context)

      Description copied from interface: `Authenticator`
      Called from a form action invocation.
      Specified by:
        `action` in interface `Authenticator`
      Overrides:
        `action` in class `ConsoleUsernamePasswordAuthenticator`

    - #### requiresUser

          public boolean requiresUser()

      Description copied from interface: `Authenticator`
      Does this authenticator require that the user has already been identified? That AuthenticatorContext.getUser() is not null?
      Specified by:
        `requiresUser` in interface `Authenticator`
      Overrides:
        `requiresUser` in class `ConsoleUsernamePasswordAuthenticator`
      Returns:

Copyright © 2021 JBoss by Red Hat. All rights reserved.