Package com.atlassian.jira.bc.security.login

Interface CaptchaValidator

All Known Implementing Classes:
CaptchaValidatorImpl
@Internal public interface CaptchaValidator
This service is used to validate a CAPTCHA challenge. It is meant to be used by other plugins such as the Authentication plugin to interface with Jira without having to expose underlying services.
Since:
v10.0

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isRequired(String username)
    Returns whether a CAPTCHA challenge is required.
    boolean
    validate(String captchaId, String captchaChallenge)
    Validates a CAPTCHA challenge.

  • Method Details

    • isRequired

      boolean isRequired(String username)
      Returns whether a CAPTCHA challenge is required.
      Parameters:
      username - The username of the user to check against.
      Returns:
      Whether the CAPTCHA is required.

    • validate

      boolean validate(String captchaId, String captchaChallenge)
      Validates a CAPTCHA challenge.
      Parameters:
      captchaId - The ID of the CAPTCHA challenge to resolve.
      captchaChallenge - The solution for the CAPTCHA challenge.
      Returns:
      Whether the CAPTCHA challenge has been resolved successfully.