com.atlassian.confluence.security
Interface CaptchaManager

All Known Implementing Classes:

DefaultCaptchaManager

public interface CaptchaManager

Method Summary

java.util.Collection	addCaptchaGroups(java.util.Collection selectedGroups) Method adds a Collection of group names to the existing groups for the captcha group setting.
void	excludeGroups()
void	excludeNone()
void	excludeRegisteredUsers()
java.lang.String	generateCaptchaId()
java.lang.String	getExclude()
com.octo.captcha.service.image.ImageCaptchaService	getImageCaptchaService()
boolean	isCaptchaAvailable()
boolean	isCaptchaEnabled()
boolean	isDebugEnabled()
void	removeCaptchaGroup(java.lang.String group) Removes a group from the list of captcha groups
void	setCaptchaEnabled(boolean value)
void	setCaptchaGroups(java.util.Collection groupList)
void	setDebugMode(boolean value) If true the captcha manager will accept "DEBUG" for every generated capthca and reject all other tokens.
void	setExclude(java.lang.String value)
void	setImageCaptchaService(com.octo.captcha.service.image.ImageCaptchaService imageCaptchaService)
boolean	showCaptchaForCurrentUser() Determines whether a capture has to be shown for the currently logged in users
boolean	validateCaptcha(java.lang.String captchaId, java.lang.String captchaResponse) validate captcha response

Method Detail

validateCaptcha

boolean validateCaptcha(java.lang.String captchaId,
                        java.lang.String captchaResponse)

validate captcha response

Parameters:

captchaId -

captchaResponse -

Returns:

boolean

isCaptchaEnabled

boolean isCaptchaEnabled()

setCaptchaEnabled

void setCaptchaEnabled(boolean value)

isDebugEnabled

boolean isDebugEnabled()

setDebugMode

void setDebugMode(boolean value)

If true the captcha manager will accept "DEBUG" for every generated capthca and reject all other tokens. This is meant primarly for acceptance testing user interface elements with Captcha forms. If true the exclude list is ignored and a Captcha prompt is supplied for all requests

Parameters:

value -

getExclude

java.lang.String getExclude()

setExclude

void setExclude(java.lang.String value)

addCaptchaGroups

java.util.Collection addCaptchaGroups(java.util.Collection selectedGroups)

Method adds a Collection of group names to the existing groups for the captcha group setting.

Parameters:

selectedGroups - Collection of group names

Returns:

Collection of added group names

removeCaptchaGroup

void removeCaptchaGroup(java.lang.String group)

Removes a group from the list of captcha groups

Parameters:

group - String

showCaptchaForCurrentUser

boolean showCaptchaForCurrentUser()

Determines whether a capture has to be shown for the currently logged in users

excludeNone

void excludeNone()

excludeRegisteredUsers

void excludeRegisteredUsers()

excludeGroups

void excludeGroups()

setCaptchaGroups

void setCaptchaGroups(java.util.Collection groupList)

isCaptchaAvailable

boolean isCaptchaAvailable()

setImageCaptchaService

void setImageCaptchaService(com.octo.captcha.service.image.ImageCaptchaService imageCaptchaService)

getImageCaptchaService

com.octo.captcha.service.image.ImageCaptchaService getImageCaptchaService()

generateCaptchaId

java.lang.String generateCaptchaId()

Returns:

a new captchaId