Class EmailUsernameConfig
- java.lang.Object
-
- org.forgerock.selfservice.stages.user.EmailUsernameConfig
-
- All Implemented Interfaces:
StageConfig
public final class EmailUsernameConfig extends Object implements StageConfig
Configuration for the email based user name retrieval stage.- Since:
- 0.8.0
-
-
Constructor Summary
Constructors Constructor Description EmailUsernameConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
Map<String,String>
getEmailServiceParameters()
Gets additional parameters for the email service.String
getEmailServiceUrl()
Gets the URL for the email service.String
getFrom()
Gets the from part for the verification email.Map<Locale,String>
getMessageTranslations()
Gets the message map for the verification email.String
getMimeType()
Gets the mime-type of the email message.String
getName()
Gets the name of the stage configuration.String
getProgressStageClassName()
Gets the class name of the consuming progress stage.Map<Locale,String>
getSubjectTranslations()
Gets the subject map for the verification email.String
getUsernameToken()
Gets the string token representing where the user name should be substituted.int
hashCode()
EmailUsernameConfig
setEmailServiceParameters(Map<String,String> emailServiceParameters)
Sets any parameters for the email service.EmailUsernameConfig
setEmailServiceUrl(String emailServiceUrl)
Sets the URL for the email service.EmailUsernameConfig
setFrom(String from)
Sets the from part for the verification email.EmailUsernameConfig
setMessageTranslations(Map<Locale,String> messageTranslations)
Sets the message map for the verification email.EmailUsernameConfig
setMimeType(String mimeType)
Sets the message mime-type.EmailUsernameConfig
setSubjectTranslations(Map<Locale,String> subjectTranslations)
Sets the subject map for the verification email.EmailUsernameConfig
setUsernameToken(String usernameToken)
Sets the string token representing where the user name should be substituted.
-
-
-
Field Detail
-
NAME
public static final String NAME
Name of the stage configuration.- See Also:
- Constant Field Values
-
-
Method Detail
-
getEmailServiceUrl
public String getEmailServiceUrl()
Gets the URL for the email service.- Returns:
- the email service URL
-
setEmailServiceUrl
public EmailUsernameConfig setEmailServiceUrl(String emailServiceUrl)
Sets the URL for the email service.- Parameters:
emailServiceUrl
- the email service URL- Returns:
- this config instance
-
getEmailServiceParameters
public Map<String,String> getEmailServiceParameters()
Gets additional parameters for the email service.- Returns:
- the email service parameters
-
setEmailServiceParameters
public EmailUsernameConfig setEmailServiceParameters(Map<String,String> emailServiceParameters)
Sets any parameters for the email service.- Parameters:
emailServiceParameters
- the email service Parameters- Returns:
- this config instance
-
getSubjectTranslations
public Map<Locale,String> getSubjectTranslations()
Gets the subject map for the verification email.- Returns:
- the email subject map (locale to string)
-
setSubjectTranslations
public EmailUsernameConfig setSubjectTranslations(Map<Locale,String> subjectTranslations)
Sets the subject map for the verification email.- Parameters:
subjectTranslations
- the email subject map (locale to string)- Returns:
- this config instance
-
getMessageTranslations
public Map<Locale,String> getMessageTranslations()
Gets the message map for the verification email.- Returns:
- the email message map (locale to string)
-
setMessageTranslations
public EmailUsernameConfig setMessageTranslations(Map<Locale,String> messageTranslations)
Sets the message map for the verification email.- Parameters:
messageTranslations
- the email message map (locale to string)- Returns:
- this config instance
-
getMimeType
public String getMimeType()
Gets the mime-type of the email message.- Returns:
- the message mime-type
-
setMimeType
public EmailUsernameConfig setMimeType(String mimeType)
Sets the message mime-type.- Parameters:
mimeType
- the message mime-type- Returns:
- this config instance
-
getFrom
public String getFrom()
Gets the from part for the verification email.- Returns:
- the email from field
-
setFrom
public EmailUsernameConfig setFrom(String from)
Sets the from part for the verification email.- Parameters:
from
- the email from field- Returns:
- this config instance
-
getUsernameToken
public String getUsernameToken()
Gets the string token representing where the user name should be substituted.- Returns:
- the user name string token
-
setUsernameToken
public EmailUsernameConfig setUsernameToken(String usernameToken)
Sets the string token representing where the user name should be substituted.- Parameters:
usernameToken
- the user name string token- Returns:
- this config instance
-
getName
public String getName()
Description copied from interface:StageConfig
Gets the name of the stage configuration.- Specified by:
getName
in interfaceStageConfig
- Returns:
- the config name
-
getProgressStageClassName
public String getProgressStageClassName()
Description copied from interface:StageConfig
Gets the class name of the consuming progress stage.- Specified by:
getProgressStageClassName
in interfaceStageConfig
- Returns:
- the progress stage class name
-
-