Package org.forgerock.selfservice.stages.email

Class RetrieveEmailStage

java.lang.Object

org.forgerock.selfservice.stages.email.RetrieveEmailStage

All Implemented Interfaces:

ProgressStage<RetrieveEmailConfig>

public final class RetrieveEmailStage
extends Object
implements ProgressStage<RetrieveEmailConfig>

Stage is responsible for retrieving the email.

Constructor Summary

Constructors

Constructor	Description
RetrieveEmailStage()

Method Summary

Modifier and Type	Method	Description
StageResponse	advance(ProcessContext context, RetrieveEmailConfig config)	Advance the progress stage.
JsonValue	gatherInitialRequirements(ProcessContext context, RetrieveEmailConfig config)	Response for defining any initial requirements the stage may have.

Methods inherited from class java.lang.Object

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

Constructor Details

RetrieveEmailStage

public RetrieveEmailStage()

Method Details

gatherInitialRequirements

public JsonValue gatherInitialRequirements(ProcessContext context,
 RetrieveEmailConfig config)
                                    throws ResourceException

Description copied from interface: ProgressStage

Response for defining any initial requirements the stage may have.

An empty json object implies no initial requirements.

Specified by:

gatherInitialRequirements in interface ProgressStage<RetrieveEmailConfig>

Parameters:

context - the current process context

config - the stage configuration

Returns:

json value representing the requirements or empty json object for no requirements

Throws:

ResourceException - if some expected state is invalid

advance

public StageResponse advance(ProcessContext context,
 RetrieveEmailConfig config)
                      throws ResourceException

Description copied from interface: ProgressStage

Advance the progress stage.

Specified by:

advance in interface ProgressStage<RetrieveEmailConfig>

Parameters:

context - the current process context

config - the stage configuration

Returns:

the result of invoking this stage

Throws:

ResourceException - if some expected state or input is invalid