Package org.cyclos.impl.users

Class UserValidationServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.users.UserValidationServiceImpl

All Implemented Interfaces:

UserValidationServiceLocal, Service, UserValidationService

@Service
public class UserValidationServiceImpl
extends BaseServiceImpl
implements UserValidationServiceLocal

Implementation for UserValidationServiceLocal

Field Summary

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

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

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, transactionHandler, translationHandler

Constructor Summary

Constructors

Constructor	Description
UserValidationServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	addNameValidations(Property name, BasicUserDTO dto)	As the CRUD service forces a custom handling of the name property, this needs to be in a separate method
void	addRegistrationValidations(Validator validator, SimpleBasicUserRegistrationDTO dto, UserRegistration registration, BasicUser basicUser, UserValidationFields fields)	Add common validations for registering a user or operator
void	addValidations(Validator validator, BasicUserDTO dto, BasicUser user, UserValidationFields fields)	Add common validations for saving the profile of a user or operator.
UserRegistrationResult	buildRegistrationResult(BasicUser user, Set<PasswordType> generatedPasswordTypes)	Builds the registration result for the given user.
boolean	canViewProfile(BasicUser user)	Returns true if the logged user can view the profile of the given user. NOTE: Take into account that a user can be related to a user but not see its profile, e.g a user can relates to an operator of another user (through the Permission.USER_OPERATORS_PAY) but he can't view the operator profile.
void	clearValidationKey(BasicUser user)	Removes all user data related to a validation key
List<ProfileField>	fillProfileFields(BasicUser user, AbstractViewProfileData data)	Fills in the visible profile fields of the given user on the given view profile data
void	fillRegistrationData(SimpleBasicUserRegistrationData data, UserRegistration registration, BasicUser basicUser)	Fills with common data for registering users or operators
Map<PasswordType,String>	finishActivation(BasicUser user)	Generate the passwords and send the activation e-mail for the given user
List<UserPrincipalData>	getPrincipalsData(BasicUser basicUser, Channel channel)	Returns a list of UserPrincipalData for all PrincipalType where the corresponding ProfileField is enabled for the user. Each element of the list contains: The PrincipalType. The principal as String A list of ChannelVO where the principal type can be used to access the channel.
BasicUser	getUserForForgotPassword(UserLocatorVO locator, String code)	Returns the user in the current network with a forgot password request with the given code
BasicUser	getUserForValidationKey(ValidationKeyType type, String validationKey)	Returns the user in the current network with the given validation key
boolean	isEmailTaken(ConfigurationAccessor configuration, String email)	Returns whether there's a non-removed user with this e-mail.
boolean	isMobileNumberTaken(ConfigurationAccessor configuration, String number)	Returns whether there's a non-removed user with this mobile phone number.
boolean	isNameRequired(BasicUserDTO basicDto)	Returns whether we should require the full name when saving the given user
boolean	isUsernameTaken(ConfigurationAccessor configuration, String username)	Returns whether there's a non-removed user with this username.
void	manuallyValidateEmailChange(UserLocatorVO locator)	Makes a pending e-mail change as done
UserValidationResult	manuallyValidateRegistration(UserLocatorVO locator)	Makes a pending user to be active
void	persistAdditionalRegistrationData(BasicUser basicUser, SimpleBasicUserRegistrationDTO dto, List<ProfileField> editableFields)	Persists additional data that is saved together with the user, such as phones or addresses
<BU extends BasicUser> BU	preProcessRegistration(SimpleBasicUserRegistrationDTO dto, UserRegistration registration)	Returns a pre-populated user for persisting
Map<PasswordType,String>	processRegistration(BasicUser basicUser, SimpleBasicUserRegistrationDTO dto)	Processes a user registration.
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
void	reindex(BasicUser user)	Reindex the given user updating its custom field values according to the products and also its display.
boolean	requiresEmailChangeValidation(BasicUser basicUser)	Returns true if the system requires the user to validate the email upon email modification
void	resendEmailChangeMail(UserLocatorVO locator)	Re-sends the e-mail change e-mail to a user
void	resendRegistrationValidationMail(UserLocatorVO locator)	Re-sends the validation mail to a pending user
void	setEmailChangeValidation(BasicUser user, String originalEmail)	Sets the user validation key for e-mail change confirmation, restores the original e-mail (saving the current e-mail in new email) and sends the e-mail
List<OutboundSms>	setForgotPasswordValidation(BasicUser user, SendMedium sendMedium)	Sends the change forgotten password code by the given send medium.
boolean	shouldCheckConfirmationPassword(BasicUser user, CRUDOperation operation)	Controls whether confirmation password should be checked for the given basic user and operation.
DBQuery<?>	uniqueEmailQuery(Network network, BasicUserDTO dto)	Returns a query suited to check the e-mail uniqueness of the given user
void	updateDisplay(BasicUser user)	Updates display fields in the given user according to his/hers current configuration
void	updateUserActivity(UserActivityType type)	Updates user information status according to the given activity
Long	validateEmailChange(String validationKey)	Validate an e-mail change for the given validation key, returning the affected user identifier
UserValidationResult	validateRegistration(String validationKey)	Validate user registration which was pending e-mail verification, via a provided key

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

