Package org.cyclos.impl.access

Class PasswordServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.access.PasswordServiceImpl

All Implemented Interfaces:

PasswordServiceLocal, PasswordService, Service

@Service
public class PasswordServiceImpl
extends BaseServiceImpl
implements PasswordServiceLocal

Implementation for PasswordService

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	PasswordServiceImpl.CharsetValidation

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, customFieldValueHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.services.access.PasswordService

MAX_PASSWORD_LENGTH, MIN_PASSWORD_LENGTH

Constructor Summary

Constructors

Constructor	Description
PasswordServiceImpl()

Method Summary

Modifier and Type	Method	Description
String	activate(PasswordTypeVO passwordTypeVO)	Activates a password whose mode is PasswordMode.GENERATED creating a new password for the current user.
void	addValidations(Property property, BasicUser user, String username, PasswordType passwordType, boolean atRegistration)	Adds all password validations according to specified password type.
void	allowActivation(PasswordActionDTO params)	Allows the given user to activate the given generated and pending password
void	blockByTries(Password password)	Blocks the given password for exceeding tries
void	change(ChangePasswordDTO dto)	Manually changes a password
void	changeForgottenPassword(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)
Pair<String,Password>	create(BasicUser user, PasswordType passwordType, String value, PasswordStatus status)	Creates a password for the given user and password type.
void	disable(PasswordActionDTO params)	Disables a password.
void	enable(PasswordActionDTO params)	Enables a disabled password.
boolean	exists(BasicUser user, PasswordType type)	Returns whether a valid password exists for the given user / password type
ForgotPasswordRequestResponse	forgotPasswordRequest(ForgotPasswordRequestDTO params)	Initiates the forgot password operation, sending a code either by e-mail or SMS to the user.
String	generateNew(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(UserLocatorVO locator)	Returns data for user passwords
Date	getExpirationDate(Password password)	Returns the expiration date according to the password's type.
Pair<Password,PasswordStatus>	getPasswordAndStatus(BasicUser user, PasswordType passwordType)	Returns the status and the password record for the given user and password type.
PasswordData	getPasswordData(BasicUser user, PasswordType passwordType)	Returns the PasswordData for the given user and password type.
PasswordData	getPasswordData(UserLocatorVO locator, PasswordTypeVO passwordTypeVO)	Returns data for a given password of the given user.
List<PasswordLog>	getPasswordLogs(BasicUser user, PasswordType passwordType)	Returns the logs for the passwords of the given type and user
PropertyAccess	getPropertyAccess(Property<?,?> property, PasswordType passwordType, String value)	Returns a PropertyAccess for a validation suitable for a specific password type
PasswordStatus	getRedundantAccessPasswordStatus(BasicUser user, PasswordType type)	Returns the redundant password status for the given type. The redundant statuses are stored directly in the user entity only for the password types set for access (including secondary login)
SetSecurityQuestionData	getSetSecurityQuestionData()	Returns data used to set the security question
Pair<PasswordStatus,Set<PasswordAction>>	getStatusAndActions(BasicUser user, PasswordType passwordType)	Similar to PasswordService.getData(org.cyclos.model.users.users.UserLocatorVO), but with fewer data and preventing calculating the status twice
boolean	isPendingSecurityQuestion()	Returns whether the currently authenticated user needs to set a security question
boolean	isUserCanChangePassword(BasicUser user, PasswordType passwordType)	Returns if the given user can change the password for the given type
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
boolean	remove(BasicUser user, PasswordType passwordType)	Removes the password of the given user and type
List<String>	requestNewOTP(SendMedium medium, String channel, List<Long> mobilePhones)	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, List<Long> mobilePhones)	Same as #requestNewOTP(SendMedium, String) but using the secondary 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(ResetAndSendPasswordDTO 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(BasicUser user, SetSecurityQuestionDTO params)	Sets the securiy question for the given user
void	setSecurityQuestion(SetSecurityQuestionDTO params)	Sets the security question's answer for the logged user
void	unblock(PasswordActionDTO params)	Unblocks the given user password
void	updateUser(BasicUser user)	Update the redundant password status information on the user

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Constructor Detail

PasswordServiceImpl

public PasswordServiceImpl()

Method Detail

activate

public String activate(PasswordTypeVO passwordTypeVO)
                throws FrameworkException,
                       IllegalActionException

