Package org.miaixz.bus.extra.captcha

Interface CaptchaProvider

All Superinterfaces:
org.miaixz.bus.core.Provider
All Known Implementing Classes:
AbstractProvider, CircleProvider, ClickWordProvider, GifProvider, LineProvider, PuzzleProvider, ShearProvider
public interface CaptchaProvider extends org.miaixz.bus.core.Provider
验证码接口，提供验证码对象接口定义
Since:
Java 17+
Author:
Kimi Liu

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    create()
    创建验证码，实现类需同时生成随机验证码字符串和验证码图片
    String
    get()
    获取验证码的文字内容
    default Object
    type()
     
    boolean
    verify(String userInputCode)
    验证验证码是否正确，建议忽略大小写
    void
    write(OutputStream out)
    将验证码写出到目标流中

  • Method Details

    • create

      void create()
      创建验证码，实现类需同时生成随机验证码字符串和验证码图片

    • get

      String get()
      获取验证码的文字内容
      Returns:
      验证码文字内容

    • verify

      boolean verify(String userInputCode)
      验证验证码是否正确，建议忽略大小写
      Parameters:
      userInputCode - 用户输入的验证码
      Returns:
      是否与生成的一直

    • write

      void write(OutputStream out)
      将验证码写出到目标流中
      Parameters:
      out - 目标流

    • type

      default Object type()
      Specified by:
      type in interface org.miaixz.bus.core.Provider