org.ametys.web.usermanagement

Class DefaultUserSignUpConfiguration

java.lang.Object

org.ametys.web.usermanagement.DefaultUserSignUpConfiguration

All Implemented Interfaces:

PluginAware, UserSignUpConfiguration, Component, Configurable, Serviceable

public class DefaultUserSignUpConfiguration
extends Object
implements UserSignUpConfiguration, Configurable, Serviceable, PluginAware, Component

The default user sign up configuration

Field Summary

Fields

Modifier and Type	Field and Description
private String	_htmlBodyKeyForResetPwd
private String	_htmlBodyKeyForSignupEmail
private String	_htmlBodyKeyForSignupValidationEmail
protected I18nUtils	_i18nUtils The i18n utils
private String	_pluginName
private String	_subjectKeyForResetPwd
private String	_subjectKeyForSignupEmail
private String	_subjectKeyForSignupValidationEmail
private String	_textBodyKeyForResetPwd
private String	_textBodyKeyForSignupEmail
private String	_textBodyKeyForSignupValidationEmail
private int	_tokenValidity

Fields inherited from interface org.ametys.web.usermanagement.UserSignUpConfiguration

ROLE

Constructor Summary

Constructors

Constructor and Description
DefaultUserSignUpConfiguration()

Method Summary

Modifier and Type	Method and Description
protected I18nizableText	_getI18nizableText(String fullI18nKey, Map<String,I18nizableText> i18nParams) Get the I18nizableText from the configured key and i18n parameters
void	configure(Configuration configuration)
String	getHtmlBodyForResetPwdEmail(Map<String,I18nizableText> defaultI18nParams, String language) The email html body when user reset password.
String	getHtmlBodyForSignUpEmail(Map<String,I18nizableText> defaultI18nParams, String language) The email html body when user sign up.
String	getHtmlBodyForSignUpValidatedEmail(Map<String,I18nizableText> defaultI18nParams, String language) The email html body when user sign up was validated.
String	getSubjectForResetPwdEmail(Map<String,I18nizableText> defaultI18nParams, String language) The email subject when user reset password.
String	getSubjectForSignUpEmail(Map<String,I18nizableText> defaultI18nParams, String language) The email subject when user sign up.
String	getSubjectForSignUpValidatedEmail(Map<String,I18nizableText> defaultI18nParams, String language) The email subject when user sign up was validated.
String	getTextBodyForResetPwdEmail(Map<String,I18nizableText> defaultI18nParams, String language) The email text body when user reset password.
String	getTextBodyForSignUpEmail(Map<String,I18nizableText> defaultI18nParams, String language) The email text body when user sign up.
String	getTextBodyForSignUpValidatedEmail(Map<String,I18nizableText> defaultI18nParams, String language) The email text body when user sign up was validated.
int	getTokenValidity() The token validity period, in days.
void	service(ServiceManager manager)
void	setPluginInfo(String pluginName, String featureName, String id) Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

Methods inherited from class java.lang.Object

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

Field Detail

_i18nUtils

protected I18nUtils _i18nUtils

The i18n utils

_tokenValidity

private int _tokenValidity

_subjectKeyForSignupEmail

private String _subjectKeyForSignupEmail

_textBodyKeyForSignupEmail

private String _textBodyKeyForSignupEmail

_htmlBodyKeyForSignupEmail

private String _htmlBodyKeyForSignupEmail

_subjectKeyForSignupValidationEmail

private String _subjectKeyForSignupValidationEmail

_textBodyKeyForSignupValidationEmail

private String _textBodyKeyForSignupValidationEmail

_htmlBodyKeyForSignupValidationEmail

private String _htmlBodyKeyForSignupValidationEmail

_subjectKeyForResetPwd

private String _subjectKeyForResetPwd

_textBodyKeyForResetPwd

private String _textBodyKeyForResetPwd

_htmlBodyKeyForResetPwd

private String _htmlBodyKeyForResetPwd

_pluginName

private String _pluginName

Constructor Detail

DefaultUserSignUpConfiguration

public DefaultUserSignUpConfiguration()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

setPluginInfo

