com.aspc.captcha

Class Captcha

java.lang.Object

com.aspc.captcha.Captcha

Direct Known Subclasses:

JCaptcha

public abstract class Captcha
extends java.lang.Object

THREAD MODE: SINGLE-THREADED

Since:

August 14, 2007, 9:41 AM

Author:

Jason McGrath

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAPTCHA_SESSION_KEY The key used when storing session details for validating a response against a CAPTCHA challenge

Constructor Summary

Constructors

Constructor and Description
Captcha()

Method Summary

Modifier and Type	Method and Description
abstract void	createImage(HttpSession session, java.io.OutputStream os) Generate the image
static Captcha	getInstance() Returns an Captcha object to be used for handling of CAPTCHA challenges and validation.
abstract boolean	validateResponse(HttpSession session, java.lang.String response) Validate the response

Methods inherited from class java.lang.Object

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

Field Detail

CAPTCHA_SESSION_KEY

public static final java.lang.String CAPTCHA_SESSION_KEY

The key used when storing session details for validating a response against a CAPTCHA challenge

See Also:

Constant Field Values

Constructor Detail

Captcha

public Captcha()

Method Detail

getInstance

public static final Captcha getInstance()

Returns an Captcha object to be used for handling of CAPTCHA challenges and validation.

Returns:

Capthca object

createImage

public abstract void createImage(HttpSession session,
                                 java.io.OutputStream os)
                          throws java.lang.Exception

Generate the image

Parameters:

session - Current HTTPSession

os - OutputStream that image is to be written to

Throws:

java.lang.Exception - The image could not be generated

validateResponse

public abstract boolean validateResponse(HttpSession session,
                                         java.lang.String response)

Validate the response

Parameters:

session - Current HTTPSesssion

response - Text supplied by user to be validated against current CAPTCHA source

Returns:

Generated image