org.cyclos.services.access

Interface PasswordService

All Superinterfaces:

Service

All Known Subinterfaces:

PasswordServiceLocal

public interface PasswordService
extends Service

Service for managing an user's passwords

Author:

rodrigo

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	activate(java.lang.Long passwordTypeId) Activates the generated password a new password for the current user
void	allowActivation(UserLocatorVO locator, java.lang.Long passwordTypeId) 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(UserLocatorVO locator, java.lang.Long passwordTypeId) Disables a password.
void	enable(UserLocatorVO locator, java.lang.Long passwordTypeId) 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(UserLocatorVO locator, java.lang.Long passwordTypeId) 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
void	reset(UserLocatorVO locator, java.lang.Long passwordTypeId) Resets the given generated password and allow it to be activated again
void	resetAndSend(UserLocatorVO locator, java.lang.Long passwordTypeId) 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(UserLocatorVO locator, java.lang.Long passwordTypeId) Unblocks the given user password

Method Detail

activate

java.lang.String activate(java.lang.Long passwordTypeId)
                          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(UserLocatorVO locator,
                   java.lang.Long passwordTypeId)
                     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(UserLocatorVO locator,
           java.lang.Long passwordTypeId)
             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(UserLocatorVO locator,
          java.lang.Long passwordTypeId)
            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

Initiates the forgot password operation, allowing the user to set another password based on an e-mail token and security question verification

Throws:

FrameworkException

generateNew

java.lang.String generateNew(UserLocatorVO locator,
                           java.lang.Long passwordTypeId)
                             throws FrameworkException,
                                    IllegalActionException

Allows to change a generated password by generating a new one

Throws:

FrameworkException

IllegalActionException

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

reset

void reset(UserLocatorVO locator,
         java.lang.Long passwordTypeId)
           throws FrameworkException

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

Throws:

FrameworkException

resetAndSend

void resetAndSend(UserLocatorVO locator,
                java.lang.Long passwordTypeId)
                  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(UserLocatorVO locator,
           java.lang.Long passwordTypeId)
             throws FrameworkException

Unblocks the given user password

Throws:

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

FrameworkException