public void setPluginInfo(String pluginName,
                          String featureName,
                          String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getTokenValidity

public int getTokenValidity()

Description copied from interface: UserSignUpConfiguration

The token validity period, in days.

Specified by:

getTokenValidity in interface UserSignUpConfiguration

Returns:

the token validity period, in days.

getSubjectForSignUpEmail

public String getSubjectForSignUpEmail(Map<String,I18nizableText> defaultI18nParams,
                                       String language)

Description copied from interface: UserSignUpConfiguration

The email subject when user sign up.

Specified by:

getSubjectForSignUpEmail in interface UserSignUpConfiguration

Parameters:

defaultI18nParams - The default i18n parameters with : siteName the site name login the login email the mail fullName the full name token the token confirmUri the confirmation uri siteTitle the site title siteUrl the site url

language - the language

Returns:

the email subject when user sign up.

getTextBodyForSignUpEmail

public String getTextBodyForSignUpEmail(Map<String,I18nizableText> defaultI18nParams,
                                        String language)

Description copied from interface: UserSignUpConfiguration

The email text body when user sign up.

Specified by:

getTextBodyForSignUpEmail in interface UserSignUpConfiguration

Parameters:

defaultI18nParams - The default i18n parameters with : siteName the site name login the login email the mail fullName the full name token the token confirmUri the confirmation uri siteTitle the site title siteUrl the site url

language - the language

Returns:

the email text body when user sign up.

getHtmlBodyForSignUpEmail

public String getHtmlBodyForSignUpEmail(Map<String,I18nizableText> defaultI18nParams,
                                        String language)

Description copied from interface: UserSignUpConfiguration

The email html body when user sign up.

Specified by:

getHtmlBodyForSignUpEmail in interface UserSignUpConfiguration

Parameters:

defaultI18nParams - The default i18n parameters with : siteName the site name login the login email the mail fullName the full name token the token confirmUri the confirmation uri siteTitle the site title siteUrl the site url

language - the language

Returns:

the email html body when user sign up.

getSubjectForSignUpValidatedEmail

public String getSubjectForSignUpValidatedEmail(Map<String,I18nizableText> defaultI18nParams,
                                                String language)

Description copied from interface: UserSignUpConfiguration

The email subject when user sign up was validated.

Specified by:

getSubjectForSignUpValidatedEmail in interface UserSignUpConfiguration

Parameters:

defaultI18nParams - The default i18n parameters with : siteName the site name login the login email the mail fullName the full name siteTitle the site title siteUrl the site url

language - the language

Returns:

the email subject when user sign up.

getTextBodyForSignUpValidatedEmail

public String getTextBodyForSignUpValidatedEmail(Map<String,I18nizableText> defaultI18nParams,
                                                 String language)

Description copied from interface: UserSignUpConfiguration

The email text body when user sign up was validated.

Specified by:

getTextBodyForSignUpValidatedEmail in interface UserSignUpConfiguration

Parameters:

defaultI18nParams - The default i18n parameters with : siteName the site name login the login email the mail fullName the full name siteTitle the site title siteUrl the site url

language - the language

Returns:

the email text body when user sign up.

getHtmlBodyForSignUpValidatedEmail

public String getHtmlBodyForSignUpValidatedEmail(Map<String,I18nizableText> defaultI18nParams,
                                                 String language)

Description copied from interface: UserSignUpConfiguration

The email html body when user sign up was validated.

Specified by:

getHtmlBodyForSignUpValidatedEmail in interface UserSignUpConfiguration

Parameters:

defaultI18nParams - The default i18n parameters with : siteName the site name login the login email the mail fullName the full name siteTitle the site title siteUrl the site url

language - the language

Returns:

the email html body when user sign up.

getSubjectForResetPwdEmail

public String getSubjectForResetPwdEmail(Map<String,I18nizableText> defaultI18nParams,
                                         String language)

Description copied from interface: UserSignUpConfiguration

The email subject when user reset password.

Specified by:

getSubjectForResetPwdEmail in interface UserSignUpConfiguration

Parameters:

defaultI18nParams - The default i18n parameters with : siteName the site name login the login email the mail fullName the full name token the token confirmUri the confirmation uri siteTitle the site title siteUrl the site url

language - the language

Returns:

the email subject when user reset password.

getTextBodyForResetPwdEmail

public String getTextBodyForResetPwdEmail(Map<String,I18nizableText> defaultI18nParams,
                                          String language)

Description copied from interface: UserSignUpConfiguration

The email text body when user reset password.

Specified by:

getTextBodyForResetPwdEmail in interface UserSignUpConfiguration

Parameters:

defaultI18nParams - The default i18n parameters with : siteName the site name login the login email the mail fullName the full name token the token confirmUri the confirmation uri siteTitle the site title siteUrl the site url

language - the language

Returns:

the email text body when user reset password.

getHtmlBodyForResetPwdEmail

public String getHtmlBodyForResetPwdEmail(Map<String,I18nizableText> defaultI18nParams,
                                          String language)

Description copied from interface: UserSignUpConfiguration

The email html body when user reset password.

Specified by:

getHtmlBodyForResetPwdEmail in interface UserSignUpConfiguration

Parameters:

defaultI18nParams - The default i18n parameters with : siteName the site name login the login email the mail fullName the full name token the token confirmUri the confirmation uri siteTitle the site title siteUrl the site url

language - the language

Returns:

the email html body when user reset password.

_getI18nizableText

protected I18nizableText _getI18nizableText(String fullI18nKey,
                                            Map<String,I18nizableText> i18nParams)

Get the I18nizableText from the configured key and i18n parameters

Parameters:

fullI18nKey - the configured i18n key

i18nParams - the i18n parameters

Returns:

the i18nizable text