Interface AuthPasswordResetService

    • Method Detail

      • isEnabled

        boolean isEnabled()
        Checks whether password reset service is enabled.
        Returns:
        true if enabled
      • submitForgotPassword

        void submitForgotPassword​(String emailAddress)
                           throws MailException
        Submits forgot password.

        Consumes existing password reset tokens for user and sends a password reset email.

        Parameters:
        emailAddress - the email address of the user
        Throws:
        MailException - on email sending failure
      • checkToken

        void checkToken​(String token)
        Checks whether the token is valid.
        Parameters:
        token - the password reset token
        Throws:
        IllegalArgumentException - if the token is invalid
      • changePassword

        void changePassword​(String token,
                            String password)
        Changes the user password and marks the token as consumed.
        Parameters:
        token - the password reset token
        password - the new password
        Throws:
        IllegalArgumentException - if the token is invalid
        IllegalArgumentException - if the password is invalid