Package org.ametys.web.usermanagement

Class UserSignupManager

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.datasource.AbstractMyBatisDAO

org.ametys.web.usermanagement.UserSignupManager

All Implemented Interfaces:

LogEnabled, PluginAware, Component, Configurable, Contextualizable, Serviceable

Direct Known Subclasses:

UserSignupManager

public class UserSignupManager
extends AbstractMyBatisDAO

Manages registration and password recovery of users.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UserSignupManager.SignupType	Enumeration for the different type of signup
static class	UserSignupManager.TempUser	Bean representing a user sign-up request.

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected I18nUtils	_i18nUtils	The i18n utils.
protected PopulationContextHelper	_populationContextHelper	The population context helper.
protected String	_pwdChangeTable	The password change table.
protected RenderingContextHandler	_renderingContextHandler	The rendering context handler
protected AmetysObjectResolver	_resolver	The ametys object resolver.
protected RightManager	_rightManager	The right manager
protected SiteConfigurationExtensionPoint	_siteConf	The site configuration extension point.
protected SiteManager	_siteManager	The site manager.
protected String	_tempUsersTable	The temporary users table.
protected UserDirectoryFactory	_userDirectoryFactory	factory for user directory models
protected UserManager	_userManager	The user manager.
protected UserPopulationDAO	_userPopulationDAO	The DAO for user populations
protected UserSignUpConfiguration	_userSignUpConfiguration	The user sign up configuration
static final String	CHANGE_PASSWORD_PAGE_SERVICE_ID	Id of service for signup pages
static final String	CHANGE_PASSWORD_PAGE_TAG_NAME	Tag for password pages
static final String	ROLE	The component role.
static final String	SIGNUP_PAGE_SERVICE_ID	Id of service for signup pages
static final String	SIGNUP_PAGE_TAG_NAME	Tag for signup pages
static final String	SIGNUP_SERVICE_PARAMETER_USERDIRECTORY	The Signup Service parameter : userDirectory
static final String	SITE_PARAM_SIGNUP_TYPE	The site parameter name for signup type

Fields inherited from class org.ametys.core.datasource.AbstractMyBatisDAO

_manager

Constructor Summary

Constructors

Constructor	Description
UserSignupManager()

Method Summary

