org.cyclos.impl.users

Interface UserValidationServiceLocal

All Superinterfaces:

Service, UserValidationService

public interface UserValidationServiceLocal
extends UserValidationService

Local interface for UserValidationService

Author:

luis

Method Summary

Modifier and Type	Method and Description
void	addNameValidations(org.cyclos.impl.utils.validation.Property property, BasicUserDTO dto) As the CRUD service forces a custom handling of the name property, this needs to be in a separate method
void	addRegistrationValidations(org.cyclos.impl.utils.validation.Validator validator, SimpleBasicUserRegistrationDTO dto, UserRegistration registration, Group group) Add common validations for registering a user or operator
void	addValidations(org.cyclos.impl.utils.validation.Validator validator, BasicUserDTO dto, BasicUser user) Add common validations for saving the profile of a user or operator.
UserRegistrationResult	buildRegistrationResult(BasicUser user, java.util.Set<PasswordType> generatedPasswordTypes) Builds the registration result for the given user.
void	clearValidationKey(BasicUser user) Removes all user data related to a validation key
java.util.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 user) Fills with common data for registering users or operators
BasicUser	getUserForValidationKey(ValidationKeyType type, java.lang.String validationKey) Returns the user in the current network with the given validation key
boolean	isNameRequired(BasicUserDTO dto) Returns whether we should require the full name when saving the given user
void	persistAdditionalRegistrationData(BasicUser user, SimpleBasicUserRegistrationDTO registrationDto, java.util.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
java.util.Map<PasswordType,java.lang.String>	processRegistration(BasicUser user, SimpleBasicUserRegistrationDTO registrationDto) Processes a user registration.
boolean	requiresEmailChangeValidation(BasicUser user) Returns true if the system requires the user to validate the email upon email modification
void	setEmailChangeValidation(BasicUser user, java.lang.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
void	setForgotPasswordValidation(BasicUser user) Sets the user validation key to forgot password and sends the e-mail
void	updateDisplay(BasicUser user) Updates both display and shortDisplay fields in the given user according to his/hers current configuration

Methods inherited from interface org.cyclos.services.users.UserValidationService

manuallyValidateEmailChange, manuallyValidateRegistration, resendEmailChangeMail, resendRegistrationValidationMail, validateEmailChange, validateRegistration

Method Detail

addNameValidations

void addNameValidations(org.cyclos.impl.utils.validation.Property property,
                        BasicUserDTO dto)

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

addRegistrationValidations

void addRegistrationValidations(org.cyclos.impl.utils.validation.Validator validator,
                                SimpleBasicUserRegistrationDTO dto,
                                UserRegistration registration,
                                Group group)

Add common validations for registering a user or operator

addValidations

void addValidations(org.cyclos.impl.utils.validation.Validator validator,
                    BasicUserDTO dto,
                    BasicUser user)

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.

buildRegistrationResult

UserRegistrationResult buildRegistrationResult(BasicUser user,
                                               java.util.Set<PasswordType> generatedPasswordTypes)

Builds the registration result for the given user.

Parameters:

user - the already registered user

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

clearValidationKey

void clearValidationKey(BasicUser user)

Removes all user data related to a validation key

fillProfileFields

java.util.List<ProfileField> fillProfileFields(BasicUser user,
                                               AbstractViewProfileData data)

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

fillRegistrationData

void fillRegistrationData(SimpleBasicUserRegistrationData data,
                          UserRegistration registration,
                          BasicUser user)

Fills with common data for registering users or operators

getUserForValidationKey

BasicUser getUserForValidationKey(ValidationKeyType type,
                                  java.lang.String validationKey)

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

isNameRequired

boolean isNameRequired(BasicUserDTO dto)

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

persistAdditionalRegistrationData

void persistAdditionalRegistrationData(BasicUser user,
                                       SimpleBasicUserRegistrationDTO registrationDto,
                                       java.util.List<ProfileField> editableFields)

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

preProcessRegistration

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

Returns a pre-populated user for persisting

processRegistration

java.util.Map<PasswordType,java.lang.String> processRegistration(BasicUser user,
                                                                 SimpleBasicUserRegistrationDTO registrationDto)

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.

Parameters:

user - 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.

requiresEmailChangeValidation

boolean requiresEmailChangeValidation(BasicUser user)

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

setEmailChangeValidation

void setEmailChangeValidation(BasicUser user,
                              java.lang.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

setForgotPasswordValidation

void setForgotPasswordValidation(BasicUser user)

Sets the user validation key to forgot password and sends the e-mail

updateDisplay

void updateDisplay(BasicUser user)

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