Package com.axelor.auth
Interface AuthPasswordResetService
-
- All Known Implementing Classes:
AuthPasswordResetServiceImpl
public interface AuthPasswordResetService
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
changePassword(String token, String password)
Changes the user password and marks the token as consumed.void
checkToken(String token)
Checks whether the token is valid.boolean
isEnabled()
Checks whether password reset service is enabled.void
submitForgotPassword(String emailAddress)
Submits forgot password.
-
-
-
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 tokenpassword
- the new password- Throws:
IllegalArgumentException
- if the token is invalidIllegalArgumentException
- if the password is invalid
-
-