Class RetrieveUsernameStage
- java.lang.Object
-
- org.forgerock.selfservice.stages.user.RetrieveUsernameStage
-
- All Implemented Interfaces:
ProgressStage<RetrieveUsernameConfig>
public final class RetrieveUsernameStage extends Object implements ProgressStage<RetrieveUsernameConfig>
Stage is responsible for retrieving the username.- Since:
- 0.7.0
-
-
Constructor Summary
Constructors Constructor Description RetrieveUsernameStage()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StageResponse
advance(ProcessContext context, RetrieveUsernameConfig config)
Advance the progress stage.JsonValue
gatherInitialRequirements(ProcessContext context, RetrieveUsernameConfig config)
Response for defining any initial requirements the stage may have.
-
-
-
Method Detail
-
gatherInitialRequirements
public JsonValue gatherInitialRequirements(ProcessContext context, RetrieveUsernameConfig 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 interfaceProgressStage<RetrieveUsernameConfig>
- Parameters:
context
- the current process contextconfig
- 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, RetrieveUsernameConfig config) throws ResourceException
Description copied from interface:ProgressStage
Advance the progress stage.- Specified by:
advance
in interfaceProgressStage<RetrieveUsernameConfig>
- Parameters:
context
- the current process contextconfig
- the stage configuration- Returns:
- the result of invoking this stage
- Throws:
ResourceException
- if some expected state or input is invalid
-
-