Package org.forgerock.openam.authentication.callbacks

Class ValidatedPasswordCallback

java.lang.Object
org.forgerock.openam.authentication.callbacks.AbstractValidatedCallback
org.forgerock.openam.authentication.callbacks.ValidatedPasswordCallback
All Implemented Interfaces:
Serializable, Callback
@Supported public class ValidatedPasswordCallback extends org.forgerock.openam.authentication.callbacks.AbstractValidatedCallback implements Serializable
Callback to collect a password and validate it using IDM policy.
See Also:

  • Method Details

    • getPrompt

      @Supported public String getPrompt()
      Get the prompt.

      Returns:
      the prompt.

    • isEchoOn

      @Supported public boolean isEchoOn()
      Return whether the password should be displayed as it is being typed.

      Returns:
      the whether the password should be displayed as it is being typed.

    • setPassword

      @Supported public void setPassword(char[] password)
      Set the retrieved password.

      This method makes a copy of the input password before storing it.

      Parameters:
      password - the retrieved password, which may be null.
      See Also:

    • getPassword

      @Supported public char[] getPassword()
      Get the retrieved password.

      This method returns a copy of the retrieved password.

      Returns:
      the retrieved password, which may be null.
      See Also:

    • clearPassword

      @Supported public void clearPassword()
      Clear the retrieved password.

    • builder

      @Supported public static ValidatedPasswordCallback.Builder builder()
      Get a builder for constructing a new ValidatedPasswordCallback.
      Returns:
      a new builder