Class UserRegistrationStage
java.lang.Object
org.forgerock.selfservice.stages.registration.UserRegistrationStage
- All Implemented Interfaces:
ProgressStage<UserRegistrationConfig>
public final class UserRegistrationStage
extends Object
implements ProgressStage<UserRegistrationConfig>
Stage is responsible for registering the user supplied data using the underlying service.
It expects the "user" and userId fields to be populated in the context.
- Since:
- 0.1.0
-
Constructor Summary
ConstructorsConstructorDescriptionUserRegistrationStage(ConnectionFactory connectionFactory) Constructs a new user registration stage. -
Method Summary
Modifier and TypeMethodDescriptionadvance(ProcessContext context, UserRegistrationConfig config) Advance the progress stage.gatherInitialRequirements(ProcessContext context, UserRegistrationConfig config) Response for defining any initial requirements the stage may have.
-
Constructor Details
-
UserRegistrationStage
Constructs a new user registration stage.- Parameters:
connectionFactory- the CREST connection factory
-
-
Method Details
-
gatherInitialRequirements
public JsonValue gatherInitialRequirements(ProcessContext context, UserRegistrationConfig config) throws ResourceException Description copied from interface:ProgressStageResponse for defining any initial requirements the stage may have.An empty json object implies no initial requirements.
- Specified by:
gatherInitialRequirementsin interfaceProgressStage<UserRegistrationConfig>- 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, UserRegistrationConfig config) throws ResourceException Description copied from interface:ProgressStageAdvance the progress stage.- Specified by:
advancein interfaceProgressStage<UserRegistrationConfig>- 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
-