org.cyclos.impl.users

Interface UserValidationServiceLocal

All Superinterfaces:

Service, UserValidationService

public interface UserValidationServiceLocal
extends UserValidationService

Local interface for UserValidationService

Author:

luis

Method Summary

Methods

Modifier and Type	Method and Description
UserRegistrationResult	buildRegistrationResult(BasicUser user) Builds the registration result for the given user
void	clearValidationKey(BasicUser user) Removes all user data related to a validation key
java.lang.String	generatePasswordAndSendActivationEmail(BasicUser user, boolean generatePasswordEvenIfManual, boolean sendActivationEmail) Generate a password (if needed) and send the activation e-mail for the given user
BasicUser	getUserForValidationKey(ValidationKeyType type, java.lang.String validationKey) Returns the user in the current network with the given validation key
java.lang.String	processActivation(BasicUser user, boolean generatePasswordEvenIfManual, boolean sendActivationEmail) Processes an user activation, generating a password if needed, and sends the activation e-mail, returning a generated password (if any)
boolean	requiresEmailChangeValidation(BasicUser user) Returns true if the system requires the user to validate the email upon email modification
boolean	requiresEmailValidation(UserRegistration registration, ConfigurationAccessor configuration) Returns true if the configuration requires email validation for the given user registration.
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	setRegistrationValidation(BasicUser user) Sets the user validation key for user registration confirmation and sends the e-mail
com.mysema.query.Projectable	uniqueEmailQuery(Network network, BasicUserDTO dto) Returns a query suited to check the e-mail uniqueness of the given user

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

manuallyValidateEmailChange, manuallyValidateRegistration, resendEmailChangeMail, resendRegistrationValidationMail, validateEmailChange, validateRegistration

Method Detail

buildRegistrationResult

UserRegistrationResult buildRegistrationResult(BasicUser user)
                                               throws FrameworkException

Builds the registration result for the given user

Throws:

FrameworkException

clearValidationKey

void clearValidationKey(BasicUser user)
                        throws FrameworkException

Removes all user data related to a validation key

Throws:

FrameworkException

generatePasswordAndSendActivationEmail

java.lang.String generatePasswordAndSendActivationEmail(BasicUser user,
                                                      boolean generatePasswordEvenIfManual,
                                                      boolean sendActivationEmail)
                                                        throws FrameworkException

Generate a password (if needed) and send the activation e-mail for the given user

Throws:

FrameworkException

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

processActivation

java.lang.String processActivation(BasicUser user,
                                 boolean generatePasswordEvenIfManual,
                                 boolean sendActivationEmail)
                                   throws FrameworkException

Processes an user activation, generating a password if needed, and sends the activation e-mail, returning a generated password (if any)

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

requiresEmailValidation

boolean requiresEmailValidation(UserRegistration registration,
                              ConfigurationAccessor configuration)
                                throws FrameworkException

Returns true if the configuration requires email validation for the given user registration.

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

setRegistrationValidation

void setRegistrationValidation(BasicUser user)
                               throws FrameworkException

Sets the user validation key for user registration confirmation and sends the e-mail

Throws:

FrameworkException

uniqueEmailQuery

com.mysema.query.Projectable uniqueEmailQuery(Network network,
                                            BasicUserDTO dto)
                                              throws FrameworkException

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

Throws:

FrameworkException