org.xwiki.captcha

Interface XWikiCaptchaService

@Role
public interface XWikiCaptchaService

Provides access to the classes implementing Captcha.

Since:

2.2M2

Version:

$Id: 6fa0fab6a02f5c4530ef2757498ac1572324b1a7 $

Method Summary

Modifier and Type	Method and Description
CaptchaVerifier	getCaptchaVerifier(String captchaName) Get a CaptchaVerifier from the service.
boolean	isEnabled() Deprecated. since 2.3M1 Captcha should only be enabled/disabled on an application by application basis.
List<String>	listCaptchaNames()

Method Detail

getCaptchaVerifier

CaptchaVerifier getCaptchaVerifier(String captchaName)
                            throws CaptchaVerifierNotFoundException

Get a CaptchaVerifier from the service.

Parameters:

captchaName - The name of the type of captcha, use listCaptchaNames() for a list

Returns:

A captcha object which can be used to check a specific answer for a given challange

Throws:

CaptchaVerifierNotFoundException - If the named VaptchaVerifier could not be found.

listCaptchaNames

List<String> listCaptchaNames()

Returns:

a List of the names of all registered classes implementing CaptchaVerifier.

isEnabled

@Deprecated
boolean isEnabled()

Deprecated. since 2.3M1 Captcha should only be enabled/disabled on an application by application basis.

If this is false, the captcha system will still work. It is for velocity scripts to determine whether captchas are needed.

Returns:

Is the captcha service enabled in the configuration.