Class CaptchaResult
- java.lang.Object
-
- com.pingidentity.sdk.captchaprovider.CaptchaResult
-
public class CaptchaResult extends Object
Contains information about the result ofCaptchaProvider.validateCaptcha(com.pingidentity.sdk.captchaprovider.CaptchaContext).- Since:
- 11.2
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CaptchaResultcreateInvalidResult(AttributeMap responseAttributes)Creates a newCaptchaResultinstance to represent a invalid CAPTCHA result.static CaptchaResultcreateValidResult(AttributeMap responseAttributes)Creates a newCaptchaResultinstance to represent a valid CAPTCHA result.AttributeMapgetResponseAttributes()The response attributes provide more information about the CAPTCHA process back to PingFederate which can then be used downstream in the flow.booleanisValid()If configured to false, PingFederate will treat the CAPTCHA process as failed.
-
-
-
Method Detail
-
isValid
public boolean isValid()
If configured to false, PingFederate will treat the CAPTCHA process as failed.- Returns:
- whether the CAPTCHA was successful.
-
getResponseAttributes
public AttributeMap getResponseAttributes()
The response attributes provide more information about the CAPTCHA process back to PingFederate which can then be used downstream in the flow.- Returns:
- A
AttributeMapcontaining attributes from the CAPTCHA validation which may be used downstream in flow.
-
createValidResult
public static CaptchaResult createValidResult(AttributeMap responseAttributes)
Creates a newCaptchaResultinstance to represent a valid CAPTCHA result.- Parameters:
responseAttributes- AAttributeMapcontaining attributes from the CAPTCHA validation which may be used downstream in flow.
-
createInvalidResult
public static CaptchaResult createInvalidResult(AttributeMap responseAttributes)
Creates a newCaptchaResultinstance to represent a invalid CAPTCHA result.- Parameters:
responseAttributes- AAttributeMapcontaining attributes from the CAPTCHA validation which may be used downstream in flow.
-
-