Package com.adobe.aemds.guide.service

Interface GuideCaptchaValidatorProvider

@ProviderType
public interface GuideCaptchaValidatorProvider

Defines the interface to manage CAPTCHA validation providers

Method Summary

Modifier and Type	Method	Description
GuideCaptchaValidator	getGuideCaptchaValidator(java.lang.String validatorName)	Returns the appropriate CAPTCHA validator given it's name e.g for validatorName = "recaptcha" it will return the ReCaptchaValidator Note that all returned instances would be implementations of GuideCaptchaValidator
GuideCaptchaValidationResult	validateCAPTCHA(CaptchaInfo captchaInfo, java.lang.String userResponseToken)
GuideCaptchaValidationResult	validateCAPTCHA(java.lang.String formPath, java.lang.String userResponseToken)	Most abstract captcha validation API.

Method Detail

getGuideCaptchaValidator

GuideCaptchaValidator getGuideCaptchaValidator(java.lang.String validatorName)
                                        throws GuideException

Returns the appropriate CAPTCHA validator given it's name e.g for validatorName = "recaptcha" it will return the ReCaptchaValidator Note that all returned instances would be implementations of GuideCaptchaValidator

Parameters:

validatorName - name of the captcha validation service

Returns:

CAPTCHA validator based on validatorName

Throws:

GuideException

validateCAPTCHA

GuideCaptchaValidationResult validateCAPTCHA(java.lang.String formPath,
                                             java.lang.String userResponseToken)

Most abstract captcha validation API. Automatically handles the case of single captcha in an AF. For more complex cases, customizations can be done using GuideCaptchaValidator.validateCaptcha(java.lang.String, java.lang.String)

Parameters:

formPath - location of formContainerResource

userResponseToken - data to be used by captcha service for validation

Returns:

validateCAPTCHA

GuideCaptchaValidationResult validateCAPTCHA(CaptchaInfo captchaInfo,
                                             java.lang.String userResponseToken)

Parameters:

captchaInfo - captcha information from the form

userResponseToken - data to be used by captcha service for validation

Returns: