Package org.wildfly.security.auth.callback

Class PasswordResetCallback

java.lang.Object
org.wildfly.security.auth.callback.PasswordResetCallback
All Implemented Interfaces:
Serializable, Callback, ExtendedCallback
public final class PasswordResetCallback extends Object implements ExtendedCallback, Serializable
A callback used when a password reset is required. Interactive callback handlers should have the user enter the password two times, comparing them for equality.
Author:
David M. Lloyd
See Also:

  • Constructor Details

    • PasswordResetCallback

      public PasswordResetCallback(String prompt)
      Construct a new instance.
      Parameters:
      prompt - the password reset prompt (must not be null or empty)

  • Method Details

    • getPrompt

      public String getPrompt()
      Get the password reset prompt.
      Returns:
      the password reset prompt

    • getPassword

      public char[] getPassword()
      Get the new password.
      Returns:
      the new password, or null if it was not set

    • setPassword

      public void setPassword(char[] password)
      Set the new password.
      Parameters:
      password - the new password

    • clearPassword

      public void clearPassword()
      Clear the stored password bytes by setting them to ' '.

    • isOptional

      public boolean isOptional()
      Description copied from interface: ExtendedCallback
      Determine if this callback is optional.
      Specified by:
      isOptional in interface ExtendedCallback
      Returns:
      true if the callback is optional, false if it is mandatory

    • needsInformation

      public boolean needsInformation()
      Description copied from interface: ExtendedCallback
      Determine if this callback is requesting information.
      Specified by:
      needsInformation in interface ExtendedCallback
      Returns:
      true if the callback is requesting information, false if it is only providing information