com.github.zhangxd1989.basetool.captcha.ICaptcha Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of basetool Show documentation

Java Common Utils

There is a newer version: 1.0.16

package com.github.zhangxd1989.basetool.captcha;

import java.io.OutputStream;
import java.io.Serializable;

/**
 * 验证码接口，提供验证码对象接口定义
 *
 * @author sheldon
 */
public interface ICaptcha extends Serializable {

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

    /**
     * 获取验证码的文字内容
     *
     * @return 验证码文字内容
     */
    String getCode();

    /**
     * 验证验证码是否正确，建议忽略大小写
     *
     * @param userInputCode 用户输入的验证码
     * @return 是否与生成的一直
     */
    boolean verify(String userInputCode);

    /**
     * 将验证码写出到目标流中
     *
     * @param out 目标流
     */
    void write(OutputStream out);
}