Package org.forgerock.selfservice.stages.parameters

Class ParametersStage

java.lang.Object

org.forgerock.selfservice.stages.parameters.ParametersStage

All Implemented Interfaces:

ProgressStage<ParametersConfig>

public final class ParametersStage
extends Object
implements ProgressStage<ParametersConfig>

Captures input parameters to be passed back out at the end of the process.

Constructor Summary

Constructors

Constructor	Description
ParametersStage()

Method Summary

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

ParametersStage

public ParametersStage()

Method Details

gatherInitialRequirements

public JsonValue gatherInitialRequirements(ProcessContext context,
 ParametersConfig config)

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<ParametersConfig>

Parameters:

context - the current process context

config - the stage configuration

Returns:

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

advance

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

Description copied from interface: ProgressStage

Advance the progress stage.

Specified by:

advance in interface ProgressStage<ParametersConfig>

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