BotDetect Struts CAPTCHA Integration Quickstart

1. Add BotDetect Java CAPTCHA Library Dependency

To manually add BotDetect Captcha library to classpath, copy the following three jar files from BotDetect Java download package to application's WEB-INF/lib folder:

  • botdetect-4.0.beta1.jar
  • botdetect-servlet-4.0.beta1.jar
  • botdetect-jsp20-4.0.beta1.jar

To share BotDetect Captcha among multiple applications, these BotDetect jar files above should be copied into 'lib' directory of web container or application server's domain.

2. Show a CAPTCHA Challenge on the Form

On the very top of the source file for the web form you want to protect against bots, put BotDetect taglib declaration:

<%@taglib prefix="botDetect" uri=""%>

To render Captcha in the form, add the following within <form> you want to protect against bots:

<!-- Adding BotDetect Captcha to the page -->
<botDetect:captcha id="exampleCaptcha" userInputID="captchaCode"/>

<s:textfield name="captchaCode" id="captchaCode"/>
<s:submit name="submit" label="Submit" id="submit"/>

And you also need to add exclude directive for CaptchaServlet to Struts 2 filter by adding the following in your struts.xml configuration file:

<constant name="struts.action.excludePattern" value="/botdetectcaptcha"/>

3. Check User Input During Form Submission

When the form is submitted, the Captcha validation result must be checked in Struts Action:

public class BasicCaptchaAction extends ActionSupport {
  private String captchaCode;

  public String getCaptchaCode() {
    return captchaCode;

  public void setCaptchaCode(String captchaCode) {
    this.captchaCode = captchaCode;
  public String execute() {
    return SUCCESS;
  public void validate() {
    Captcha captcha = Captcha.load(ServletActionContext.getRequest(), "exampleCaptcha");
    boolean isHuman = captcha.validate(captchaCode);
    if (!isHuman) {
      addFieldError("captchaCode", "Incorrect code");

4. Configure your Application

Update your application configuration (web.xml) file.

  <servlet-name>BotDetect Captcha</servlet-name>
  <servlet-name>BotDetect Captcha</servlet-name>

Please Note

BotDetect Java Captcha Library v4.0.Beta1 is an in-progress port of BotDetect 4 Captcha, and we need you to guide our efforts towards a polished product. Please let us know if you encounter any bugs, implementation issues, or a usage scenario you would like to discuss.