Package org.ametys.plugins.core.impl.captcha.recaptcha

Class ReCaptchaEnterprise

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.captcha.AbstractCaptcha

org.ametys.plugins.core.impl.captcha.recaptcha.ReCaptchaEnterprise

All Implemented Interfaces:

Captcha, LogEnabled, PluginAware, Initializable, Configurable, Serviceable

public class ReCaptchaEnterprise
extends AbstractCaptcha
implements Serviceable, Initializable

Captcha implementation with reCaptcha Enterprise

Constructor Summary

Constructors

Constructor	Description
ReCaptchaEnterprise()

Method Summary

Modifier and Type	Method	Description
boolean	checkAndInvalidateCaptcha(String key, String value)	Check if the Captcha is correct
I18nizableText	getLabel()	Get the Captcha type label
I18nizableText	getLoginFailedBecauseCaptchaFailedLabel()	Get the label to display when login has failed with this captcha
I18nizableText	getLoginFailedBecauseTooManyAttemptLabel()	Get the label to display when too many attempt have been done
List<Pattern>	getUsedUrlPatterns()	Get the minimal url patterns used by the captcha implementation.
void	initialize()
boolean	requireUserInteraction()	Indicate if the captcha requires user interaction and should be displayed as a form entry
void	service(ServiceManager manager)

Methods inherited from class org.ametys.core.captcha.AbstractCaptcha

configure, getConfigParameters, getId, getLoginSCSSURL, getXSLHelperURL, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Details

ReCaptchaEnterprise

public ReCaptchaEnterprise()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

requireUserInteraction

public boolean requireUserInteraction()

Description copied from interface: Captcha

Indicate if the captcha requires user interaction and should be displayed as a form entry

Specified by:

requireUserInteraction in interface Captcha

Returns:

true if the captcha requires user interaction

checkAndInvalidateCaptcha

public boolean checkAndInvalidateCaptcha(String key,
 String value)

Description copied from interface: Captcha

Check if the Captcha is correct

Specified by:

checkAndInvalidateCaptcha in interface Captcha

Parameters:

key - the key

value - the value

Returns:

true if correct

getLabel

public I18nizableText getLabel()

Description copied from interface: Captcha

Get the Captcha type label

Specified by:

getLabel in interface Captcha

Returns:

the label

getLoginFailedBecauseCaptchaFailedLabel

public I18nizableText getLoginFailedBecauseCaptchaFailedLabel()

Description copied from interface: Captcha

Get the label to display when login has failed with this captcha

Specified by:

getLoginFailedBecauseCaptchaFailedLabel in interface Captcha

Returns:

the label

getLoginFailedBecauseTooManyAttemptLabel

public I18nizableText getLoginFailedBecauseTooManyAttemptLabel()

Description copied from interface: Captcha

Get the label to display when too many attempt have been done

Specified by:

getLoginFailedBecauseTooManyAttemptLabel in interface Captcha

Returns:

the label

getUsedUrlPatterns

public List<Pattern> getUsedUrlPatterns()

Description copied from interface: Captcha

Get the minimal url patterns used by the captcha implementation. This is necessary to grant those url even when the user is not authentified (in particular to set a catpcha on the login page). Do no put a too wide range (such as ^.*$) since it may introduce security issues.

Specified by:

getUsedUrlPatterns in interface Captcha

Returns:

The minimal url patterns used by the captcha implementation.