Modifier and Type	Method	Description
void	additionalSignupOperations(User createdUser, Multimap<String,I18nizableText> errors)	Process additional operations after creation of user
void	addPasswordToken(String siteName, String login, String token, String population)	Create a user password change request in the database.
protected void	addTemporaryUser(String siteName, String email, String token, String population, String userDirectoryId, String lastname, String firstname, UserSignupManager.TempUser.TempUserOrigin origin)	Create a user sign-up request ("temporary" user) in the database.
void	changeUserPassword(String siteName, String login, String token, String newPassword, String population)	Change the user password.
void	checkPasswordToken(String siteName, String login, String token, String population)	Check the password change request token.
protected void	checkPublicSignup(String siteName)	Verify that public sign-up is allowed.
protected void	checkSignupAllowed(String siteName)	Verify that public sign-up is allowed.
void	checkToken(String siteName, String email, String token, String population, String userDirectoryId)	Check the sign-up request token.
protected void	checkUserAllowedForInvitation(String siteName, String populationId)	Verify that current user is allowed to handle invitation for a given population
void	configure(Configuration configuration)
Set<String>	getAllowedUserPopulationForInvitation(String siteName)	Get the ids of user populations the current user can handle for invitation
Content	getGTUContent(ZoneItem zoneItem)	Get the GTU content Returns null if not found or empty
Page	getGTUPage(ZoneItem zoneItem)	Get the GTU page Returns null if not found or empty
String	getOrCreateToken(String siteName, String language, String email, String population, String userDirectoryId)	Temporary sign the user in and returns the token
Page	getPwdChangePage(String siteName, String language)	Get the password change page in a given site and sitemap.
List<Page>	getPwdChangePages(String siteName, String language)	Get all the pages tagged "password change".
String	getResetPasswordUri(Page passwordPage, String login, String population, String token, boolean absolute)	Get the URI to reset a password
Page	getSignupPage(String siteName, String language)	Get the sign-up page in a given site and sitemap. If more than one page are tagged "sign-up", return the first.
Page	getSignupPage(String siteName, String language, String populationId, String userDirectoryId)	Get the sign-up page in a given site and sitemap, configured for given population and user directory. If more than one page are tagged "sign-up", return the first.
List<Page>	getSignupPages(String siteName, String language)	Get all the pages tagged "sign-up" with signup service
List<Page>	getSignupPages(String siteName, String language, String populationId, String userDirectoryId)	Get all the pages tagged "sign-up" with signup service configured for given population and user directory
UserSignupManager.SignupType	getSignupType(String siteName)	Get the type of signup authorized for this site
Content	getSuccessContent(ZoneItem zoneItem)	Get the success content Returns null if not found or empty
Page	getSuccessPage(ZoneItem zoneItem)	Get the GTU page Returns null if not found or empty
protected UserSignupManager.TempUser	getTempUser(String siteName, String email, String population, String userDirectoryId)	Get a temporary user from his site name and e-mail.
protected UserSignupManager.TempUser	getTempUser(String siteName, String email, String token, String population, String userDirectoryId)	Get a temporary user from his site name, e-mail and/or token.
List<UserSignupManager.TempUser>	getTempUsers(String siteName, Map<String,Object> searchParameters, int offset, int limit, List<Map<String,String>> sorts)	Get the temporary users from a given site matching the search parameters
Map<String,Object>	getTempUsersProperties(List<String> emails, String siteName)	Get temporary users properties
String	getToken(String siteName, String email, String population, String userDirectoryId)	Get a token for temp user
int	getTotalCount(String siteName, Map<String,Object> searchParameters)	Get the number of temporary users matching the search parameters
UserDirectory	getUserDirectory(ZoneItem zoneItem)	Get the user directory
Optional<User>	getUserIfHeExists(String email, String siteName)	Get the user from email if he/she exists in the populations
void	inviteToSignup(String siteName, String language, String email, String population, String userDirectoryId, String lastname, String firstname)	Validate and store a invitation to sign-up request and send a confirmation e-mail.
void	inviteToSignup(String siteName, String language, String email, String population, String userDirectoryId, String lastname, String firstname, boolean sendMail, boolean resendInvitationIfExists, boolean checkRights)	Validate and store a invitation to sign-up request and send a confirmation e-mail.
boolean	isPublicSignupAllowed(String siteName)	Test if public signup is allowed in a site.
boolean	isPwdChangePage(Page page)	Check if page is a change password page
boolean	isSignupAllowed(String siteName)	Test if signup is allowed in a site, public or on invitation
boolean	isSignupPage(Page page)	Check if page is a signup page
void	removeExpiredPasswordTokens()	Remove the expired change password request tokens.
void	removeExpiredTokens()	Remove the expired sign-up request tokens (user request only)
int	removeExpiredTokens(String siteName)	Remove the expired sign-up request tokens (user request only)
protected void	removePasswordToken(String siteName, String login, String token, String population)	Remove the password change request.
protected void	removeTempUser(String siteName, String email, String token, String population, String userDirectoryId)	Remove the temporary .
void	resendInvitation(String siteName, String email, String population, String userDirectoryId)	Update susbcription date and resend an invitation
void	resetPassword(String siteName, String language, String loginOrEmail, String populationId)	Create a reset password request and send a confirmation e-mail.
void	resetTempSignup(String siteName, String language, String email, String population, String userDirectoryId)	Reset a sign-up request: generate a new token and re-send the confirmation e-mail.
protected void	resetTempSignup(String siteName, String language, String email, String token, String population, String userDirectoryId)	Reset a sign-up request: generate a new token and re-send the confirmation e-mail.
Map<String,Object>	searchTempUsers(String siteName, Map<String,Object> searchParameters, int offset, int limit, List<Map<String,String>> sorts)	Get the temporary users from a given site matching the search parameters
protected void	sendResetPasswordMail(String siteName, String language, User user, String token)	Send a sign-up confirmation link by e-mail.
protected void	sendSignupConfirmMail(UserSignupManager.TempUser tempUser, String language)	Send a sign-up confirmation link by e-mail.
protected void	sendSignupValidatedMail(String siteName, String language, User user)	Send a sign-up confirmation link by e-mail.
void	service(ServiceManager serviceManager)
void	signup(String siteName, String language, String firstname, String lastname, String email, String token, String password, String population, String userDirectoryId, Multimap<String,I18nizableText> errors)	Create the user in the FO UsersManager from his temporary request.
void	temporarySignup(String siteName, String language, String email, String population, String userDirectoryId)	Validate and store a sign-up request and send a confirmation e-mail.
void	temporarySignup(String siteName, String language, String email, String population, String userDirectoryId, boolean sendMail)	Validate and store a sign-up request and send a confirmation e-mail.
protected void	updateTempToken(String siteName, String email, String newToken, String population, String userDirectoryId)	Update the sign-up request token: reset the date and set a new token.
boolean	userExists(String email, String siteName)	Tests if the user already exists in the populations
Map<String,Errors>	validate(String siteName, String email, Map<String,String> additionalValues)	Validate the user subscription data.
Map<String,Errors>	validatePassword(String siteName, String password, String login, String population)	Validate the user password.
void	validationBeforeSignup(Multimap<String,I18nizableText> errors)	Do some validation before signup

