Package org.forgerock.selfservice.stages.user

Class EmailUsernameStage

java.lang.Object

org.forgerock.selfservice.stages.user.EmailUsernameStage

All Implemented Interfaces:

ProgressStage<EmailUsernameConfig>

public final class EmailUsernameStage
extends Object
implements ProgressStage<EmailUsernameConfig>

Stage is responsible for retrieving the user name.

Since:

0.8.0

Constructor Summary

Constructors

Constructor	Description
EmailUsernameStage(ConnectionFactory connectionFactory, ExecutorService executorService)	Constructs a new stage.

Method Summary

Modifier and Type	Method	Description
StageResponse	advance(ProcessContext context, EmailUsernameConfig config)	Advance the progress stage.
JsonValue	gatherInitialRequirements(ProcessContext context, EmailUsernameConfig 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

EmailUsernameStage

@Inject
public EmailUsernameStage(ConnectionFactory connectionFactory,
 ExecutorService executorService)

Constructs a new stage.

Parameters:

connectionFactory - the CREST connection factory

executorService - an executor for asynchronous email sending

Method Details

gatherInitialRequirements

public JsonValue gatherInitialRequirements(ProcessContext context,
 EmailUsernameConfig 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<EmailUsernameConfig>

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,
 EmailUsernameConfig config)
                      throws ResourceException

Description copied from interface: ProgressStage

Advance the progress stage.

Specified by:

advance in interface ProgressStage<EmailUsernameConfig>

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