UserValidationServiceImpl

public UserValidationServiceImpl()

Method Detail

addNameValidations

public void addNameValidations(Property name,
                               BasicUserDTO dto)
                        throws FrameworkException

Description copied from interface: UserValidationServiceLocal

As the CRUD service forces a custom handling of the name property, this needs to be in a separate method

Specified by:

addNameValidations in interface UserValidationServiceLocal

Throws:

FrameworkException

addRegistrationValidations

public void addRegistrationValidations(Validator validator,
                                       SimpleBasicUserRegistrationDTO dto,
                                       UserRegistration registration,
                                       BasicUser basicUser,
                                       UserValidationFields fields)

Description copied from interface: UserValidationServiceLocal

Add common validations for registering a user or operator

Specified by:

addRegistrationValidations in interface UserValidationServiceLocal

addValidations

public void addValidations(Validator validator,
                           BasicUserDTO dto,
                           BasicUser user,
                           UserValidationFields fields)

Description copied from interface: UserValidationServiceLocal

Add common validations for saving the profile of a user or operator. PRE: in case of a new user registration the user parameter MUST have set the registration type.

Specified by:

addValidations in interface UserValidationServiceLocal

buildRegistrationResult

public UserRegistrationResult buildRegistrationResult(BasicUser user,
                                                      Set<PasswordType> generatedPasswordTypes)

Description copied from interface: UserValidationServiceLocal

Builds the registration result for the given user.

Specified by:

buildRegistrationResult in interface UserValidationServiceLocal

Parameters:

user - the already registered user

generatedPasswordTypes - set of password types for which the passwords were generated.

canViewProfile

public boolean canViewProfile(BasicUser user)

Description copied from interface: UserValidationServiceLocal

Returns true if the logged user can view the profile of the given user.
NOTE: Take into account that a user can be related to a user but not see its profile, e.g a user can relates to an operator of another user (through the Permission.USER_OPERATORS_PAY) but he can't view the operator profile.

Specified by:

canViewProfile in interface UserValidationServiceLocal

clearValidationKey

public void clearValidationKey(BasicUser user)
                        throws FrameworkException

Description copied from interface: UserValidationServiceLocal

Removes all user data related to a validation key

Specified by:

clearValidationKey in interface UserValidationServiceLocal

Throws:

FrameworkException

fillProfileFields

public List<ProfileField> fillProfileFields(BasicUser user,
                                            AbstractViewProfileData data)

Description copied from interface: UserValidationServiceLocal

Fills in the visible profile fields of the given user on the given view profile data

Specified by:

fillProfileFields in interface UserValidationServiceLocal

fillRegistrationData

public void fillRegistrationData(SimpleBasicUserRegistrationData data,
                                 UserRegistration registration,
                                 BasicUser basicUser)

Description copied from interface: UserValidationServiceLocal

Fills with common data for registering users or operators

Specified by:

fillRegistrationData in interface UserValidationServiceLocal

finishActivation

public Map<PasswordType,String> finishActivation(BasicUser user)

