Class VerifyEmailAccountConfig
- java.lang.Object
-
- org.forgerock.selfservice.stages.email.VerifyEmailAccountConfig
-
- All Implemented Interfaces:
StageConfig
public final class VerifyEmailAccountConfig extends Object implements StageConfig
Configuration for the email account verification stage.- Since:
- 0.1.0
-
-
Constructor Summary
Constructors Constructor Description VerifyEmailAccountConfig()
-
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.String
getIdentityEmailField()
Gets the field name for the identity email address.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
getVerificationLink()
Gets the verification URL to be passed into the email body.String
getVerificationLinkToken()
Gets the string token representing where the verification URL should be substituted.int
hashCode()
VerifyEmailAccountConfig
setEmailServiceParameters(Map<String,String> emailServiceParameters)
Sets any parameters for the email service.VerifyEmailAccountConfig
setEmailServiceUrl(String emailServiceUrl)
Sets the URL for the email service.VerifyEmailAccountConfig
setFrom(String from)
Sets the from part for the verification email.VerifyEmailAccountConfig
setIdentityEmailField(String identityEmailField)
Sets the field name for the identity email address.VerifyEmailAccountConfig
setMessageTranslations(Map<Locale,String> messageTranslations)
Sets the message map for the verification email.VerifyEmailAccountConfig
setMimeType(String mimeType)
Sets the message mime-type.VerifyEmailAccountConfig
setSubjectTranslations(Map<Locale,String> subjectTranslations)
Sets the subject map for the verification email.VerifyEmailAccountConfig
setVerificationLink(String verificationLink)
Sets the verification URL to be passed into the email body.VerifyEmailAccountConfig
setVerificationLinkToken(String verificationLinkToken)
Sets the string token representing where the verification URL 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 VerifyEmailAccountConfig 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 VerifyEmailAccountConfig 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 VerifyEmailAccountConfig 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 VerifyEmailAccountConfig 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 VerifyEmailAccountConfig 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 VerifyEmailAccountConfig setFrom(String from)
Sets the from part for the verification email.- Parameters:
from
- the email from field- Returns:
- this config instance
-
getVerificationLinkToken
public String getVerificationLinkToken()
Gets the string token representing where the verification URL should be substituted.- Returns:
- the verification URL string token
-
setVerificationLinkToken
public VerifyEmailAccountConfig setVerificationLinkToken(String verificationLinkToken)
Sets the string token representing where the verification URL should be substituted.- Parameters:
verificationLinkToken
- the verification URL string token- Returns:
- this config instance
-
getVerificationLink
public String getVerificationLink()
Gets the verification URL to be passed into the email body.- Returns:
- the verification URL
-
setVerificationLink
public VerifyEmailAccountConfig setVerificationLink(String verificationLink)
Sets the verification URL to be passed into the email body.- Parameters:
verificationLink
- the verification URL- Returns:
- this config instance
-
getIdentityEmailField
public String getIdentityEmailField()
Gets the field name for the identity email address.- Returns:
- the identity email address field name
-
setIdentityEmailField
public VerifyEmailAccountConfig setIdentityEmailField(String identityEmailField)
Sets the field name for the identity email address.- Parameters:
identityEmailField
- the identity email address field name- 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
-
-