org.cyclos.services.system

Interface CaptchaService

All Superinterfaces:

Service

public interface CaptchaService
extends Service

Contains methods which can be used to handle captcha challenges

Author:

luis

Method Summary

Modifier and Type	Method and Description
java.lang.Long	generate() Generates a new captcha challenge, returning it's identifier
boolean	isValid(java.lang.Long id, java.lang.String text) Returns whether the captcha challenge is valid
SerializableInputStream	readImage(java.lang.Long id, BasicGroupVO basicGroup, DimensionsDTO dimensions) Returns the image which corresponds to the given captcha id and using the background defiSned for the specified group

Method Detail

generate

java.lang.Long generate()
                 throws FrameworkException

Generates a new captcha challenge, returning it's identifier

Throws:

FrameworkException

isValid

boolean isValid(@NotNull
                java.lang.Long id,
                @NotNull
                java.lang.String text)
         throws FrameworkException

Returns whether the captcha challenge is valid

Throws:

FrameworkException

readImage

SerializableInputStream readImage(@NotNull
                                  java.lang.Long id,
                                  BasicGroupVO basicGroup,
                                  DimensionsDTO dimensions)
                           throws FrameworkException

Returns the image which corresponds to the given captcha id and using the background defiSned for the specified group

Throws:

FrameworkException