Package org.forgerock.selfservice.stages.email

Class RetrieveEmailConfig

java.lang.Object

org.forgerock.selfservice.stages.email.RetrieveEmailConfig

All Implemented Interfaces:

StageConfig

public final class RetrieveEmailConfig
extends Object
implements StageConfig

Configuration for the retrieve email stage.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
RetrieveEmailConfig()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getIdentityEmailField()	Gets the field name for the identity email address.
String	getName()	Gets the name of the stage configuration.
String	getProgressStageClassName()	Gets the class name of the consuming progress stage.
int	hashCode()
RetrieveEmailConfig	setIdentityEmailField(String identityEmailField)	Sets the field name for the identity email address.

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

Name of the stage configuration.

See Also:

• Constant Field Values

Constructor Details

RetrieveEmailConfig

public RetrieveEmailConfig()

Method Details

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

getIdentityEmailField

public String getIdentityEmailField()

Gets the field name for the identity email address.

Returns:

the identity email address field name

setIdentityEmailField

public RetrieveEmailConfig setIdentityEmailField(String identityEmailField)

Sets the field name for the identity email address.

Parameters:

identityEmailField - the identity email address field name

Returns:

this config instance

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