Package org.forgerock.selfservice.stages.captcha

Class CaptchaStage

java.lang.Object

org.forgerock.selfservice.stages.captcha.CaptchaStage

All Implemented Interfaces:

ProgressStage<CaptchaStageConfig>

public final class CaptchaStage
extends Object
implements ProgressStage<CaptchaStageConfig>

Stage is responsible for captcha based security.

Since:

0.2.0

Constructor Summary

Constructors

Constructor	Description
CaptchaStage(Client httpClient)	Constructs a new captcha stage.

Method Summary

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

CaptchaStage

@Inject
public CaptchaStage(Client httpClient)

Constructs a new captcha stage.

Parameters:

httpClient - the http client

Method Detail

gatherInitialRequirements

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

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

Description copied from interface: ProgressStage

Advance the progress stage.

Specified by:

advance in interface ProgressStage<CaptchaStageConfig>

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