org.cyclos.services.access

Interface PasswordService

All Superinterfaces:

Service

public interface PasswordService
extends Service

Service for managing an user's passwords

Author:

rodrigo

Method Summary

Modifier and Type	Method and Description
java.lang.String	activate(PasswordTypeVO passwordType) Activates the generated password a new password for the current user
void	allowActivation(PasswordActionDTO params) Allows the given user to activate the given generated and pending password
void	change(ChangePasswordDTO dto) Manually changes a password
void	changeForgottenPassword(ChangeForgottenPasswordDTO dto) Changes a forgotten password, or resets it, in case of manual password
void	disable(PasswordActionDTO params) Disables a password.
void	enable(PasswordActionDTO params) Enables a disabled password.
void	forgotPasswordRequest(ForgotPasswordRequestDTO params) Initiates the forgot password operation, allowing the user to set another password based on an e-mail token and security question verification.
java.lang.String	generateNew(ChangeGeneratedPasswordDTO params) Allows to change a generated password by generating a new one
ChangeForgottenPasswordData	getChangeForgottenPasswordData(java.lang.String validationKey) Returns data for a forgot password change request
ChangePasswordData	getChangePasswordData() Returns data for change the main login password
UserPasswordsData	getData(UserLocatorVO locator) Returns data for user passwords
java.util.List<java.lang.String>	requestNewOTP(OTPSendMedium medium) Generates a new OTP (removing any previous password, if any) and sends it by the specified medium using the confirmation password type configured in the current channel for the logged user.
void	reset(PasswordActionDTO params) Resets the given generated password and allow it to be activated again
void	resetAndSend(PasswordActionDTO params) Generates a new value of a manual password and send it to the user (for example, via e-mail).
void	resetSecurityQuestion(UserLocatorVO locator) Resets the security question, forcing the user to set a new one in the next login
void	setSecurityQuestion(SetSecurityQuestionDTO params) Sets the security question's answer for the logged user
void	unblock(PasswordActionDTO params) Unblocks the given user password

Method Detail

activate

java.lang.String activate(PasswordTypeVO passwordType)
                   throws FrameworkException

Activates the generated password a new password for the current user

Throws:

IllegalActionException - When the given password type is not generated, or is not in the pending state

FrameworkException

allowActivation

void allowActivation(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(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(ChangeForgottenPasswordDTO dto)
                      throws FrameworkException,
                             InvalidSecurityAnswerException

Changes a forgotten password, or resets it, in case of manual password

Throws:

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

FrameworkException

InvalidSecurityAnswerException

disable

void disable(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(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

void forgotPasswordRequest(ForgotPasswordRequestDTO params)
                    throws FrameworkException,
                           RemoteAddressBlockedException

Initiates the forgot password operation, allowing the user to set another password based on an e-mail token and security question verification. Returns the generated key which is used to complete the request.

Throws:

FrameworkException

RemoteAddressBlockedException

generateNew

java.lang.String generateNew(ChangeGeneratedPasswordDTO params)
                      throws FrameworkException

Allows to change a generated password by generating a new one

Throws:

FrameworkException

getChangeForgottenPasswordData

ChangeForgottenPasswordData getChangeForgottenPasswordData(java.lang.String validationKey)
                                                    throws FrameworkException

Returns data for a forgot password change request

Throws:

FrameworkException

getChangePasswordData

ChangePasswordData getChangePasswordData()
                                  throws FrameworkException

Returns data for change the main login password

Throws:

FrameworkException

getData

UserPasswordsData getData(UserLocatorVO locator)
                   throws FrameworkException

Returns data for user passwords

Throws:

FrameworkException

requestNewOTP

java.util.List<java.lang.String> requestNewOTP(OTPSendMedium medium)
                                        throws FrameworkException,
                                               SmsSendingException

Generates a new OTP (removing any previous password, if any) and sends it by the specified medium using the confirmation password type configured in the current channel for the logged user.

Parameters:

medium - the medium used to send the OTP.

Returns:

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

Throws:

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

FrameworkException

reset

void reset(PasswordActionDTO params)
    throws FrameworkException

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

Throws:

FrameworkException

resetAndSend

void resetAndSend(PasswordActionDTO params)
           throws FrameworkException

Generates a new value of a manual password and send it to the user (for example, via e-mail). The new password is initially expired, so the user will be forced to change it.

Throws:

FrameworkException

resetSecurityQuestion

void resetSecurityQuestion(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(SetSecurityQuestionDTO params)
                  throws FrameworkException

Sets the security question's answer for the logged user

Throws:

FrameworkException

unblock

void unblock(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