DefaultImageCaptchaApplication (tianai-captcha 1.5.3 API)

java.lang.Object
- cloud.tianai.captcha.application.DefaultImageCaptchaApplication

所有已实现的接口:: ImageCaptchaApplication

public class DefaultImageCaptchaApplication
extends Object
implements ImageCaptchaApplication

字段概要

字段
限定符和类型字段和说明

static String ID_SPLIT

字段
限定符和类型	字段和说明
`static String`	`ID_SPLIT`

构造器概要

构造器
构造器和说明
`DefaultImageCaptchaApplication(ImageCaptchaGenerator captchaGenerator, ImageCaptchaValidator imageCaptchaValidator, CacheStore cacheStore, ImageCaptchaProperties prop, CaptchaInterceptor captchaInterceptor)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected void`	`cacheVerification(String id, String type, AnyMap validData)` 缓存验证码
`ApiResponse<ImageCaptchaVO>`	`convertToCaptchaResponse(ImageCaptchaInfo imageCaptchaInfo)`
`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)` 生成验证码
`protected String`	`generatorId(ImageCaptchaInfo imageCaptchaInfo)`
`CacheStore`	`getCacheStore()` 获取缓存存储器
`CaptchaInterceptor`	`getCaptchaInterceptor()` 获取拦截器
`String`	`getCaptchaTypeById(String id)` 查询该ID是属于哪个验证码类型
`ImageCaptchaGenerator`	`getImageCaptchaGenerator()` 获取验证码生成器
`ImageCaptchaResourceManager`	`getImageCaptchaResourceManager()` 获取验证码资源管理器
`ImageCaptchaValidator`	`getImageCaptchaValidator()` 获取验证码验证器
`protected String`	`getKey(String id)`
`protected AnyMap`	`getVerification(String id)` 通过缓存获取百分比
`boolean`	`matching(String id, Float percentage)` 兼容一下旧版本，新版本建议使用 `ImageCaptchaApplication.matching(String, MatchParam)`
`ApiResponse<?>`	`matching(String id, ImageCaptchaTrack track)` 兼容一下旧版本，新版本建议使用 `ImageCaptchaApplication.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 验证码验证器

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - ID_SPLIT
```
public static final String ID_SPLIT
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - DefaultImageCaptchaApplication
```
public DefaultImageCaptchaApplication(ImageCaptchaGenerator captchaGenerator,
                                      ImageCaptchaValidator imageCaptchaValidator,
                                      CacheStore cacheStore,
                                      ImageCaptchaProperties prop,
                                      CaptchaInterceptor captchaInterceptor)
```
- 方法详细资料
  - generateCaptcha
```
public ApiResponse<ImageCaptchaVO> generateCaptcha()
```
    从接口复制的说明: ImageCaptchaApplication
    
    生成滑块验证码
    
    指定者:
    
    generateCaptcha 在接口中 ImageCaptchaApplication
    
    返回:
  - generateCaptcha
```
public ApiResponse<ImageCaptchaVO> generateCaptcha(String type)
```
    从接口复制的说明: ImageCaptchaApplication
    
    生成滑块验证码
    
    指定者:
    
    generateCaptcha 在接口中 ImageCaptchaApplication
    
    参数:
    
    type - type类型
    
    返回:
    
    CaptchaResponse
  - generateCaptcha
```
public ApiResponse<ImageCaptchaVO> generateCaptcha(GenerateParam param)
```
    从接口复制的说明: ImageCaptchaApplication
    
    生成滑块验证码
    
    指定者:
    
    generateCaptcha 在接口中 ImageCaptchaApplication
    
    参数:
    
    param - param
    
    返回:
    
    CaptchaResponse
  - generateCaptcha
```
public ApiResponse<ImageCaptchaVO> generateCaptcha(CaptchaImageType captchaImageType)
```
    从接口复制的说明: ImageCaptchaApplication
    
    生成滑块验证码
    
    指定者:
    
    generateCaptcha 在接口中 ImageCaptchaApplication
    
    参数:
    
    captchaImageType - 要生成webp还是jpg类型的图片
    
    返回:
    
    CaptchaResponse
  - generateCaptcha
```
public ApiResponse<ImageCaptchaVO> generateCaptcha(String type,
                                                   CaptchaImageType captchaImageType)
```
    从接口复制的说明: ImageCaptchaApplication
    
    生成验证码
    
    指定者:
    
    generateCaptcha 在接口中 ImageCaptchaApplication
    
    参数:
    
    type - type
    
    captchaImageType - CaptchaImageType
    
    返回:
    
    CaptchaResponse
  - convertToCaptchaResponse
```
public ApiResponse<ImageCaptchaVO> convertToCaptchaResponse(ImageCaptchaInfo imageCaptchaInfo)
```
  - matching
```
public ApiResponse<?> matching(String id,
                               MatchParam matchParam)
```
    从接口复制的说明: ImageCaptchaApplication
    
    匹配
    
    指定者:
    
    matching 在接口中 ImageCaptchaApplication
    
    参数:
    
    id - 验证码的ID
    
    matchParam - 匹配数据，包含鼠标轨迹，设备信息等
    
    返回:
    
    匹配成功返回true，否则返回false
  - matching
```
public ApiResponse<?> matching(String id,
                               ImageCaptchaTrack track)
```
    从接口复制的说明: ImageCaptchaApplication
    
    兼容一下旧版本，新版本建议使用 ImageCaptchaApplication.matching(String, MatchParam)
    
    指定者:
    
    matching 在接口中 ImageCaptchaApplication
    
    参数:
    
    id - 验证码的ID
    
    track - 轨迹数据
    
    返回:
    
    匹配成功返回true，否则返回false
  - matching
