Package org.ametys.plugins.captchetat.captcha

Class CaptchEtatHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.captchetat.captcha.CaptchEtatHelper

All Implemented Interfaces:

LogEnabled, Initializable, Component, Serviceable

Direct Known Subclasses:

CaptchEtatHelper

public class CaptchEtatHelper
extends AbstractLogEnabled
implements Component, Initializable, Serviceable

Captcha implementation with images

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	CaptchEtatHelper.Endpoint	The type of endpoint available for Captchetat

Field Summary

Fields

Modifier and Type	Field	Description
protected CaptchEtatHelper.Endpoint	_endpoint	the endpoint present in configuration
static final String	CAPCHETAT_TOKEN_CACHE	id of the token cache
static final String	ROLE	Role

Constructor Summary

Constructors

Constructor	Description
CaptchEtatHelper()

Method Summary

Modifier and Type	Method	Description
protected String	_getIdentifierParameterName()	Get the name of the parameter for identifier when contacting the API
boolean	checkAndInvalidateCaptcha(String key, String value)	Check if the captcha is correct
String	getEndpoint()	get Token
String	getToken()	get Token
void	initialize()	Initialize
void	service(ServiceManager smanager)

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

Field Details

ROLE

public static final String ROLE

Role

CAPCHETAT_TOKEN_CACHE

public static final String CAPCHETAT_TOKEN_CACHE

id of the token cache

_endpoint

protected CaptchEtatHelper.Endpoint _endpoint

the endpoint present in configuration

Constructor Details

CaptchEtatHelper

public CaptchEtatHelper()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()

Initialize

Specified by:

initialize in interface Initializable

getToken

public String getToken()

get Token

Returns:

token

getEndpoint

public String getEndpoint()

get Token

Returns:

token

checkAndInvalidateCaptcha

public boolean checkAndInvalidateCaptcha(String key,
 String value)

Check if the captcha is correct

Parameters:

key - the key

value - the value

Returns:

true if correct

_getIdentifierParameterName

protected String _getIdentifierParameterName()

Get the name of the parameter for identifier when contacting the API

Returns:

the parameter name