Summary: Methods | [Expand All]
public interface

CaptchaManager

com.atlassian.confluence.security.CaptchaManager
Known Indirect Subclasses

Summary

Public Methods
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 generateCaptchaId()
String getExclude()
ImageCaptchaService getImageCaptchaService()
boolean isCaptchaAvailable()
boolean isCaptchaEnabled()
boolean isDebugEnabled()
void removeCaptchaGroup(String group)
Removes a group from the list of captcha groups
void setCaptchaEnabled(boolean value)
void setCaptchaGroups(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(String value)
void setImageCaptchaService(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

Public Methods

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

public void excludeGroups ()

public void excludeNone ()

public void excludeRegisteredUsers ()

public String generateCaptchaId ()

Returns
  • a new captchaId

public String getExclude ()

public ImageCaptchaService getImageCaptchaService ()

public boolean isCaptchaAvailable ()

public boolean isCaptchaEnabled ()

public boolean isDebugEnabled ()

public void removeCaptchaGroup (String group)

Removes a group from the list of captcha groups

Parameters
group String

public void setCaptchaEnabled (boolean value)

public void setCaptchaGroups (Collection groupList)

public 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

public void setExclude (String value)

public void setImageCaptchaService (ImageCaptchaService imageCaptchaService)

public boolean showCaptchaForCurrentUser ()

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

public boolean validateCaptcha (String captchaId, String captchaResponse)

validate captcha response

Returns
  • boolean