C
- represents the subtype of stage config that the concrete progress stage is expectingpublic interface ProgressStage<C extends StageConfig>
The method ProgressStage.gatherInitialRequirements(ProcessContext, StageConfig)
is invoke first and provides
an opportunity for the stage to return some initial requirements. The method
ProgressStage.advance(ProcessContext, StageConfig)
is repeatedly after for every
StageResponse
that is returned containing some requirements. Stage tags can be used in the stage response to
help track progress in the stage itself. State can also be added to the stage response to pass data throughout the
flow.
Modifier and Type | Method and Description |
---|---|
StageResponse |
advance(ProcessContext context,
C config)
Advance the progress stage.
|
JsonValue |
gatherInitialRequirements(ProcessContext context,
C config)
Response for defining any initial requirements the stage may have.
|
JsonValue gatherInitialRequirements(ProcessContext context, C config) throws ResourceException
An empty json object implies no initial requirements.
context
- the current process contextconfig
- the stage configurationResourceException
- if some expected state is invalidStageResponse advance(ProcessContext context, C config) throws ResourceException
context
- the current process contextconfig
- the stage configurationResourceException
- if some expected state or input is invalidCopyright © 2010-2018, ForgeRock All Rights Reserved.