Package org.cyclos.services.system

Interface CaptchaService

All Superinterfaces:

Service

All Known Subinterfaces:

CaptchaServiceLocal

All Known Implementing Classes:

CaptchaServiceImpl, CaptchaServiceSecurity

public interface CaptchaService
extends Service

Contains methods which can be used to handle captcha challenges

Method Summary

Modifier and Type	Method	Description
String	generate()	Generates a new captcha challenge, returning it's identifier
boolean	isValid(@NotNull String id, @NotNull String text)	Returns whether the captcha challenge is valid
SerializableInputStream	readImage(@NotNull String 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

String generate()
         throws FrameworkException

Generates a new captcha challenge, returning it's identifier

Throws:

FrameworkException

isValid

boolean isValid(@NotNull
                @NotNull String id,
                @NotNull
                @NotNull String text)
         throws FrameworkException

Returns whether the captcha challenge is valid

Throws:

FrameworkException

readImage

SerializableInputStream readImage(@NotNull
                                  @NotNull String 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