org.forgerock.selfservice.stages.user

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME Name of the stage configuration.

Constructor Summary

Constructors

Constructor and Description
EmailUsernameConfig()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
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	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.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Name of the stage configuration.

See Also:

Constant Field Values

Constructor Detail

EmailUsernameConfig

public EmailUsernameConfig()

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

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 interface StageConfig

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 interface StageConfig

Returns:

the progress stage class name

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object