Generate the passwords and send the activation e-mail for the given user

Specified by:

finishActivation in interface UserValidationServiceLocal

getPrincipalsData

public List<UserPrincipalData> getPrincipalsData(BasicUser basicUser,
                                                 Channel channel)

Description copied from interface: UserValidationServiceLocal

Returns a list of UserPrincipalData for all PrincipalType where the corresponding ProfileField is enabled for the user.
Each element of the list contains:

• The PrincipalType.
• The principal as String
• A list of ChannelVO where the principal type can be used to access the channel.

Specified by:

getPrincipalsData in interface UserValidationServiceLocal

channel - create the list for all principal types used to access the channel (if accessible). If null then uses all accessible channels for the given user to get the principals types.

getUserForForgotPassword

public BasicUser getUserForForgotPassword(UserLocatorVO locator,
                                          String code)
                                   throws InvalidForgotPasswordCodeException

Description copied from interface: UserValidationServiceLocal

Returns the user in the current network with a forgot password request with the given code

Specified by:

getUserForForgotPassword in interface UserValidationServiceLocal

Throws:

InvalidForgotPasswordCodeException

getUserForValidationKey

public BasicUser getUserForValidationKey(ValidationKeyType type,
                                         String validationKey)
                                  throws FrameworkException

Description copied from interface: UserValidationServiceLocal

Returns the user in the current network with the given validation key

Specified by:

getUserForValidationKey in interface UserValidationServiceLocal

Throws:

FrameworkException

isEmailTaken

public boolean isEmailTaken(ConfigurationAccessor configuration,
                            String email)

Description copied from interface: UserValidationServiceLocal

Returns whether there's a non-removed user with this e-mail. Returns false if e-mail is not marked as unique.

Specified by:

isEmailTaken in interface UserValidationServiceLocal

isMobileNumberTaken

public boolean isMobileNumberTaken(ConfigurationAccessor configuration,
                                   String number)

Description copied from interface: UserValidationServiceLocal

Returns whether there's a non-removed user with this mobile phone number. Returns false if mobile phone is not marked as unique.

Specified by:

isMobileNumberTaken in interface UserValidationServiceLocal

isNameRequired

public boolean isNameRequired(BasicUserDTO basicDto)
                       throws FrameworkException

Description copied from interface: UserValidationServiceLocal

Returns whether we should require the full name when saving the given user

Specified by:

isNameRequired in interface UserValidationServiceLocal

Throws:

FrameworkException

isUsernameTaken

public boolean isUsernameTaken(ConfigurationAccessor configuration,
                               String username)

Description copied from interface: UserValidationServiceLocal

Returns whether there's a non-removed user with this username. Returns false if username is generated.

Specified by:

isUsernameTaken in interface UserValidationServiceLocal

manuallyValidateEmailChange

public void manuallyValidateEmailChange(UserLocatorVO locator)
                                 throws FrameworkException

Description copied from interface: UserValidationService

Makes a pending e-mail change as done

Specified by:

manuallyValidateEmailChange in interface UserValidationService

Throws:

FrameworkException

manuallyValidateRegistration

public UserValidationResult manuallyValidateRegistration(UserLocatorVO locator)
                                                  throws FrameworkException

Description copied from interface: UserValidationService

Makes a pending user to be active

Specified by:

manuallyValidateRegistration in interface UserValidationService

Throws:

FrameworkException

persistAdditionalRegistrationData

public void persistAdditionalRegistrationData(BasicUser basicUser,
                                              SimpleBasicUserRegistrationDTO dto,
                                              List<ProfileField> editableFields)

Description copied from interface: UserValidationServiceLocal

Persists additional data that is saved together with the user, such as phones or addresses

Specified by:

persistAdditionalRegistrationData in interface UserValidationServiceLocal

preProcessRegistration

public <BU extends BasicUser> BU preProcessRegistration(SimpleBasicUserRegistrationDTO dto,
                                                        UserRegistration registration)
                                                 throws FrameworkException

Description copied from interface: UserValidationServiceLocal

Returns a pre-populated user for persisting

Specified by:

preProcessRegistration in interface UserValidationServiceLocal