Description copied from interface: PasswordService

Activates a password whose mode is PasswordMode.GENERATED creating 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 any of the following statuses:

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

FrameworkException

addValidations

public void addValidations(Property property,
                           BasicUser user,
                           String username,
                           PasswordType passwordType,
                           boolean atRegistration)

Description copied from interface: PasswordServiceLocal

Adds all password validations according to specified password type.

Specified by:

addValidations in interface PasswordServiceLocal

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

blockByTries

public void blockByTries(Password password)

Description copied from interface: PasswordServiceLocal

Blocks the given password for exceeding tries

Specified by:

blockByTries in interface PasswordServiceLocal

change

public void change(ChangePasswordDTO dto)

Description copied from interface: PasswordService

Manually changes a password

Specified by:

change in interface PasswordService

changeForgottenPassword

public void changeForgottenPassword(ChangeForgottenPasswordDTO dto)
                             throws FrameworkException,
                                    InvalidSecurityAnswerException

Description copied from interface: PasswordService

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)

Specified by:

changeForgottenPassword in interface PasswordService

Throws:

FrameworkException

InvalidSecurityAnswerException

create

public Pair<String,Password> create(BasicUser user,
                                          PasswordType passwordType,
                                          String value,
                                          PasswordStatus status)
                                   throws FrameworkException,
                                          IllegalActionException

Description copied from interface: PasswordServiceLocal

Creates a password for the given user and password type. When the given password is null, a value is generated if status is PasswordStatus.ACTIVE, PasswordStatus.EXPIRED, PasswordStatus.RESET.

Specified by:

create in interface PasswordServiceLocal

Returns:

a pair with the plain password value and the Password entity.

Throws:

IllegalActionException - When the given password type doesn't apply to the given user or the password should be generated

FrameworkException

disable

public void disable(PasswordActionDTO params)

Description copied from interface: PasswordService

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

Specified by:

disable in interface PasswordService

enable

public void enable(PasswordActionDTO params)

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

exists

public boolean exists(BasicUser user,
                      PasswordType type)

Description copied from interface: PasswordServiceLocal

Returns whether a valid password exists for the given user / password type

Specified by:

exists in interface PasswordServiceLocal

forgotPasswordRequest

public ForgotPasswordRequestResponse forgotPasswordRequest(ForgotPasswordRequestDTO params)
                                                    throws FrameworkException

Description copied from interface: PasswordService

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.

Specified by:

forgotPasswordRequest in interface PasswordService

Throws:

FrameworkException

generateNew

public String generateNew(ChangeGeneratedPasswordDTO params)

Description copied from interface: PasswordService

Allows to change a generated password by generating a new one

Specified by:

generateNew in interface PasswordService

getChangeForgottenPasswordData

public ChangeForgottenPasswordData getChangeForgottenPasswordData(@NotNull
                                                                  @NotNull GetChangeForgottenPasswordDataParams params)
                                                           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(boolean changeSecondaryPassword)
                                         throws FrameworkException

Description copied from interface: PasswordService

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

Specified by:

getChangePasswordData in interface PasswordService

Throws:

FrameworkException

getData

public UserPasswordsData getData(UserLocatorVO locator)

Description copied from interface: PasswordService

Returns data for user passwords

Specified by:

getData in interface PasswordService

getExpirationDate

public Date getExpirationDate(Password password)

Description copied from interface: PasswordServiceLocal

Returns the expiration date according to the password's type. Null if the password does not expire.

Specified by:

getExpirationDate in interface PasswordServiceLocal

getPasswordAndStatus

public Pair<Password,PasswordStatus> getPasswordAndStatus(BasicUser user,
                                                                PasswordType passwordType)

Description copied from interface: PasswordServiceLocal

Returns the status and the password record for the given user and password type. The returned status may be different from the one in the password. For example, the password might have never been created (will be null) or there could be one of the calculated statuses, like blocked or expired.

Specified by:

getPasswordAndStatus in interface PasswordServiceLocal

getPasswordData

public PasswordData getPasswordData(BasicUser user,
                                    PasswordType passwordType)
                             throws FrameworkException

Description copied from interface: PasswordServiceLocal

Returns the PasswordData for the given user and password type.

Specified by:

getPasswordData in interface PasswordServiceLocal

Throws:

FrameworkException

getPasswordData

