org.molgenis.security.captcha

Class CaptchaService

java.lang.Object

org.molgenis.security.captcha.CaptchaService

@Scope(proxyMode=TARGET_CLASS,
       value="session")
@Service
public class CaptchaService
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
CaptchaService()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	consumeCaptcha(java.lang.String captchaAnswer) Validates and consumes a captcha.
java.awt.image.BufferedImage	createCaptcha(int width, int height) Creates a Captcha and stores it in the session.
boolean	validateCaptcha(java.lang.String captchaAnswer) Validates a captcha answer.

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptchaService

public CaptchaService()

Method Detail

createCaptcha

public java.awt.image.BufferedImage createCaptcha(int width,
                                         int height)

Creates a Captcha and stores it in the session.

Parameters:

width - the width of the image

height - the height of the image

Returns:

BufferedImage containing the captcha image

validateCaptcha

public boolean validateCaptcha(java.lang.String captchaAnswer)
                        throws CaptchaException

Validates a captcha answer. The same captcha can be validated multiple times.

Parameters:

captchaAnswer - the String to validate

Returns:

boolean indicating if the answer is correct

Throws:

CaptchaException - if no captcha found to validate

consumeCaptcha

public boolean consumeCaptcha(java.lang.String captchaAnswer)
                       throws CaptchaException

Validates and consumes a captcha. Validates the answer and removes the captcha from the user's session if the answer was correct. A captcha can be consumed only once.

Throws:

CaptchaException - if no captcha found to consume