Methods inherited from class org.ametys.core.datasource.AbstractMyBatisDAO

_configureDatasource, _getDataSourceId, _getMyBatisConfiguration, contextualize, getSession, getSession, reload, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The component role.

SITE_PARAM_SIGNUP_TYPE

public static final String SITE_PARAM_SIGNUP_TYPE

The site parameter name for signup type

See Also:

• Constant Field Values

SIGNUP_SERVICE_PARAMETER_USERDIRECTORY

public static final String SIGNUP_SERVICE_PARAMETER_USERDIRECTORY

The Signup Service parameter : userDirectory

See Also:

• Constant Field Values

SIGNUP_PAGE_TAG_NAME

public static final String SIGNUP_PAGE_TAG_NAME

Tag for signup pages

See Also:

• Constant Field Values

SIGNUP_PAGE_SERVICE_ID

public static final String SIGNUP_PAGE_SERVICE_ID

Id of service for signup pages

See Also:

• Constant Field Values

CHANGE_PASSWORD_PAGE_TAG_NAME

public static final String CHANGE_PASSWORD_PAGE_TAG_NAME

Tag for password pages

See Also:

• Constant Field Values

CHANGE_PASSWORD_PAGE_SERVICE_ID

public static final String CHANGE_PASSWORD_PAGE_SERVICE_ID

Id of service for signup pages

See Also:

• Constant Field Values

_userManager

protected UserManager _userManager

The user manager.

_userPopulationDAO

protected UserPopulationDAO _userPopulationDAO

The DAO for user populations

_siteManager

protected SiteManager _siteManager

The site manager.

_siteConf

protected SiteConfigurationExtensionPoint _siteConf

The site configuration extension point.

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver.

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils.

_userSignUpConfiguration

protected UserSignUpConfiguration _userSignUpConfiguration

The user sign up configuration

_tempUsersTable

protected String _tempUsersTable

The temporary users table.

_pwdChangeTable

protected String _pwdChangeTable

The password change table.

_populationContextHelper

protected PopulationContextHelper _populationContextHelper

The population context helper.

_renderingContextHandler

protected RenderingContextHandler _renderingContextHandler

The rendering context handler

_userDirectoryFactory

protected UserDirectoryFactory _userDirectoryFactory

factory for user directory models

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_rightManager

protected RightManager _rightManager

The right manager

Constructor Details

