com.octo.captcha.engine
Interface CaptchaEngine

All Known Implementing Classes:

BaffleListGimpyEngine, BasicGimpyEngine, BasicListGimpyEngine, BufferedEngineContainer, DefaultGimpyEngine, DefaultImageCaptchaEngine, DefaultSoundCaptchaEngine, DeformedBaffleListGimpyEngine, DoubleRandomListGimpyEngine, FilteredBaffleListGimpyEngine, FilteredDoubleRandomListGimpyEngine, FilteredGimpyEngine, FilteredListGimpyEngine, GenericCaptchaEngine, ImageCaptchaEngine, ListImageCaptchaEngine, ListSoundCaptchaEngine, MultipleGimpyEngine, NonLinearTextGimpyEngine, QuartzBufferedEngineContainer, SimpleBufferedEngineContainer, SimpleFishEyeEngine, SimpleListImageCaptchaEngine, SimpleListSoundCaptchaEngine, SoundCaptchaEngine, SpellerSoundCaptchaEngine

public interface CaptchaEngine

CaptchaEngine is the main interface from an application point of view : it uses CapchaFactories in order to return new captchas.

It has thes reponsibilty of creating CatpchaFactory instances and to provide an easy way to retrieve captchas. Sub classes may implement container services around capcthas as, for example, Captchas pooling, serialization, and so.

Method Summary

CaptchaFactory[]	getFactories()
Captcha	getNextCaptcha() This return a new captcha.
Captcha	getNextCaptcha(java.util.Locale locale) This return a new captcha.
void	setFactories(CaptchaFactory[] factories)

Method Detail

getNextCaptcha

Captcha getNextCaptcha()

This return a new captcha. It may be used directly.

Returns:

a new Captcha

getNextCaptcha

Captcha getNextCaptcha(java.util.Locale locale)

This return a new captcha. It may be used directly.

Parameters:

locale - the desired locale

Returns:

a new Captcha

getFactories

CaptchaFactory[] getFactories()

Returns:

captcha factories used by this engine

setFactories

void setFactories(CaptchaFactory[] factories)
                  throws CaptchaEngineException

Parameters:

factories - new captcha factories for this engine

Throws:

CaptchaEngineException - if the factories are invalid for this engine