Package org.ametys.core.captcha

Class CaptchaEnumerator

java.lang.Object

org.ametys.core.captcha.CaptchaEnumerator

All Implemented Interfaces:

Enumerator<String>, Component, Serviceable

public class CaptchaEnumerator
extends Object
implements Enumerator<String>, Serviceable, Component

Enumerator for the captchas.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	Avalon role

Constructor Summary

Constructors

Constructor	Description
CaptchaEnumerator()

Method Summary

Modifier and Type	Method	Description
I18nizableText	getEntry(String value)	Retrieves a single label from a value.
Map<String,I18nizableText>	getTypedEntries()	Provides the enumerated values with their optional label.
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.runtime.model.Enumerator

getConfiguration

Field Details

ROLE

public static final String ROLE

Avalon role

Constructor Details

CaptchaEnumerator

public CaptchaEnumerator()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getEntry

public I18nizableText getEntry(String value)
                        throws Exception

Description copied from interface: Enumerator

Retrieves a single label from a value.

Specified by:

getEntry in interface Enumerator<String>

Parameters:

value - the value.

Returns:

the label or null if not found.

Throws:

Exception - if an error occurs.

getTypedEntries

public Map<String,I18nizableText> getTypedEntries()
                                           throws Exception

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Specified by:

getTypedEntries in interface Enumerator<String>

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs. TODO NEWATTRIBUTEAPI: rename this method when Enumerator will be removed