UserSignupManager

public UserSignupManager()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractMyBatisDAO

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractMyBatisDAO

Throws:

ConfigurationException

getSignupType

public UserSignupManager.SignupType getSignupType(String siteName)

Get the type of signup authorized for this site

Parameters:

siteName - the site name

Returns:

the of signup

isPublicSignupAllowed

public boolean isPublicSignupAllowed(String siteName)

Test if public signup is allowed in a site.

Parameters:

siteName - the site to test.

Returns:

true if public signup is allowed, false otherwise.

isSignupAllowed

public boolean isSignupAllowed(String siteName)

Test if signup is allowed in a site, public or on invitation

Parameters:

siteName - the site to test.

Returns:

true if signup is allowed, false otherwise.

getSignupPage

public Page getSignupPage(String siteName,
 String language)

Get the sign-up page in a given site and sitemap.
If more than one page are tagged "sign-up", return the first.

Parameters:

siteName - the site name.

language - the sitemap name.

Returns:

the sign-up page or null if not found.

getSignupPage

public Page getSignupPage(String siteName,
 String language,
 String populationId,
 String userDirectoryId)

Get the sign-up page in a given site and sitemap, configured for given population and user directory.
If more than one page are tagged "sign-up", return the first.

Parameters:

siteName - the site name.

language - the sitemap name.

populationId - The population id. Can be null to not check population.

userDirectoryId - The user directory id. Can be null to not check user directory.

Returns:

the sign-up page or null if not found.

isSignupPage

public boolean isSignupPage(Page page)

Check if page is a signup page

Parameters:

page - the page

Returns:

true if the page contains the signup service

getSignupPages

public List<Page> getSignupPages(String siteName,
 String language)

Get all the pages tagged "sign-up" with signup service

Parameters:

siteName - the site name.

language - the sitemap name.

Returns:

an iterable on all the pages tagged "sign-up".

getSignupPages

public List<Page> getSignupPages(String siteName,
 String language,
 String populationId,
 String userDirectoryId)

Get all the pages tagged "sign-up" with signup service configured for given population and user directory

Parameters:

siteName - the site name.

language - the sitemap name.

populationId - The population id. Can be null to not check population.

userDirectoryId - The user directory id. Can be null to not check user directory.

Returns:

an iterable on all the pages tagged "sign-up".

getPwdChangePage

public Page getPwdChangePage(String siteName,
 String language)

Get the password change page in a given site and sitemap. If more than one page are tagged "password change", return the first.

Parameters:

siteName - the site name.

language - the sitemap name.

Returns:

the password change page or null if not found.

getGTUPage

public Page getGTUPage(ZoneItem zoneItem)

Get the GTU page Returns null if not found or empty

Parameters:

zoneItem - the zone item

Returns:

the GTU page or null.

getUserDirectory

public UserDirectory getUserDirectory(ZoneItem zoneItem)

Get the user directory

Parameters:

zoneItem - the zone item with signup service

Returns:

The user directory or null if not found

getGTUContent

public Content getGTUContent(ZoneItem zoneItem)

Get the GTU content Returns null if not found or empty

Parameters:

zoneItem - the zone item

Returns:

the GTU content or null.

getSuccessPage

public Page getSuccessPage(ZoneItem zoneItem)

Get the GTU page Returns null if not found or empty

Parameters:

zoneItem - the zone item

Returns:

the success page or null.

getSuccessContent

public Content getSuccessContent(ZoneItem zoneItem)

Get the success content Returns null if not found or empty

Parameters:

zoneItem - the zone item

Returns:

the success content or null.

getPwdChangePages

public List<Page> getPwdChangePages(String siteName,
 String language)

Get all the pages tagged "password change".

Parameters:

siteName - the site name.

language - the sitemap name.

Returns:

an iterable on all the pages tagged "password change".

isPwdChangePage

public boolean isPwdChangePage(Page page)

Check if page is a change password page

Parameters:

page - the page

Returns:

true if the page contains the change password service

