org.xwiki.captcha.script

Class CaptchaScriptService

java.lang.Object

org.xwiki.captcha.script.CaptchaScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Unstable
 @Component
 @Named(value="captcha")
 @Singleton
public class CaptchaScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Exposes Captchas to scripts.

Since:

10.8RC1

Version:

$Id: dda3957aa8214b67747d99a06489a54042867f0b $

Constructor Summary

Constructors

Constructor and Description
CaptchaScriptService()

Method Summary

Modifier and Type	Method and Description
Captcha	get(String captchaName)
List<String>	getCaptchaNames()
Captcha	getDefault()
String	getDefaultCaptchaName()

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptchaScriptService

public CaptchaScriptService()

Method Detail

getCaptchaNames

public List<String> getCaptchaNames()

Returns:

the list of available CAPTCHA implementation names

get

public Captcha get(String captchaName)

Parameters:

captchaName - the name of the CAPTCHA implementation to get

Returns:

the CAPTCHA implementation

getDefaultCaptchaName

public String getDefaultCaptchaName()

Returns:

the name of the configured CAPTCHA implementation to use by default

getDefault

public Captcha getDefault()

Returns:

the configured CAPTCHA implementation to use by default