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, BasicUserRegistrationDTO dto, UserRegistration registration, Group group) Add common validations for registering an user or operator
void	addValidations(org.cyclos.impl.utils.validation.Validator validator, BasicUserDTO dto, BasicUser user, UserRegistration registration) Add common validations for saving the profile of an 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
void	fillRegistrationData(BasicUserRegistrationData 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
<BU extends BasicUser> BU	preProcessRegistration(BasicUserRegistrationDTO dto, UserRegistration registration) Returns a pre-populated user for persisting
java.util.Map<PasswordType,java.lang.String>	processRegistration(BasicUser user, BasicUserRegistrationDTO registrationDto) Processes an 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

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)
                 throws FrameworkException

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

Throws:

FrameworkException

addRegistrationValidations

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

Add common validations for registering an user or operator

Throws:

FrameworkException

addValidations

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

Add common validations for saving the profile of an user or operator. The registration argument is needed because this method is used both on save profile and register.

Throws:

FrameworkException

buildRegistrationResult

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

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.

Throws:

FrameworkException

clearValidationKey

void clearValidationKey(BasicUser user)
                 throws FrameworkException

Removes all user data related to a validation key

Throws:

FrameworkException

fillRegistrationData

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

Fills with common data for registering users or operators

getUserForValidationKey

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

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

Throws:

FrameworkException

isNameRequired

boolean isNameRequired(BasicUserDTO dto)
                throws FrameworkException

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

Throws:

FrameworkException

preProcessRegistration

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

Returns a pre-populated user for persisting

Throws:

FrameworkException

processRegistration

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

Processes an 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, 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.

Throws:

FrameworkException

requiresEmailChangeValidation

boolean requiresEmailChangeValidation(BasicUser user)
                               throws FrameworkException

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

Throws:

FrameworkException

setEmailChangeValidation

void setEmailChangeValidation(BasicUser user,
                              java.lang.String originalEmail)
                       throws FrameworkException

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

Throws:

FrameworkException

setForgotPasswordValidation

void setForgotPasswordValidation(BasicUser user)
                          throws FrameworkException

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

Throws:

FrameworkException