getUserIfHeExists

public Optional<User> getUserIfHeExists(String email,
 String siteName)
                                 throws UserManagementException,
NotUniqueUserException

Get the user from email if he/she exists in the populations

Parameters:

email - the e-mail to test.

siteName - The site name

Returns:

the user if the user exists, empty otherwise.

Throws:

UserManagementException - if an error occurs.

NotUniqueUserException - if several user respond to the email

userExists

public boolean userExists(String email,
 String siteName)
                   throws UserManagementException

Tests if the user already exists in the populations

Parameters:

email - the e-mail to test.

siteName - The site name

Returns:

true if the user exists, false otherwise.

Throws:

UserManagementException - if an error occurs.

validate

public Map<String,Errors> validate(String siteName,
 String email,
 Map<String,String> additionalValues)
                            throws UserManagementException

Validate the user subscription data.

Parameters:

siteName - the site name.

email - the user e-mail.

additionalValues - the additional user values.

Returns:

a Map of the Errors by field.

Throws:

UserManagementException - if an error occurs.

validatePassword

public Map<String,Errors> validatePassword(String siteName,
 String password,
 String login,
 String population)
                                    throws UserManagementException

Validate the user password.

Parameters:

siteName - the site name.

password - the password to validate.

login - the login of the user

population - The id of the population

Returns:

a Map of the Errors by field.

Throws:

UserManagementException - if an error occurs.

getOrCreateToken

public String getOrCreateToken(String siteName,
 String language,
 String email,
 String population,
 String userDirectoryId)
                        throws UserManagementException

Temporary sign the user in and returns the token

Parameters:

siteName - The site's name

language - The page's language

email - The email of the user

population - The population ID

userDirectoryId - The userDirectory ID

Returns:

The sign-up token

Throws:

UserManagementException - If an error occurs

temporarySignup

public void temporarySignup(String siteName,
 String language,
 String email,
 String population,
 String userDirectoryId)
                     throws UserManagementException

Validate and store a sign-up request and send a confirmation e-mail.

Parameters:

siteName - the site name.

language - the sitemap name.

email - the user e-mail address.

population - the population

userDirectoryId - the id of the user directory of the population

Throws:

UserManagementException - if an error occurs.

temporarySignup

public void temporarySignup(String siteName,
 String language,
 String email,
 String population,
 String userDirectoryId,
 boolean sendMail)
                     throws UserManagementException

Validate and store a sign-up request and send a confirmation e-mail.

Parameters:

siteName - the site name.

language - the sitemap name.

email - the user e-mail address.

population - the population

userDirectoryId - the id of the user directory of the population

sendMail - Set to false to not send mail at end of process

Throws:

UserManagementException - if an error occurs.

inviteToSignup

public void inviteToSignup(String siteName,
 String language,
 String email,
 String population,
 String userDirectoryId,
 String lastname,
 String firstname)
                    throws UserManagementException

Validate and store a invitation to sign-up request and send a confirmation e-mail.

Parameters:

siteName - the site name.

language - the sitemap name.

email - the user e-mail address.

population - the population

userDirectoryId - the id of the user directory of the population

lastname - The guest last name. Can be null.

firstname - The guest first name. Can be null.

Throws:

UserManagementException - if an error occurs.

inviteToSignup

public void inviteToSignup(String siteName,
 String language,
 String email,
 String population,
 String userDirectoryId,
 String lastname,
 String firstname,
 boolean sendMail,
 boolean resendInvitationIfExists,
 boolean checkRights)
                    throws UserManagementException

Validate and store a invitation to sign-up request and send a confirmation e-mail.

Parameters:

siteName - the site name.

language - the sitemap name.

email - the user e-mail address.

population - the population

userDirectoryId - the id of the user directory of the population

lastname - The guest last name. Can be null.

firstname - The guest first name. Can be null.

sendMail - Set to false to not send mail at end of process

resendInvitationIfExists - Set to false to not resend invitation if the email already exists as a user waiting signup

