Package org.cyclos.services.system

Interface CaptchaService

All Superinterfaces:

Service

public interface CaptchaService
extends Service

Contains methods which can be used to handle captcha challenges

Method Summary

Modifier and Type	Method	Description
String	generate(String previousChallenge)	Generates a new internal captcha challenge, returning it's identifier
boolean	isValid(@NotNull String id, @NotNull String text)	Returns whether the given internal captcha challenge is valid
SerializableInputStream	readImage(@NotNull String id, BasicGroupVO basicGroup, DimensionsDTO dimensions)	Returns the image which corresponds to the given internal captcha id and using the background defined for the specified group
void	remove(String id)	Removes the given internal captcha challenge with the given id

Method Detail

generate

String generate(String previousChallenge)
         throws FrameworkException

Generates a new internal captcha challenge, returning it's identifier

Throws:

FrameworkException

isValid

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

Returns whether the given internal 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 internal captcha id and using the background defined for the specified group

Throws:

FrameworkException

remove

void remove(String id)

Removes the given internal captcha challenge with the given id