public PasswordData getPasswordData(UserLocatorVO locator,
                                    PasswordTypeVO passwordTypeVO)
                             throws FrameworkException

Description copied from interface: PasswordService

Returns data for a given password of the given user.

Specified by:

getPasswordData in interface PasswordService

Throws:

FrameworkException

getPasswordLogs

public List<PasswordLog> getPasswordLogs(BasicUser user,
                                         PasswordType passwordType)

Description copied from interface: PasswordServiceLocal

Returns the logs for the passwords of the given type and user

Specified by:

getPasswordLogs in interface PasswordServiceLocal

getPropertyAccess

public PropertyAccess getPropertyAccess(Property<?,?> property,
                                        PasswordType passwordType,
                                        String value)

Description copied from interface: PasswordServiceLocal

Returns a PropertyAccess for a validation suitable for a specific password type

Specified by:

getPropertyAccess in interface PasswordServiceLocal

getRedundantAccessPasswordStatus

public PasswordStatus getRedundantAccessPasswordStatus(BasicUser user,
                                                       PasswordType type)

Description copied from interface: PasswordServiceLocal

Returns the redundant password status for the given type.
The redundant statuses are stored directly in the user entity only for the password types set for access (including secondary login)

Specified by:

getRedundantAccessPasswordStatus in interface PasswordServiceLocal

getSetSecurityQuestionData

public SetSecurityQuestionData getSetSecurityQuestionData()
                                                   throws FrameworkException

Description copied from interface: PasswordService

Returns data used to set the security question

Specified by:

getSetSecurityQuestionData in interface PasswordService

Throws:

FrameworkException

getStatusAndActions

public Pair<PasswordStatus,Set<PasswordAction>> getStatusAndActions(BasicUser user,
                                                                          PasswordType passwordType)
                                                                   throws FrameworkException

Description copied from interface: PasswordServiceLocal

Similar to PasswordService.getData(org.cyclos.model.users.users.UserLocatorVO), but with fewer data and preventing calculating the status twice

Specified by:

getStatusAndActions in interface PasswordServiceLocal

Throws:

FrameworkException

isPendingSecurityQuestion

public boolean isPendingSecurityQuestion()

Description copied from interface: PasswordServiceLocal

Returns whether the currently authenticated user needs to set a security question

Specified by:

isPendingSecurityQuestion in interface PasswordServiceLocal

isUserCanChangePassword

public boolean isUserCanChangePassword(BasicUser user,
                                       PasswordType passwordType)
                                throws FrameworkException

Description copied from interface: PasswordServiceLocal

Returns if the given user can change the password for the given type

Specified by:

isUserCanChangePassword in interface PasswordServiceLocal

Throws:

FrameworkException

remove

public boolean remove(BasicUser user,
                      PasswordType passwordType)
               throws FrameworkException

Description copied from interface: PasswordServiceLocal

Removes the password of the given user and type

Specified by:

remove in interface PasswordServiceLocal

Throws:

FrameworkException

requestNewOTP

public List<String> requestNewOTP(SendMedium medium,
                                  String channel,
                                  List<Long> mobilePhones)
                           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 mode configured the given channel for the logged user. If the channel is null then it use the current channel.

Specified by:

requestNewOTP in interface PasswordService

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

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

Description copied from interface: PasswordService

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

Specified by:

requestNewOTPForSecondaryPassword in interface PasswordService

Throws:

FrameworkException

SmsSendingException

reset

public void reset(PasswordActionDTO params)

Description copied from interface: PasswordService

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

Specified by:

reset in interface PasswordService

resetAndSend

public void resetAndSend(ResetAndSendPasswordDTO params)

Description copied from interface: PasswordService

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.

Specified by:

resetAndSend in interface PasswordService

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(BasicUser user,
                                SetSecurityQuestionDTO params)

Description copied from interface: PasswordServiceLocal

Sets the securiy question for the given user

Specified by:

setSecurityQuestion in interface PasswordServiceLocal

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)

Description copied from interface: PasswordService

Unblocks the given user password

Specified by:

unblock in interface PasswordService

updateUser

public void updateUser(BasicUser user)

Description copied from interface: PasswordServiceLocal

Update the redundant password status information on the user

Specified by:

updateUser in interface PasswordServiceLocal

See Also:

getRedundantAccessPasswordStatus(BasicUser, PasswordType)

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl