Package org.ametys.core.captcha

Class AbstractCaptcha

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.captcha.AbstractCaptcha

All Implemented Interfaces:

Captcha, LogEnabled, PluginAware, Configurable

Direct Known Subclasses:

JCaptcha, ReCaptchaEnterprise, ReCaptchaV2

public abstract class AbstractCaptcha
extends AbstractLogEnabled
implements PluginAware, Configurable, Captcha

Abstract class for Captchas to handle common methods such as retrieving wanted xsl file

Constructor Summary

Constructors

Constructor	Description
AbstractCaptcha()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
Collection<String>	getConfigParameters()	Get the list of config parameters referenced by this captcha implementation
String	getId()	Get the Captcha type id
String	getLoginSCSSURL()	Get the scss file
String	getXSLHelperURL()	Get the helper xsl file
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.

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

Methods inherited from interface org.ametys.core.captcha.Captcha

checkAndInvalidateCaptcha, getLabel, getLoginFailedBecauseCaptchaFailedLabel, getLoginFailedBecauseTooManyAttemptLabel, getUsedUrlPatterns, requireUserInteraction

Constructor Details

AbstractCaptcha

public AbstractCaptcha()

Method Details

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

getId

public String getId()

Description copied from interface: Captcha

Get the Captcha type id

Specified by:

getId in interface Captcha

Returns:

the id

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getConfigParameters

public Collection<String> getConfigParameters()

Description copied from interface: Captcha

Get the list of config parameters referenced by this captcha implementation

Specified by:

getConfigParameters in interface Captcha

Returns:

list of parameters

getXSLHelperURL

public String getXSLHelperURL()
                       throws SourceException

Description copied from interface: Captcha

Get the helper xsl file

Specified by:

getXSLHelperURL in interface Captcha

Returns:

the source

Throws:

SourceException - if an error occurred while reading the xsl file

getLoginSCSSURL

public String getLoginSCSSURL()
                       throws SourceException

Description copied from interface: Captcha

Get the scss file

Specified by:

getLoginSCSSURL in interface Captcha

Returns:

the source

Throws:

SourceException - if an error occurred while reading the xsl file