org.xwiki.captcha

Interface Captcha

All Known Implementing Classes:

WrappedScriptCaptcha

@Unstable
 @Role
public interface Captcha

Describes a CAPTCHA that is able to display a challenge and validate and answer for the current context (i.e. user, request, XWiki Context, etc.).

Since:

10.8RC1

Version:

$Id: c4f0b1cea17eca4cb468fc9fee6a3237ea54b836 $

Method Summary

Modifier and Type	Method and Description
String	display()
String	display(Map<String,Object> parameters)
boolean	isValid()
boolean	isValid(Map<String,Object> parameters)

Method Detail

display

String display()
        throws CaptchaException

Returns:

the generated and displayed CAPTCHA challenge for the current context

Throws:

CaptchaException - in case of problems

display

String display(Map<String,Object> parameters)
        throws CaptchaException

Parameters:

parameters - the configuration values to override when displaying the CAPTCHA. Missing parameters value are taken from the CAPTCHA's configuration

Returns:

the generated and displayed CAPTCHA challenge for the current context using the given parameters to override the configuration

Throws:

CaptchaException - in case of problems

isValid

boolean isValid()
         throws CaptchaException

Returns:

true if the CAPTCHA answer passed to the current context is valid; false otherwise

Throws:

CaptchaException - in case of problems

isValid

boolean isValid(Map<String,Object> parameters)
         throws CaptchaException

Parameters:

parameters - the configuration values to override when validating the CAPTCHA's answer. Missing parameters value are taken from the CAPTCHA's configuration

Returns:

true if the CAPTCHA answer passed to the current context, using the given parameters to override the configuration, is valid; false otherwise

Throws:

CaptchaException - in case of problems