com.atlassian.confluence.security
Interface CaptchaManager

All Known Implementing Classes:

DefaultCaptchaManager

public interface CaptchaManager

Method Summary

Collection	addCaptchaGroups(Collection selectedGroups) Method adds a Collection of group names to the existing groups for the captcha group setting.
void	excludeGroups()
void	excludeNone()
void	excludeRegisteredUsers()
String	getExclude()
com.octo.captcha.service.image.ImageCaptchaService	getImageCaptchaService()
boolean	isCaptchaAvailable()
boolean	isCaptchaEnabled()
void	removeCaptchaGroup(String group) Removes a group from the list of captcha groups
void	setCaptchaEnabled(boolean value)
void	setCaptchaGroups(Collection groupList)
void	setExclude(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(String captchaId, String captchaResponse) validate captcha response

Method Detail

validateCaptcha

public boolean validateCaptcha(String captchaId,
                               String captchaResponse)

validate captcha response

Parameters:

captchaId -

captchaResponse -

Returns:

boolean

isCaptchaEnabled

public boolean isCaptchaEnabled()

setCaptchaEnabled

public void setCaptchaEnabled(boolean value)

getExclude

public String getExclude()

setExclude

public void setExclude(String value)

addCaptchaGroups

public Collection addCaptchaGroups(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

public void removeCaptchaGroup(String group)

Removes a group from the list of captcha groups

Parameters:

group - String

showCaptchaForCurrentUser

public boolean showCaptchaForCurrentUser()

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

excludeNone

public void excludeNone()

excludeRegisteredUsers

public void excludeRegisteredUsers()

excludeGroups

public void excludeGroups()

setCaptchaGroups

public void setCaptchaGroups(Collection groupList)

isCaptchaAvailable

public boolean isCaptchaAvailable()

setImageCaptchaService

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

getImageCaptchaService

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