org.cyclos.security.access

Class PasswordServiceSecurity

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.security.BaseServiceSecurity

org.cyclos.security.access.PasswordServiceSecurity

All Implemented Interfaces:

PasswordService, Service

@Security
public class PasswordServiceSecurity
extends BaseServiceSecurity
implements PasswordService

Security layer for password checks

Author:

luis

Constructor Summary

Constructors

Constructor and Description
PasswordServiceSecurity()

Method Summary

Modifier and Type	Method and Description
java.lang.String	activate(PasswordTypeVO passwordTypeVO) 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
protected org.cyclos.impl.access.EntityCheck<?>	resolveEntityCheck() Must be implemented in order to return the EntityCheck managed by this security component, or null if none
void	setSecurityQuestion(SetSecurityQuestionDTO params) Sets the security question's answer for the logged user
void	unblock(PasswordActionDTO params) Unblocks the given user password

Methods inherited from class org.cyclos.security.BaseServiceSecurity

checkGuest, checkId, checkIds, checkInternalName, checkLoggedIn, checkManagesUser, checkRelatesToUser, checkVO, checkVOs, doInitialize, getEntityCheckRegistry, getUser, initialize

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getAccountHandler, getAuthHandler, getBaseEntityManagerHandler, getChannelConfiguration, getConfiguration, getConversionHandler, getCustomFieldValueHandler, getEntityManagerHandler, getGroupsHandler, getLoggedBasicUser, getLoggedUser, getProducts, getProductsHandler, getReportHandler, getTranslatedName, getTranslatedValue, getUserLocatorHandler, getValidationResult, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

delete, detach, find, flush, from, getApplicationContext, getConfigurationHandler, getDataTranslationHandler, getFormatter, getFormatter, getFormatter, getLogger, getNotificationHandler, getProfileFieldHandler, getRemoteAddress, getSessionData, getTransactionHandler, getTranslationHandler, message, message, persist, processBatch, refresh, remove, subQuery, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PasswordServiceSecurity

public PasswordServiceSecurity()

Method Detail

activate

public java.lang.String activate(PasswordTypeVO passwordTypeVO)
                          throws FrameworkException,
                                 IllegalActionException

Description copied from interface: PasswordService

Activates the generated password a new password for the current user

Specified by:

activate in interface PasswordService

Throws:

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

FrameworkException

allowActivation

public void allowActivation(PasswordActionDTO params)
                     throws FrameworkException,
                            IllegalActionException

Description copied from interface: PasswordService

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

Specified by:

allowActivation in interface PasswordService

Throws:

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

FrameworkException

change

public void change(ChangePasswordDTO dto)
            throws FrameworkException,
                   IllegalActionException,
                   PasswordException,
                   ValidationException

Description copied from interface: PasswordService

Manually changes a password

Specified by:

change in interface PasswordService

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

public void changeForgottenPassword(ChangeForgottenPasswordDTO dto)
                             throws FrameworkException,
                                    InvalidSecurityAnswerException

Description copied from interface: PasswordService

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

Specified by:

changeForgottenPassword in interface PasswordService

Throws:

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

FrameworkException

InvalidSecurityAnswerException

disable

public void disable(PasswordActionDTO params)
             throws FrameworkException,
                    IllegalActionException

Description copied from interface: PasswordService

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

Specified by:

disable in interface PasswordService

Throws:

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

FrameworkException

enable

public void enable(PasswordActionDTO params)
            throws FrameworkException,
                   IllegalActionException

Description copied from interface: PasswordService

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

Specified by:

enable in interface PasswordService

Throws:

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

FrameworkException

forgotPasswordRequest

public void forgotPasswordRequest(ForgotPasswordRequestDTO params)
                           throws FrameworkException

Description copied from interface: PasswordService

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.

Specified by:

forgotPasswordRequest in interface PasswordService

Throws:

FrameworkException

generateNew

public java.lang.String generateNew(ChangeGeneratedPasswordDTO params)
                             throws FrameworkException,
                                    IllegalActionException

Description copied from interface: PasswordService

Allows to change a generated password by generating a new one

Specified by:

generateNew in interface PasswordService

Throws:

FrameworkException

IllegalActionException

getChangeForgottenPasswordData

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

Description copied from interface: PasswordService

Returns data for a forgot password change request

Specified by:

getChangeForgottenPasswordData in interface PasswordService

Throws:

FrameworkException

getChangePasswordData

public ChangePasswordData getChangePasswordData()
                                         throws FrameworkException

Description copied from interface: PasswordService

Returns data for change the main login password

Specified by:

getChangePasswordData in interface PasswordService

Throws:

FrameworkException

getData

public UserPasswordsData getData(UserLocatorVO locator)
                          throws FrameworkException

Description copied from interface: PasswordService

Returns data for user passwords

Specified by:

getData in interface PasswordService

Throws:

FrameworkException

requestNewOTP

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

Description copied from interface: PasswordService

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.

Specified by:

requestNewOTP in interface PasswordService

Parameters:

medium - the medium used to send the OTP.

Returns:

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

Throws:

FrameworkException

reset

public void reset(PasswordActionDTO params)
           throws FrameworkException,
                  IllegalActionException

Description copied from interface: PasswordService

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

Specified by:

reset in interface PasswordService

Throws:

FrameworkException

IllegalActionException

resetAndSend

public void resetAndSend(PasswordActionDTO params)
                  throws FrameworkException,
                         IllegalActionException

Description copied from interface: PasswordService

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.

Specified by:

resetAndSend in interface PasswordService

Throws:

FrameworkException

IllegalActionException

resetSecurityQuestion

public void resetSecurityQuestion(UserLocatorVO locator)
                           throws FrameworkException

Description copied from interface: PasswordService

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

Specified by:

resetSecurityQuestion in interface PasswordService

Throws:

FrameworkException

setSecurityQuestion

public void setSecurityQuestion(SetSecurityQuestionDTO params)
                         throws FrameworkException

Description copied from interface: PasswordService

Sets the security question's answer for the logged user

Specified by:

setSecurityQuestion in interface PasswordService

Throws:

FrameworkException

unblock

public void unblock(PasswordActionDTO params)
             throws FrameworkException,
                    IllegalActionException

Description copied from interface: PasswordService

Unblocks the given user password

Specified by:

unblock in interface PasswordService

Throws:

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

FrameworkException

resolveEntityCheck

protected org.cyclos.impl.access.EntityCheck<?> resolveEntityCheck()

Description copied from class: BaseServiceSecurity

Must be implemented in order to return the EntityCheck managed by this security component, or null if none

Specified by:

resolveEntityCheck in class BaseServiceSecurity