C D E G H I R S V

C

Captcha - Interface in com.octo.captcha

This interface represent a CAPTCHA.

CaptchaEngine - Interface in com.octo.captcha.engine

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

CaptchaEngineException - Exception in com.octo.captcha.engine

Captcha Engine Exception

CaptchaEngineException() - Constructor for exception com.octo.captcha.engine.CaptchaEngineException

Constructs a new exception with null as its detail message.

CaptchaEngineException(String) - Constructor for exception com.octo.captcha.engine.CaptchaEngineException

Constructs a new exception with the specified detail message.

CaptchaEngineException(String, Throwable) - Constructor for exception com.octo.captcha.engine.CaptchaEngineException

Constructs a new exception with the specified detail message and cause.

CaptchaEngineException(Throwable) - Constructor for exception com.octo.captcha.engine.CaptchaEngineException

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

CaptchaException - Exception in com.octo.captcha

Runtime exception for the captcha implementations.

CaptchaException() - Constructor for exception com.octo.captcha.CaptchaException

Constructs a new exception with null as its detail message.

CaptchaException(String) - Constructor for exception com.octo.captcha.CaptchaException

Constructs a new exception with the specified detail message.

CaptchaException(String, Throwable) - Constructor for exception com.octo.captcha.CaptchaException

Constructs a new exception with the specified detail message and cause.

CaptchaException(Throwable) - Constructor for exception com.octo.captcha.CaptchaException

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

CaptchaFactory - Interface in com.octo.captcha

Interface for the CAPTCHA factories.

CaptchaService - Interface in com.octo.captcha.service

Main interface of the package.

CaptchaServiceException - Exception in com.octo.captcha.service

To be thrown when a service user is doing an illegal operation (typically wrang operation flow errors).

CaptchaServiceException(String) - Constructor for exception com.octo.captcha.service.CaptchaServiceException

Constructs a new exception with the specified detail message.

CaptchaServiceException(String, Throwable) - Constructor for exception com.octo.captcha.service.CaptchaServiceException

Constructs a new exception with the specified detail message and cause.

CaptchaServiceException(Throwable) - Constructor for exception com.octo.captcha.service.CaptchaServiceException

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).

CaptchaStore - Interface in com.octo.captcha.service.captchastore

Provides a way to temporally store captchas with a unique key

cleanAndShutdown() - Method in interface com.octo.captcha.service.captchastore.CaptchaStore

Called by the service in order to clean and shutdown the store.

com.octo.captcha - package com.octo.captcha

com.octo.captcha.engine - package com.octo.captcha.engine

com.octo.captcha.service - package com.octo.captcha.service

com.octo.captcha.service.captchastore - package com.octo.captcha.service.captchastore

D

disposeChallenge() - Method in interface com.octo.captcha.Captcha

Dispose the challenge, once this method is call the getChallenge method will return null.
It has been added for technical reasons : a captcha is always used in a two step fashion
First submit the challenge, and then wait until the response arrives.
It had been asked to have a method to dispose the challenge that is no longer used after being dipslayed.

E

empty() - Method in interface com.octo.captcha.service.captchastore.CaptchaStore

Empty the store

G

getCaptcha() - Method in interface com.octo.captcha.CaptchaFactory

builds a captcha

getCaptcha(Locale) - Method in interface com.octo.captcha.CaptchaFactory

build Localized captcha (don't forget those captcha are for human beings!)

getCaptcha(String) - Method in interface com.octo.captcha.service.captchastore.CaptchaStore

Retrieve the captcha for this key from the store.

getCause() - Method in exception com.octo.captcha.CaptchaException

getCause() - Method in exception com.octo.captcha.engine.CaptchaEngineException

getCause() - Method in exception com.octo.captcha.service.CaptchaServiceException

getChallenge() - Method in interface com.octo.captcha.Captcha

Accerssor for the questionned challenge.

getChallengeForID(String) - Method in interface com.octo.captcha.service.CaptchaService

Method to retrieve the challenge corresponding to the given ticket.

getChallengeForID(String, Locale) - Method in interface com.octo.captcha.service.CaptchaService

Method to retrieve the challenge corresponding to the given ticket.

getFactories() - Method in interface com.octo.captcha.engine.CaptchaEngine

getKeys() - Method in interface com.octo.captcha.service.captchastore.CaptchaStore

Return all the contained keys

getLocale(String) - Method in interface com.octo.captcha.service.captchastore.CaptchaStore

Retrieve the locale for this key from the store.

getNextCaptcha() - Method in interface com.octo.captcha.engine.CaptchaEngine

This return a new captcha.

getNextCaptcha(Locale) - Method in interface com.octo.captcha.engine.CaptchaEngine

This return a new captcha.

getQuestion() - Method in interface com.octo.captcha.Captcha

Accessor captcha question.

getQuestionForID(String) - Method in interface com.octo.captcha.service.CaptchaService

Method to retrieve the question corresponding to the given ticket.

getQuestionForID(String, Locale) - Method in interface com.octo.captcha.service.CaptchaService

Method to retrieve the question corresponding to the given ticket.

getResponse() - Method in interface com.octo.captcha.Captcha

getSize() - Method in interface com.octo.captcha.service.captchastore.CaptchaStore

get the size of this store

H

hasCaptcha(String) - Method in interface com.octo.captcha.service.captchastore.CaptchaStore

Check if a captcha is stored for this id

hasGetChalengeBeenCalled() - Method in interface com.octo.captcha.Captcha

This method should return true if the getChalenge method has been called (has been added in order to properly manage the captcha state.

I

initAndStart() - Method in interface com.octo.captcha.service.captchastore.CaptchaStore

Called by the service in order to initialize and start the Store.

R

removeCaptcha(String) - Method in interface com.octo.captcha.service.captchastore.CaptchaStore

Remove the captcha with the provided id as key.

S

setFactories(CaptchaFactory[]) - Method in interface com.octo.captcha.engine.CaptchaEngine

storeCaptcha(String, Captcha) - Method in interface com.octo.captcha.service.captchastore.CaptchaStore

Deprecated. in order to implement the by locale generation, use the CaptchaStore.storeCaptcha(String, com.octo.captcha.Captcha, java.util.Locale)

storeCaptcha(String, Captcha, Locale) - Method in interface com.octo.captcha.service.captchastore.CaptchaStore

Store the captcha with the provided id as key.

V

validateResponse(Object) - Method in interface com.octo.captcha.Captcha

Validation routine for the response.

validateResponseForID(String, Object) - Method in interface com.octo.captcha.service.CaptchaService

Method to validate a response to the challenge corresponding to the given ticket.

C D E G H I R S V