Package org.cyclos.services.access

Interface PasswordService

All Superinterfaces:

Service

public interface PasswordService
extends Service

Service for managing a user's passwords

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_PASSWORD_LENGTH	Max password length.
static int	MIN_PASSWORD_LENGTH	Min password length.

Method Summary

Modifier and Type	Method	Description
String	activate(@NotNull PasswordTypeVO passwordType)	Activates a password whose mode is PasswordMode.GENERATED creating a new password for the current user.
void	allowActivation(@NotNull PasswordActionDTO params)	Allows the given user to activate the given generated and pending password
void	change(@NotNull ChangePasswordDTO dto)	Manually changes a password
void	changeForgottenPassword(@NotNull ChangeForgottenPasswordDTO dto)	Changes a manual password leaving as PasswordStatus.ACTIVE, or if generated, send a new one (leaving as PasswordStatus.ACTIVE or PasswordStatus.RESET whether the user has the change permission or not)
void	disable(@NotNull PasswordActionDTO params)	Disables a password.
void	enable(@NotNull PasswordActionDTO params)	Enables a disabled password.
ForgotPasswordRequestResponse	forgotPasswordRequest(@NotNull ForgotPasswordRequestDTO params)	Initiates the forgot password operation, sending a code either by e-mail or SMS to the user.
String	generateNew(@NotNull ChangeGeneratedPasswordDTO params)	Allows to change a generated password by generating a new one
ChangeForgottenPasswordData	getChangeForgottenPasswordData(@NotNull GetChangeForgottenPasswordDataParams params)	Returns data for a forgot password change request
ChangePasswordData	getChangePasswordData(boolean changeSecondaryPassword)	Returns data for change the main/secondary access password (manual or generated)
UserPasswordsData	getData(@NotNull UserLocatorVO locator)	Returns data for user passwords
PasswordData	getPasswordData(@NotNull UserLocatorVO locator, @NotNull PasswordTypeVO type)	Returns data for a given password of the given user.
SetSecurityQuestionData	getSetSecurityQuestionData()	Returns data used to set the security question
List<String>	requestNewOTP(@NotNull SendMedium medium, String channel)	Generates a new OTP (removing any previous password, if any) and sends it by the specified medium using the confirmation mode configured the given channel for the logged user.
List<String>	requestNewOTPForSecondaryPassword(SendMedium medium)	Same as requestNewOTP(SendMedium, String) but using the secondary password type configured in the current channel for the logged user.
void	reset(@NotNull PasswordActionDTO params)	Resets the given generated password and allow it to be activated again
void	resetAndSend(@NotNull ResetAndSendPasswordDTO params)	Generates a new value of a manual password and send it to the user (for example, via e-mail).
void	resetSecurityQuestion(@NotNull UserLocatorVO locator)	Resets the security question, forcing the user to set a new one in the next login
void	setSecurityQuestion(@NotNull SetSecurityQuestionDTO params)	Sets the security question's answer for the logged user
void	unblock(@NotNull PasswordActionDTO params)	Unblocks the given user password

Field Detail

MIN_PASSWORD_LENGTH

static final int MIN_PASSWORD_LENGTH

Min password length.

See Also:

Constant Field Values

MAX_PASSWORD_LENGTH

static final int MAX_PASSWORD_LENGTH

Max password length.

See Also:

Constant Field Values

Method Detail

activate

String activate(@NotNull
                @NotNull PasswordTypeVO passwordType)
         throws FrameworkException

Activates a password whose mode is PasswordMode.GENERATED creating a new password for the current user.

Throws:

IllegalActionException - When the given password type is not generated, or is not in any of the following statuses:

• PasswordStatus.NEVER_CREATED
• PasswordStatus.PENDING
• PasswordStatus.EXPIRED
• PasswordStatus.RESET

FrameworkException

allowActivation

void allowActivation(@NotNull
                     @NotNull PasswordActionDTO params)
              throws FrameworkException

Allows the given user to activate the given generated and pending password

Throws:

IllegalActionException - When the given password is not generated / doesn't apply to the given user

FrameworkException

change

void change(@NotNull
            @NotNull ChangePasswordDTO dto)
     throws FrameworkException,
            PasswordException

Manually changes a password

Throws:

PasswordException - The current password is invalid

ValidationException - When the given new password is invalid according to the constraints

IllegalActionException - When the current password cannot be changed (for example, it is generated)

FrameworkException

changeForgottenPassword

void changeForgottenPassword(@NotNull
                             @NotNull ChangeForgottenPasswordDTO dto)
                      throws FrameworkException,
                             InvalidSecurityAnswerException,
                             PasswordException

Changes a manual password leaving as PasswordStatus.ACTIVE, or if generated, send a new one (leaving as PasswordStatus.ACTIVE or PasswordStatus.RESET whether the user has the change permission or not)