checkRights - set to false to ignore rights

Throws:

UserManagementException - if an error occurs.

getToken

public String getToken(String siteName,
 String email,
 String population,
 String userDirectoryId)
                throws UserManagementException

Get a token for temp user

Parameters:

siteName - the site name.

email - the user e-mail address.

population - The id of the population

userDirectoryId - The id of the user directory of the population

Returns:

the user token or null if not found

Throws:

UserManagementException - if an error occurs.

resendInvitation

public void resendInvitation(String siteName,
 String email,
 String population,
 String userDirectoryId)
                      throws UserManagementException

Update susbcription date and resend an invitation

Parameters:

siteName - the site name

email - the email

population - the population id

userDirectoryId - the user directory id

Throws:

UserManagementException - if an error occurred

resetTempSignup

public void resetTempSignup(String siteName,
 String language,
 String email,
 String population,
 String userDirectoryId)
                     throws UserManagementException

Reset a sign-up request: generate a new token and re-send the confirmation e-mail.

Parameters:

siteName - the site name.

language - the sitemap name.

email - the user e-mail address.

population - The id of the population

userDirectoryId - The id of the user directory of the population

Throws:

UserManagementException - if an error occurs.

resetTempSignup

protected void resetTempSignup(String siteName,
 String language,
 String email,
 String token,
 String population,
 String userDirectoryId)
                        throws UserManagementException

Reset a sign-up request: generate a new token and re-send the confirmation e-mail.

Parameters:

siteName - the site name.

language - the sitemap name.

email - the user e-mail address.

token - the token. Can be null to not re-generate token.

population - The id of the population

userDirectoryId - The id of the user directory of the population

Throws:

UserManagementException - if an error occurs.

signup

public void signup(String siteName,
 String language,
 String firstname,
 String lastname,
 String email,
 String token,
 String password,
 String population,
 String userDirectoryId,
 Multimap<String,I18nizableText> errors)
            throws UserManagementException

Create the user in the FO UsersManager from his temporary request.

Parameters:

siteName - the site name.

language - the current language

firstname - the user firstname

lastname - the user lastname

email - the user e-mail address.

token - the request token.

password - the user password.

population - The id of the population

userDirectoryId - The id of the user directory of the population

errors - the errors

Throws:

UserManagementException - if an error occurs.

validationBeforeSignup

public void validationBeforeSignup(Multimap<String,I18nizableText> errors)

Do some validation before signup

Parameters:

errors - the map of errors to fill in cause of errors during validation

additionalSignupOperations

public void additionalSignupOperations(User createdUser,
 Multimap<String,I18nizableText> errors)
                                throws UserManagementException

Process additional operations after creation of user

Parameters:

createdUser - the created user

errors - the map of errors to fill in case of errors during additional operations

Throws:

UserManagementException - if an error occurs.

resetPassword

public void resetPassword(String siteName,
 String language,
 String loginOrEmail,
 String populationId)
                   throws UserManagementException

Create a reset password request and send a confirmation e-mail.

Parameters:

siteName - the site name.

language - the sitemap name.

loginOrEmail - the user login or email.

populationId - the population

Throws:

UserManagementException - if an error occurs.

changeUserPassword

public void changeUserPassword(String siteName,
 String login,
 String token,
 String newPassword,
 String population)
                        throws UserManagementException

Change the user password.

Parameters:

siteName - the site name.

login - the user login.

token - the password change request token.

newPassword - the new password.

population - the population

Throws:

UserManagementException - if an error occurs.

checkToken

public void checkToken(String siteName,
 String email,
 String token,
 String population,
 String userDirectoryId)
                throws UserManagementException

Check the sign-up request token.

Parameters:

siteName - the site name.

email - the user e-mail.

token - the sign-up request token.

population - The id of the population

userDirectoryId - The id of the user directory of the population

Throws:

UserManagementException - if an error occurs.

checkPasswordToken

public void checkPasswordToken(String siteName,
 String login,
 String token,
 String population)
                        throws UserManagementException