Throws:

FrameworkException

processRegistration

public Map<PasswordType,String> processRegistration(BasicUser basicUser,
                                                          SimpleBasicUserRegistrationDTO dto)

Description copied from interface: UserValidationServiceLocal

Processes a user registration. If the user must validate the e-mail then sets the user validation key for user registration confirmation and sends the e-mail. Otherwise, if the dto is an BasicUserRegistrationDTO then generates the passwords marked at registration and sends the activation or pending e-mail according to the user's status.

Specified by:

processRegistration in interface UserValidationServiceLocal

Parameters:

basicUser - the user to be registered, it must have set the UserRegistration

Returns:

a Map with the generated passwords only if the user doesn't need to validate the e-mail. Otherwise returns an empty map.

reindex

public void reindex(BasicUser user)
             throws FrameworkException

Description copied from interface: UserValidationServiceLocal

Reindex the given user updating its custom field values according to the products and also its display.

Specified by:

reindex in interface UserValidationServiceLocal

Throws:

FrameworkException

requiresEmailChangeValidation

public boolean requiresEmailChangeValidation(BasicUser basicUser)

Description copied from interface: UserValidationServiceLocal

Returns true if the system requires the user to validate the email upon email modification

Specified by:

requiresEmailChangeValidation in interface UserValidationServiceLocal

resendEmailChangeMail

public void resendEmailChangeMail(UserLocatorVO locator)
                           throws FrameworkException

Description copied from interface: UserValidationService

Re-sends the e-mail change e-mail to a user

Specified by:

resendEmailChangeMail in interface UserValidationService

Throws:

FrameworkException

resendRegistrationValidationMail

public void resendRegistrationValidationMail(UserLocatorVO locator)

Description copied from interface: UserValidationService

Re-sends the validation mail to a pending user

Specified by:

resendRegistrationValidationMail in interface UserValidationService

setEmailChangeValidation

public void setEmailChangeValidation(BasicUser user,
                                     String originalEmail)

Description copied from interface: UserValidationServiceLocal

Sets the user validation key for e-mail change confirmation, restores the original e-mail (saving the current e-mail in new email) and sends the e-mail

Specified by:

setEmailChangeValidation in interface UserValidationServiceLocal

setForgotPasswordValidation

public List<OutboundSms> setForgotPasswordValidation(BasicUser user,
                                                     SendMedium sendMedium)

Description copied from interface: UserValidationServiceLocal

Sends the change forgotten password code by the given send medium.

Specified by:

setForgotPasswordValidation in interface UserValidationServiceLocal

shouldCheckConfirmationPassword

public boolean shouldCheckConfirmationPassword(BasicUser user,
                                               CRUDOperation operation)

Description copied from interface: UserValidationServiceLocal

Controls whether confirmation password should be checked for the given basic user and operation.

Specified by:

shouldCheckConfirmationPassword in interface UserValidationServiceLocal

uniqueEmailQuery

public DBQuery<?> uniqueEmailQuery(Network network,
                                   BasicUserDTO dto)

Returns a query suited to check the e-mail uniqueness of the given user

Specified by:

uniqueEmailQuery in interface UserValidationServiceLocal

updateDisplay

public void updateDisplay(BasicUser user)

Description copied from interface: UserValidationServiceLocal

Updates display fields in the given user according to his/hers current configuration

Specified by:

updateDisplay in interface UserValidationServiceLocal

updateUserActivity

public void updateUserActivity(UserActivityType type)

Description copied from interface: UserValidationService

Updates user information status according to the given activity

Specified by:

updateUserActivity in interface UserValidationService

validateEmailChange

public Long validateEmailChange(String validationKey)
                         throws FrameworkException

Description copied from interface: UserValidationService

Validate an e-mail change for the given validation key, returning the affected user identifier

Specified by:

validateEmailChange in interface UserValidationService

Throws:

FrameworkException

validateRegistration

public UserValidationResult validateRegistration(String validationKey)

Description copied from interface: UserValidationService

Validate user registration which was pending e-mail verification, via a provided key

Specified by:

validateRegistration in interface UserValidationService

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