```
public boolean matching(String id,
                        Float percentage)
```
    从接口复制的说明: ImageCaptchaApplication
    
    兼容一下旧版本，新版本建议使用 ImageCaptchaApplication.matching(String, MatchParam)
    
    指定者:
    
    matching 在接口中 ImageCaptchaApplication
    
    参数:
    
    id - id
    
    percentage - 百分比数据
    
    返回:
    
    boolean
  - getCaptchaTypeById
```
public String getCaptchaTypeById(String id)
```
    从接口复制的说明: ImageCaptchaApplication
    
    查询该ID是属于哪个验证码类型
    
    指定者:
    
    getCaptchaTypeById 在接口中 ImageCaptchaApplication
    
    参数:
    
    id - id
    
    返回:
    
    String
  - generatorId
```
protected String generatorId(ImageCaptchaInfo imageCaptchaInfo)
```
  - getVerification
```
protected AnyMap getVerification(String id)
```
    通过缓存获取百分比
    
    参数:
    
    id - 验证码ID
    
    返回:
    
    AnyMap
  - cacheVerification
```
protected void cacheVerification(String id,
                                 String type,
                                 AnyMap validData)
```
    缓存验证码
    
    参数:
    
    id - id
    
    type -
    
    validData - validData
  - getKey
```
protected String getKey(String id)
```
  - getImageCaptchaResourceManager
```
public ImageCaptchaResourceManager getImageCaptchaResourceManager()
```
    从接口复制的说明: ImageCaptchaApplication
    
    获取验证码资源管理器
    
    指定者:
    
    getImageCaptchaResourceManager 在接口中 ImageCaptchaApplication
    
    返回:
    
    SliderCaptchaResourceManager
  - setImageCaptchaValidator
```
public void setImageCaptchaValidator(ImageCaptchaValidator imageCaptchaValidator)
```
    从接口复制的说明: ImageCaptchaApplication
    
    设置 SliderCaptchaValidator 验证码验证器
    
    指定者:
    
    setImageCaptchaValidator 在接口中 ImageCaptchaApplication
    
    参数:
    
    imageCaptchaValidator - imageCaptchaValidator
  - setImageCaptchaGenerator
```
public void setImageCaptchaGenerator(ImageCaptchaGenerator imageCaptchaGenerator)
```
    从接口复制的说明: ImageCaptchaApplication
    
    设置 ImageCaptchaGenerator 验证码生成器
    
    指定者:
    
    setImageCaptchaGenerator 在接口中 ImageCaptchaApplication
    
    参数:
    
    imageCaptchaGenerator - SliderCaptchaGenerator
  - getCaptchaInterceptor
```
public CaptchaInterceptor getCaptchaInterceptor()
```
    从接口复制的说明: ImageCaptchaApplication
    
    获取拦截器
    
    指定者:
    
    getCaptchaInterceptor 在接口中 ImageCaptchaApplication
    
    返回:
    
    CaptchaInterceptor
  - setCaptchaInterceptor
```
public void setCaptchaInterceptor(CaptchaInterceptor captchaInterceptor)
```
    从接口复制的说明: ImageCaptchaApplication
    
    设置拦截器
    
    指定者:
    
    setCaptchaInterceptor 在接口中 ImageCaptchaApplication
    
    参数:
    
    captchaInterceptor - captchaInterceptor
  - setCacheStore
```
public void setCacheStore(CacheStore cacheStore)
```
    从接口复制的说明: ImageCaptchaApplication
    
    设置缓存存储器
    
    指定者:
    
    setCacheStore 在接口中 ImageCaptchaApplication
    
    参数:
    
    cacheStore - cacheStore
  - getImageCaptchaValidator
```
public ImageCaptchaValidator getImageCaptchaValidator()
```
    从接口复制的说明: ImageCaptchaApplication
    
    获取验证码验证器
    
    指定者:
    
    getImageCaptchaValidator 在接口中 ImageCaptchaApplication
    
    返回:
    
    SliderCaptchaValidator
  - getImageCaptchaGenerator
```
public ImageCaptchaGenerator getImageCaptchaGenerator()
```
    从接口复制的说明: ImageCaptchaApplication
    
    获取验证码生成器
    
    指定者:
    
    getImageCaptchaGenerator 在接口中 ImageCaptchaApplication
    
    返回:
    
    SliderCaptchaTemplate
  - getCacheStore
```
public CacheStore getCacheStore()
```
    从接口复制的说明: ImageCaptchaApplication
    
    获取缓存存储器
    
    指定者:
    
    getCacheStore 在接口中 ImageCaptchaApplication
    
    返回:
    
    CacheStore

类 DefaultImageCaptchaApplication

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

ID_SPLIT

构造器详细资料

DefaultImageCaptchaApplication

方法详细资料

generateCaptcha

generateCaptcha

generateCaptcha

generateCaptcha

generateCaptcha

convertToCaptchaResponse

matching

matching

matching

getCaptchaTypeById

generatorId

getVerification

cacheVerification

getKey

getImageCaptchaResourceManager

setImageCaptchaValidator

setImageCaptchaGenerator

getCaptchaInterceptor

setCaptchaInterceptor

setCacheStore

getImageCaptchaValidator

getImageCaptchaGenerator

getCacheStore