Check the password change request token.

Parameters:

siteName - the site name.

login - the user login.

token - the password change request token.

population - the population

Throws:

UserManagementException - if an error occurs.

removeExpiredTokens

public void removeExpiredTokens()
                         throws UserManagementException

Remove the expired sign-up request tokens (user request only)

Throws:

UserManagementException - if an error occurs.

removeExpiredTokens

public int removeExpiredTokens(String siteName)
                        throws UserManagementException

Remove the expired sign-up request tokens (user request only)

Parameters:

siteName - the site name. Can be null.

Returns:

the number of deleted tokens

Throws:

UserManagementException - if an error occurs.

removeExpiredPasswordTokens

public void removeExpiredPasswordTokens()
                                 throws UserManagementException

Remove the expired change password request tokens.

Throws:

UserManagementException - if an error occurs.

checkPublicSignup

protected void checkPublicSignup(String siteName)
                          throws UserManagementException

Verify that public sign-up is allowed. If not, throw an exception.

Parameters:

siteName - the site name.

Throws:

UserManagementException - if public sign-up is not enabled.

checkSignupAllowed

protected void checkSignupAllowed(String siteName)
                           throws UserManagementException

Verify that public sign-up is allowed. If not, throw an exception.

Parameters:

siteName - the site name.

Throws:

UserManagementException - if public sign-up is not enabled.

addTemporaryUser

protected void addTemporaryUser(String siteName,
 String email,
 String token,
 String population,
 String userDirectoryId,
 String lastname,
 String firstname,
 UserSignupManager.TempUser.TempUserOrigin origin)
                         throws UserManagementException

Create a user sign-up request ("temporary" user) in the database.

Parameters:

siteName - the site name.

email - the user e-mail.

token - the generated token.

population - the population

userDirectoryId - the id of the user directory of the population

lastname - The guest last name. Can be null.

firstname - The guest first name. Can be null.

origin - true if this signup request origin

Throws:

UserManagementException - if an error occurs.

sendSignupConfirmMail

protected void sendSignupConfirmMail(UserSignupManager.TempUser tempUser,
 String language)
                              throws UserManagementException

Send a sign-up confirmation link by e-mail.

Parameters:

tempUser - the temp user

language - the e-mail language.

Throws:

UserManagementException - if an error occurs.

sendSignupValidatedMail

protected void sendSignupValidatedMail(String siteName,
 String language,
 User user)
                                throws UserManagementException

Send a sign-up confirmation link by e-mail.

Parameters:

siteName - the site name.

language - the e-mail language.

user - the created user

Throws:

UserManagementException - if an error occurs.

updateTempToken

protected void updateTempToken(String siteName,
 String email,
 String newToken,
 String population,
 String userDirectoryId)
                        throws UserManagementException

Update the sign-up request token: reset the date and set a new token.

Parameters:

siteName - the site name.

email - the user e-mail.

newToken - the new token.

population - The id of the population

userDirectoryId - The id of the user directory of the population

Throws:

UserManagementException - if an error occurs.

addPasswordToken

public void addPasswordToken(String siteName,
 String login,
 String token,
 String population)
                      throws UserManagementException

Create a user password change request in the database.

Parameters:

siteName - the site name.

login - the user login.

token - the generated token.

population - the population

Throws:

UserManagementException - if an error occurs.

getTempUser

protected UserSignupManager.TempUser getTempUser(String siteName,
 String email,
 String population,
 String userDirectoryId)
                                          throws UserManagementException

Get a temporary user from his site name and e-mail.

Parameters:

siteName - the site name.

email - The temporary user e-mail. Cannot be null.

population - the population

userDirectoryId - the id of the user directory of the population

Returns:

the temporary user or null if not found.

Throws:

UserManagementException - if an error occurs.

getTempUsersProperties

public Map<String,Object> getTempUsersProperties(List<String> emails,
 String siteName)
                                          throws UserManagementException

Get temporary users properties

Parameters:

emails - the emails of temporary users

siteName - the site name of temporary users

Returns:

The temporary users properties

Throws:

UserManagementException - if an error occurs.

searchTempUsers

public Map<String,Object> searchTempUsers(String siteName,
 Map<String,Object> searchParameters,
 int offset,
 int limit,
 List<Map<String,String>> sorts)
                                   throws UserManagementException

Get the temporary users from a given site matching the search parameters

Parameters:

siteName - the site name

searchParameters - the search parameters

offset - index of the start of search

limit - the maximum number of results

sorts - The sorters

Returns:

the temporary users as JSON object

Throws:

UserManagementException - if an error occurs.

checkUserAllowedForInvitation

protected void checkUserAllowedForInvitation(String siteName,
 String populationId)
                                      throws UserManagementException

Verify that current user is allowed to handle invitation for a given population

Parameters:

siteName - the site name.

populationId - The population id

Throws:

UserManagementException - if user is not allowed

getAllowedUserPopulationForInvitation

public Set<String> getAllowedUserPopulationForInvitation(String siteName)

Get the ids of user populations the current user can handle for invitation

Parameters:

siteName - the site name

Returns:

the ids of user populations handled by current users

getTempUsers

public List<UserSignupManager.TempUser> getTempUsers(String siteName,
 Map<String,Object> searchParameters,
 int offset,
 int limit,
 List<Map<String,String>> sorts)
                                              throws UserManagementException

Get the temporary users from a given site matching the search parameters

Parameters:

siteName - the site name. Can not be null

searchParameters - The search parameters

offset - index of the start of search

limit - the maximum number of results

sorts - The sorters. Can be null or empty

Returns:

the temporary users

Throws:

UserManagementException - if an error occurs.

getTotalCount

public int getTotalCount(String siteName,
 Map<String,Object> searchParameters)
                  throws UserManagementException

Get the number of temporary users matching the search parameters

Parameters:

siteName - the site name. Can not be null

searchParameters - The search parameters

Returns:

the total number of results

Throws:

UserManagementException - if an error occurs.

getTempUser

protected UserSignupManager.TempUser getTempUser(String siteName,
 String email,
 String token,
 String population,
 String userDirectoryId)
                                          throws UserManagementException

Get a temporary user from his site name, e-mail and/or token. At least one of e-mail and token must be provided.

Parameters:

siteName - the site name.

email - The temporary user e-mail. Can be null.

token - The temporary user token. Can be null.

population - the population. Must be not null if email is not null

userDirectoryId - the id of the user directory of the population. Must be not null if email is not null

Returns:

the temporary user or null if not found.

Throws:

UserManagementException - if an error occurs.

removeTempUser

protected void removeTempUser(String siteName,
 String email,
 String token,
 String population,
 String userDirectoryId)
                       throws UserManagementException

Remove the temporary .

Parameters:

siteName - the site name.

email - the user e-mail address.

token - the request token.

population - the population

userDirectoryId - the id of the user directory of the population

Throws:

UserManagementException - if an error occurs.

removePasswordToken

protected void removePasswordToken(String siteName,
 String login,
 String token,
 String population)
                            throws UserManagementException

Remove the password change request.

Parameters:

siteName - the site name.

login - the user login.

token - the request token.

population - the population

Throws:

UserManagementException - if an error occurs.

sendResetPasswordMail

protected void sendResetPasswordMail(String siteName,
 String language,
 User user,
 String token)
                              throws UserManagementException

Send a sign-up confirmation link by e-mail.

Parameters:

siteName - the site name.

language - the e-mail language.

user - the user object.

token - the generated token.

Throws:

UserManagementException - if an error occurs.

getResetPasswordUri

public String getResetPasswordUri(Page passwordPage,
 String login,
 String population,
 String token,
 boolean absolute)

Get the URI to reset a password

Parameters:

passwordPage - The passwodr page. Can not be null.

login - the user login

population - the user population

token - the generated token

absolute - true to get absolute uri

Returns:

the computed uri