cn.zhxu.toys.captcha

接口 CaptchaManager

所有已知子接口:

ImageCaptchaManager, MsgCaptchaManager

所有已知实现类:

BaseCaptchaManager, DefaultImageCaptchaManager, DefaultMsgCaptchaManager

public interface CaptchaManager

验证码管理器

作者:

Troy.Zhou

嵌套类概要

嵌套类

限定符和类型	接口和说明
static class	CaptchaManager.VerifyResult

方法概要

限定符和类型	方法和说明
default void	assertCode(String captchaId, String code) 校验验证码，校验失败时抛出异常
void	genAndRender(String captchaId, CaptchaAttrs attrs) 生成并渲染验证码
CaptchaManager.VerifyResult	verify(String captchaId, String code) 校验验证码

方法详细资料

genAndRender

void genAndRender(String captchaId,
                  CaptchaAttrs attrs)
           throws CaptchaException

生成并渲染验证码

参数:

captchaId - 验证码标识（发短信验证时，是手机号，图形验证码时，是请求ID）

attrs - 附加属性

抛出:

CaptchaException - 异常

verify

CaptchaManager.VerifyResult verify(String captchaId,
                                   String code)

校验验证码

参数:

captchaId - 验证码标识（发短信验证时，是手机号，图形验证码时，是请求ID）

code - 验证码

返回:

校验结果

assertCode

default void assertCode(String captchaId,
                        String code)
                 throws CaptchaException

校验验证码，校验失败时抛出异常

参数:

captchaId - 验证码标识（发短信验证时，是手机号，图形验证码时，是请求ID）

code - 验证码

抛出:

CaptchaException - 建议失败异常

从以下版本开始:

v0.0.2