Class SignUpConfiguration.PasswordRecovery

  • Enclosing class:
    SignUpConfiguration

    public static final class SignUpConfiguration.PasswordRecovery
    extends java.lang.Object
    Configures the Password Recovery feature of the SignUp Assistant.

    The password recovery requires the client's name and returns either the old password from the database or generates a new one, based on how is configured the mode parameter.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.util.List<java.lang.String> allowedRecoveryFields
      Allows to specify which field in the DB should be used for password recovery.
      SignUpConfiguration.EmailConfig email
      The email configuration
      boolean isActive
      Turs on/off the Password Recovery
      RecoveryMode mode
      Specify the mode in which the Password Recovery service works SEND_OLD: sends the old password back GENERATE_NEW: generates a new password
      boolean useCaseSensitiveNameCheck
      Validates the user name using a case-sensitive string comparison
    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • isActive

        public boolean isActive
        Turs on/off the Password Recovery
      • useCaseSensitiveNameCheck

        public boolean useCaseSensitiveNameCheck
        Validates the user name using a case-sensitive string comparison
      • allowedRecoveryFields

        public java.util.List<java.lang.String> allowedRecoveryFields
        Allows to specify which field in the DB should be used for password recovery. This can be useful for clients that allow password recovery by username or email or other parameters. The client can send the name of the field to use and the data to match. The server will validate it against this list of this "allowed recovery fields".

        Default: null. In this case the match is allowed only for the user name field.

        Since:
        2.12
      • mode

        public RecoveryMode mode
        Specify the mode in which the Password Recovery service works
        • SEND_OLD
        • : sends the old password back
        • GENERATE_NEW
        • : generates a new password
    • Constructor Detail

      • PasswordRecovery

        public PasswordRecovery()