Package org.ametys.core.captcha

Interface Captcha

All Known Implementing Classes:
AbstractCaptcha, CaptchEtat, JCaptcha, ReCaptchaEnterprise, ReCaptchaV2
public interface Captcha
Interface for Captchas

  • Method Details

    • getLabel

      I18nizableText getLabel()
      Get the Captcha type label
      Returns:
      the label

    • getId

      String getId()
      Get the Captcha type id
      Returns:
      the id

    • getConfigParameters

      Collection<String> getConfigParameters()
      Get the list of config parameters referenced by this captcha implementation
      Returns:
      list of parameters

    • checkAndInvalidateCaptcha

      boolean checkAndInvalidateCaptcha(String key, String value)
      Check if the Captcha is correct
      Parameters:
      key - the key
      value - the value
      Returns:
      true if correct

    • getXSLHelperURL

      String getXSLHelperURL() throws SourceException
      Get the helper xsl file
      Returns:
      the source
      Throws:
      SourceException - if an error occurred while reading the xsl file

    • getLoginSCSSURL

      String getLoginSCSSURL() throws SourceException
      Get the scss file
      Returns:
      the source
      Throws:
      SourceException - if an error occurred while reading the xsl file

    • getLoginFailedBecauseCaptchaFailedLabel

      I18nizableText getLoginFailedBecauseCaptchaFailedLabel()
      Get the label to display when login has failed with this captcha
      Returns:
      the label

    • getLoginFailedBecauseTooManyAttemptLabel

      I18nizableText getLoginFailedBecauseTooManyAttemptLabel()
      Get the label to display when too many attempt have been done
      Returns:
      the label

    • getUsedUrlPatterns

      List<Pattern> getUsedUrlPatterns()
      Get the minimal url patterns used by the captcha implementation. This is necessary to grant those url even when the user is not authentified (in particular to set a catpcha on the login page). Do no put a too wide range (such as ^.*$) since it may introduce security issues.
      Returns:
      The minimal url patterns used by the captcha implementation.

    • requireUserInteraction

      default boolean requireUserInteraction()
      Indicate if the captcha requires user interaction and should be displayed as a form entry
      Returns:
      true if the captcha requires user interaction