cloud.tianai.captcha.application

接口 ImageCaptchaApplication

所有已知实现类:

DefaultImageCaptchaApplication, FilterImageCaptchaApplication

public interface ImageCaptchaApplication

方法概要

限定符和类型	方法和说明
ApiResponse<ImageCaptchaVO>	generateCaptcha() 生成滑块验证码
ApiResponse<ImageCaptchaVO>	generateCaptcha(CaptchaImageType captchaImageType) 生成滑块验证码
ApiResponse<ImageCaptchaVO>	generateCaptcha(GenerateParam param) 生成滑块验证码
ApiResponse<ImageCaptchaVO>	generateCaptcha(String type) 生成滑块验证码
ApiResponse<ImageCaptchaVO>	generateCaptcha(String type, CaptchaImageType captchaImageType) 生成验证码
CacheStore	getCacheStore() 获取缓存存储器
CaptchaInterceptor	getCaptchaInterceptor() 获取拦截器
String	getCaptchaTypeById(String id) 查询该ID是属于哪个验证码类型
ImageCaptchaGenerator	getImageCaptchaGenerator() 获取验证码生成器
ImageCaptchaResourceManager	getImageCaptchaResourceManager() 获取验证码资源管理器
ImageCaptchaValidator	getImageCaptchaValidator() 获取验证码验证器
boolean	matching(String id, Float percentage) 已过时。
ApiResponse<?>	matching(String id, ImageCaptchaTrack track) 兼容一下旧版本，新版本建议使用 matching(String, MatchParam)
ApiResponse<?>	matching(String id, MatchParam matchParam) 匹配
void	setCacheStore(CacheStore cacheStore) 设置 缓存存储器
void	setCaptchaInterceptor(CaptchaInterceptor captchaInterceptor) 设置 拦截器
void	setImageCaptchaGenerator(ImageCaptchaGenerator imageCaptchaGenerator) 设置 ImageCaptchaGenerator 验证码生成器
void	setImageCaptchaValidator(ImageCaptchaValidator imageCaptchaValidator) 设置 SliderCaptchaValidator 验证码验证器

方法详细资料

generateCaptcha

ApiResponse<ImageCaptchaVO> generateCaptcha()

生成滑块验证码

返回:

generateCaptcha

ApiResponse<ImageCaptchaVO> generateCaptcha(String type)

生成滑块验证码

参数:

type - type类型

返回:

CaptchaResponse

generateCaptcha

ApiResponse<ImageCaptchaVO> generateCaptcha(CaptchaImageType captchaImageType)

生成滑块验证码

参数:

captchaImageType - 要生成webp还是jpg类型的图片

返回:

CaptchaResponse

generateCaptcha

ApiResponse<ImageCaptchaVO> generateCaptcha(String type,
                                            CaptchaImageType captchaImageType)

生成验证码

参数:

type - type

captchaImageType - CaptchaImageType

返回:

CaptchaResponse

generateCaptcha

ApiResponse<ImageCaptchaVO> generateCaptcha(GenerateParam param)

生成滑块验证码

参数:

param - param

返回:

CaptchaResponse

matching

ApiResponse<?> matching(String id,
                        MatchParam matchParam)

匹配

参数:

id - 验证码的ID

matchParam - 匹配数据，包含鼠标轨迹，设备信息等

返回:

匹配成功返回true， 否则返回false

matching

ApiResponse<?> matching(String id,
                        ImageCaptchaTrack track)

兼容一下旧版本，新版本建议使用 matching(String, MatchParam)

参数:

id - 验证码的ID

track - 轨迹数据

返回:

匹配成功返回true， 否则返回false

matching

@Deprecated
boolean matching(String id,
                              Float percentage)

已过时。

兼容一下旧版本，新版本建议使用 matching(String, MatchParam)

参数:

id - id

percentage - 百分比数据

返回:

boolean

getCaptchaTypeById

String getCaptchaTypeById(String id)

查询该ID是属于哪个验证码类型

参数:

id - id

返回:

String

getImageCaptchaResourceManager

ImageCaptchaResourceManager getImageCaptchaResourceManager()

获取验证码资源管理器

返回:

SliderCaptchaResourceManager

setImageCaptchaValidator

void setImageCaptchaValidator(ImageCaptchaValidator imageCaptchaValidator)

设置 SliderCaptchaValidator 验证码验证器

参数:

imageCaptchaValidator - imageCaptchaValidator

setImageCaptchaGenerator

void setImageCaptchaGenerator(ImageCaptchaGenerator imageCaptchaGenerator)

设置 ImageCaptchaGenerator 验证码生成器

参数:

imageCaptchaGenerator - SliderCaptchaGenerator

getCaptchaInterceptor

CaptchaInterceptor getCaptchaInterceptor()

获取拦截器

返回:

CaptchaInterceptor

setCaptchaInterceptor

void setCaptchaInterceptor(CaptchaInterceptor captchaInterceptor)

设置 拦截器

参数:

captchaInterceptor - captchaInterceptor

setCacheStore

void setCacheStore(CacheStore cacheStore)

设置 缓存存储器

参数:

cacheStore - cacheStore

getImageCaptchaValidator

ImageCaptchaValidator getImageCaptchaValidator()

获取验证码验证器

返回:

SliderCaptchaValidator

getImageCaptchaGenerator

ImageCaptchaGenerator getImageCaptchaGenerator()

获取验证码生成器

返回:

SliderCaptchaTemplate

getCacheStore

CacheStore getCacheStore()

获取缓存存储器

返回:

CacheStore