Package com.ibm.security.access.recaptcha

Class RecaptchaClient

java.lang.Object

com.ibm.security.access.recaptcha.RecaptchaClient

public class RecaptchaClient
extends Object

This is the ReCAPTCHA class exposed to the JavaScript mapping rules.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HttpClient_java_copyright
static final String	HttpClient_java_sourceCodeID

Constructor Summary

Constructors

Constructor	Description
RecaptchaClient()

Method Summary

Modifier and Type	Method	Description
static boolean	verify(String response, String secret, String serviceLocation)	This wraps the real verify method and provides a simple yes/no response.
static String	verifyV3(String response, String secret, String serviceLocation)	This wraps the real verify method and return the serialsed JSON assessment from the provider.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

HttpClient_java_sourceCodeID

public static final String HttpClient_java_sourceCodeID

See Also:

• Constant Field Values

HttpClient_java_copyright

public static final String HttpClient_java_copyright

See Also:

• Constant Field Values

Constructor Details

RecaptchaClient

public RecaptchaClient()

Method Details

verify

public static boolean verify(String response,
 String secret,
 String serviceLocation)

This wraps the real verify method and provides a simple yes/no response. As this method swallows any exceptions, it is intended to only be called from the JaveScript mapping rules. If you are intending to verify ReCAPTCHA internally, please see RecaptchaClientInternal.verify(...)

Parameters:

response - The CAPTCHA response collected from the client.

secret - The API secret.

serviceLocation - The location of the ReCAPTCHA endpoint. (Passing null will use the default value.)

Returns:

true if the captcha verified successfully, false if there were errors or the captcha did not verify.

verifyV3

public static String verifyV3(String response,
 String secret,
 String serviceLocation)

This wraps the real verify method and return the serialsed JSON assessment from the provider. As this method swallows any exceptions, it is intended to only be called from the JaveScript mapping rules.

Parameters:

response - The CAPTCHA response collected from the client.

secret - The API secret.

serviceLocation - The location of the ReCAPTCHA endpoint. (Passing null will use the default value.)

Returns:

the serialized JSON response from the serviceLocation. If a response could not be parsed to JSON then an error is returned in the serialzied JSON string.