Throws:

FrameworkException

InvalidSecurityAnswerException

PasswordException

disable

void disable(@NotNull
             @NotNull PasswordActionDTO params)
      throws FrameworkException

Disables a password. A disabled password cannot be used again, unless re-enabled

Throws:

IllegalActionException - When the current password cannot be disabled (for example, is already disabled)

FrameworkException

enable

void enable(@NotNull
            @NotNull PasswordActionDTO params)
     throws FrameworkException

Enables a disabled password. A disabled password cannot be used again, unless re-enabled

Throws:

IllegalActionException - When the current password cannot be enabled (not in the disabled state)

FrameworkException

forgotPasswordRequest

ForgotPasswordRequestResponse forgotPasswordRequest(@NotNull
                                                    @NotNull ForgotPasswordRequestDTO params)
                                             throws FrameworkException,
                                                    RemoteAddressBlockedException

Initiates the forgot password operation, sending a code either by e-mail or SMS to the user. May also require a security question verification. Returns the e-mail address of phone numbers the code was sent to. The value will be masked if not the same one as requested in the params.

Throws:

FrameworkException

RemoteAddressBlockedException

generateNew

String generateNew(@NotNull
                   @NotNull ChangeGeneratedPasswordDTO params)
            throws FrameworkException

Allows to change a generated password by generating a new one

Throws:

FrameworkException

getChangeForgottenPasswordData

ChangeForgottenPasswordData getChangeForgottenPasswordData(@NotNull
                                                           @NotNull GetChangeForgottenPasswordDataParams params)
                                                    throws FrameworkException,
                                                           PasswordException

Returns data for a forgot password change request

Throws:

FrameworkException

PasswordException

getChangePasswordData

ChangePasswordData getChangePasswordData(boolean changeSecondaryPassword)
                                  throws FrameworkException

Returns data for change the main/secondary access password (manual or generated)

Throws:

FrameworkException

getData

UserPasswordsData getData(@NotNull
                          @NotNull UserLocatorVO locator)
                   throws FrameworkException

Returns data for user passwords

Throws:

FrameworkException

getPasswordData

PasswordData getPasswordData(@NotNull
                             @NotNull UserLocatorVO locator,
                             @NotNull
                             @NotNull PasswordTypeVO type)
                      throws FrameworkException

Returns data for a given password of the given user.

Throws:

FrameworkException

getSetSecurityQuestionData

SetSecurityQuestionData getSetSecurityQuestionData()
                                            throws FrameworkException

Returns data used to set the security question

Throws:

FrameworkException

requestNewOTP

List<String> requestNewOTP(@NotNull
                           @NotNull SendMedium medium,
                           String channel)
                    throws FrameworkException,
                           SmsSendingException

Generates a new OTP (removing any previous password, if any) and sends it by the specified medium using the confirmation mode configured the given channel for the logged user. If the channel is null then it use the current channel.

Parameters:

medium - the medium used to send the OTP.

channel - the channel used to get the confirmation mode configuration (password type / device)

Returns:

the email or the normalized phones number the OTP was sent.

Throws:

SmsSendingException - only if medium is SendMedium.SMS and the OTP could not be sent to any enabled for sms phone.

FrameworkException

requestNewOTPForSecondaryPassword

List<String> requestNewOTPForSecondaryPassword(SendMedium medium)
                                        throws FrameworkException,
                                               SmsSendingException

Same as requestNewOTP(SendMedium, String) but using the secondary password type configured in the current channel for the logged user.

Throws:

FrameworkException

SmsSendingException

reset

void reset(@NotNull
           @NotNull PasswordActionDTO params)
    throws FrameworkException

Resets the given generated password and allow it to be activated again

Throws:

FrameworkException

resetAndSend

void resetAndSend(@NotNull
                  @NotNull ResetAndSendPasswordDTO params)
           throws FrameworkException

Generates a new value of a manual password and send it to the user (for example, via e-mail). If the password is generated, it will be initially active. If it is manual, it will keep the status PasswordStatus.RESET, forcing the user to change it.

Throws:

FrameworkException

resetSecurityQuestion

void resetSecurityQuestion(@NotNull
                           @NotNull UserLocatorVO locator)
                    throws FrameworkException

Resets the security question, forcing the user to set a new one in the next login

Throws:

FrameworkException

setSecurityQuestion

void setSecurityQuestion(@NotNull
                         @NotNull SetSecurityQuestionDTO params)
                  throws FrameworkException

Sets the security question's answer for the logged user

Throws:

FrameworkException

unblock

void unblock(@NotNull
             @NotNull PasswordActionDTO params)
      throws FrameworkException

Unblocks the given user password

Throws:

IllegalActionException - When the given password is not blocked / doesn't apply to the given user

FrameworkException