索引 (piggy-validate-code 1.0.2 API)

A C D F G H I O R S V _

A

AbstractValidateCodeProcessor<C extends ValidateCode> - cn.jiiiiiin.validate.code.impl中的类: 抽象的图片验证码处理器
AbstractValidateCodeProcessor() - 类的构造器cn.jiiiiiin.validate.code.impl.AbstractValidateCodeProcessor

C

cn.jiiiiiin.validate.code - 程序包 cn.jiiiiiin.validate.code
cn.jiiiiiin.validate.code.config - 程序包 cn.jiiiiiin.validate.code.config
cn.jiiiiiin.validate.code.dict - 程序包 cn.jiiiiiin.validate.code.dict
cn.jiiiiiin.validate.code.entity - 程序包 cn.jiiiiiin.validate.code.entity
cn.jiiiiiin.validate.code.image - 程序包 cn.jiiiiiin.validate.code.image
cn.jiiiiiin.validate.code.impl - 程序包 cn.jiiiiiin.validate.code.impl
cn.jiiiiiin.validate.code.properties - 程序包 cn.jiiiiiin.validate.code.properties
cn.jiiiiiin.validate.code.properties.refresh - 程序包 cn.jiiiiiin.validate.code.properties.refresh
cn.jiiiiiin.validate.code.sms - 程序包 cn.jiiiiiin.validate.code.sms
CONTENT_TYPE_JSON - 接口中的静态变量cn.jiiiiiin.validate.code.dict.ValidateCodeDict
create(ServletWebRequest) - 类中的方法cn.jiiiiiin.validate.code.impl.AbstractValidateCodeProcessor
create(ServletWebRequest) - 接口中的方法cn.jiiiiiin.validate.code.ValidateCodeProcessor: 创建校验码
createCode(HttpServletRequest, HttpServletResponse, String) - 类中的方法cn.jiiiiiin.validate.code.ValidateCodeController: 创建验证码，根据验证码类型不同，调用不同的 ValidateCodeProcessor接口实现 `@GetMapping(SecurityConstants.DEFAULT_VALIDATE_CODE_URL_PREFIX + "/{type:image|sms}")` 这种方式进行验证，如果请求path variable不合法将会报404，故使用下面的方式要优雅一些

D

DEFAULT_PARAMETER_NAME_CODE_IMAGE - 接口中的静态变量cn.jiiiiiin.validate.code.dict.ValidateCodeDict: 验证图片验证码时，http请求中默认的携带图片验证码信息的参数的名称
DEFAULT_PARAMETER_NAME_CODE_SMS - 接口中的静态变量cn.jiiiiiin.validate.code.dict.ValidateCodeDict: 验证短信验证码时，http请求中默认的携带短信验证码信息的参数的名称
DEFAULT_PARAMETER_NAME_DEVICEID - 接口中的静态变量cn.jiiiiiin.validate.code.dict.ValidateCodeDict: 请求验证码(token认证模式)时候需要的客户端标识
DEFAULT_PARAMETER_NAME_EXPIRE_IN - 接口中的静态变量cn.jiiiiiin.validate.code.dict.ValidateCodeDict: 请求验证码接口时候可选参数，用于动态设置验证码超时参数
DEFAULT_PARAMETER_NAME_MOBILE - 接口中的静态变量cn.jiiiiiin.validate.code.dict.ValidateCodeDict: 发送短信验证码或验证短信验证码时，传递手机号的参数的名称
DEFAULT_VALIDATE_CODE_URL_PREFIX - 接口中的静态变量cn.jiiiiiin.validate.code.dict.ValidateCodeDict: 默认的处理验证码的url前缀
DefaultSmsCodeSender - cn.jiiiiiin.validate.code.sms中的类: 默认实现
DefaultSmsCodeSender() - 类的构造器cn.jiiiiiin.validate.code.sms.DefaultSmsCodeSender
DefaultValidateCodeCheckFailureHandler - cn.jiiiiiin.validate.code.impl中的类
DefaultValidateCodeCheckFailureHandler() - 类的构造器cn.jiiiiiin.validate.code.impl.DefaultValidateCodeCheckFailureHandler
doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - 类中的方法cn.jiiiiiin.validate.code.sms.ValidateCodeFilter: 进行验证码的校验通用校验器如：拦截身份认证表单提交请求等配置在当前验证码对象中的`ValidateCodeFilter`配置的请求

F

findValidateCodeProcessor(ValidateCodeType) - 类中的方法cn.jiiiiiin.validate.code.ValidateCodeProcessorHolder
findValidateCodeProcessor(String) - 类中的方法cn.jiiiiiin.validate.code.ValidateCodeProcessorHolder
findValidateRandomStrategy(ValidateRandomStrategy.Type) - 类中的方法cn.jiiiiiin.validate.code.ValidateRandomStrategyHolder
findValidateRandomStrategy(String) - 类中的方法cn.jiiiiiin.validate.code.ValidateRandomStrategyHolder

G

generate(ServletWebRequest) - 类中的方法cn.jiiiiiin.validate.code.image.ImageValidateCodeGenerator
generate(ServletWebRequest) - 类中的方法cn.jiiiiiin.validate.code.sms.SmsValidateCodeGenerator
generate(ServletWebRequest) - 接口中的方法cn.jiiiiiin.validate.code.ValidateCodeGenerator: 生成图形验证码
generatorCode(ImageCode, String) - 类中的方法cn.jiiiiiin.validate.code.image.SplitValidateRandomStrategy
generatorCode(T, String) - 接口中的方法cn.jiiiiiin.validate.code.ValidateRandomStrategy: 1.生成随机验证码，需要根据ValidateCode.length长度来生成，一般在生成验证码的时候需要根据`length`生成，但是可能存在`***`这样的标记，故这里去showCode长度 2.设置验证码`code` 3.设置显示验证码`showCode`[可选]
get(ServletWebRequest, ValidateCodeType) - 类中的方法cn.jiiiiiin.validate.code.impl.RedisValidateCodeRepository
get(ServletWebRequest, ValidateCodeType) - 类中的方法cn.jiiiiiin.validate.code.impl.SessionValidateCodeRepository
get(ServletWebRequest, ValidateCodeType) - 接口中的方法cn.jiiiiiin.validate.code.ValidateCodeRepository: 获取验证码
getParamNameOnValidate() - 枚举中的方法cn.jiiiiiin.validate.code.ValidateCodeType
getValidateCodeType(HttpServletRequest, ValidateCodeProperties, AntPathMatcher) - 类中的静态方法cn.jiiiiiin.validate.code.sms.ValidateCodeFilter: 获取校验码的类型，如果当前请求不需要校验，则返回null

H

handlerException(HttpServletRequest, ValidateCodeException) - 类中的方法cn.jiiiiiin.validate.code.ValidateExceptionAdvice

I

ImageCode - cn.jiiiiiin.validate.code.image中的类
ImageCode(String, Captcha, int) - 类的构造器cn.jiiiiiin.validate.code.image.ImageCode
ImageCodeProperties - cn.jiiiiiin.validate.code.properties中的类: 图形验证码配置类 !
ImageCodeProperties() - 类的构造器cn.jiiiiiin.validate.code.properties.ImageCodeProperties
ImageCodeProperties.ImageType - cn.jiiiiiin.validate.code.properties中的枚举
ImageValidateCodeGenerator - cn.jiiiiiin.validate.code.image中的类: 默认的图形验证码生成器
ImageValidateCodeGenerator(ValidateCodeProperties) - 类的构造器cn.jiiiiiin.validate.code.image.ImageValidateCodeGenerator
imageValidateCodeGenerator() - 类中的方法cn.jiiiiiin.validate.code.ValidateCodeBeanConfig
ImageValidateCodeProcessor - cn.jiiiiiin.validate.code.image中的类: 图片验证码处理器
ImageValidateCodeProcessor() - 类的构造器cn.jiiiiiin.validate.code.image.ImageValidateCodeProcessor
isExpired(LocalDateTime) - 类中的静态方法cn.jiiiiiin.validate.code.entity.ValidateCode: 判断验证码是否过期注：这里不能直接定义为属性，否则会出现`com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException: ` https://www.baeldung.com/jackson-deserialize-json-unknown-properties

O

onChange(ConfigChangeEvent) - 类中的方法cn.jiiiiiin.validate.code.properties.refresh.ValidateCodePropertiesRefreshConfig
onValidateFailure(HttpServletRequest, HttpServletResponse, ValidateCodeException) - 类中的方法cn.jiiiiiin.validate.code.impl.DefaultValidateCodeCheckFailureHandler
onValidateFailure(HttpServletRequest, HttpServletResponse, ValidateCodeException) - 接口中的方法cn.jiiiiiin.validate.code.ValidateCodeCheckFailureHandler

R

RedisValidateCodeRepository - cn.jiiiiiin.validate.code.impl中的类: 基于redis的验证码存取器，避免由于没有session导致无法存取验证码的问题注意需要在请求头或请求参数中携带： String deviceId = request.getHeader("deviceId"); 客户端标识
RedisValidateCodeRepository() - 类的构造器cn.jiiiiiin.validate.code.impl.RedisValidateCodeRepository
remove(ServletWebRequest, ValidateCodeType) - 类中的方法cn.jiiiiiin.validate.code.impl.RedisValidateCodeRepository
remove(ServletWebRequest, ValidateCodeType) - 类中的方法cn.jiiiiiin.validate.code.impl.SessionValidateCodeRepository
remove(ServletWebRequest, ValidateCodeType) - 接口中的方法cn.jiiiiiin.validate.code.ValidateCodeRepository: 移除验证码

S

save(ServletWebRequest, ValidateCode, ValidateCodeType) - 类中的方法cn.jiiiiiin.validate.code.impl.RedisValidateCodeRepository: 存储的时候设置了30分钟的超时时间，如果超过这个实现，数据将会被自动清除
save(ServletWebRequest, ValidateCode, ValidateCodeType) - 类中的方法cn.jiiiiiin.validate.code.impl.SessionValidateCodeRepository
save(ServletWebRequest, ValidateCode, ValidateCodeType) - 接口中的方法cn.jiiiiiin.validate.code.ValidateCodeRepository: 保存验证码
send(ServletWebRequest, ImageCode) - 类中的方法cn.jiiiiiin.validate.code.image.ImageValidateCodeProcessor: 发送图形验证码，将其写到响应中
send(ServletWebRequest, C) - 类中的方法cn.jiiiiiin.validate.code.impl.AbstractValidateCodeProcessor: 发送校验码，由子类实现
send(String, String) - 类中的方法cn.jiiiiiin.validate.code.sms.DefaultSmsCodeSender
send(String, String) - 接口中的方法cn.jiiiiiin.validate.code.sms.SmsCodeSender
send(ServletWebRequest, ValidateCode) - 类中的方法cn.jiiiiiin.validate.code.sms.SmsValidateCodeProcessor
SessionValidateCodeRepository - cn.jiiiiiin.validate.code.impl中的类: 基于session的验证码存取器
SessionValidateCodeRepository() - 类的构造器cn.jiiiiiin.validate.code.impl.SessionValidateCodeRepository
setApplicationContext(ApplicationContext) - 类中的方法cn.jiiiiiin.validate.code.properties.refresh.ValidateCodePropertiesRefreshConfig
SmsCodeProperties - cn.jiiiiiin.validate.code.properties中的类: 短信验证码配置类 !
SmsCodeProperties() - 类的构造器cn.jiiiiiin.validate.code.properties.SmsCodeProperties
SmsCodeSender - cn.jiiiiiin.validate.code.sms中的接口: 发送短信验证码接口
smsCodeSender() - 类中的方法cn.jiiiiiin.validate.code.ValidateCodeBeanConfig
SmsValidateCodeGenerator - cn.jiiiiiin.validate.code.sms中的类: 默认的图形验证码生成器
SmsValidateCodeGenerator() - 类的构造器cn.jiiiiiin.validate.code.sms.SmsValidateCodeGenerator
SmsValidateCodeProcessor - cn.jiiiiiin.validate.code.sms中的类: 短信验证码处理器
SmsValidateCodeProcessor() - 类的构造器cn.jiiiiiin.validate.code.sms.SmsValidateCodeProcessor
SplitValidateRandomStrategy - cn.jiiiiiin.validate.code.image中的类: 随机截取生成器
SplitValidateRandomStrategy() - 类的构造器cn.jiiiiiin.validate.code.image.SplitValidateRandomStrategy

V

validate(ServletWebRequest) - 类中的方法cn.jiiiiiin.validate.code.impl.AbstractValidateCodeProcessor
validate(ServletWebRequest) - 接口中的方法cn.jiiiiiin.validate.code.ValidateCodeProcessor: 校验验证码
ValidateCode - cn.jiiiiiin.validate.code.entity中的类: `Caused by: org.springframework.core.serializer.support.SerializationFailedException: Failed to serialize object using DefaultSerializer; nested exception is java.lang.IllegalArgumentException: DefaultSerializer requires a Serializable payload but received an object of type [cn.jiiiiiin.security.core.validate.code.image.ImageCode]` 开启 spring session -》 redis 之后，我们的 session 将会被存储到 redis 中，但是我们存放到 session 中的图形验证码没有实现`Serializable`接口，导致不可以被序列号到 redis 中，故报出此错误；
ValidateCode(String, int) - 类的构造器cn.jiiiiiin.validate.code.entity.ValidateCode
ValidateCodeBeanConfig - cn.jiiiiiin.validate.code中的类
ValidateCodeBeanConfig() - 类的构造器cn.jiiiiiin.validate.code.ValidateCodeBeanConfig
ValidateCodeCheckFailureHandler - cn.jiiiiiin.validate.code中的接口: 验证码校验失败回调，需要输出响应给调用方，类比认证失败处理器
ValidateCodeConfig - cn.jiiiiiin.validate.code.config中的类
ValidateCodeConfig() - 类的构造器cn.jiiiiiin.validate.code.config.ValidateCodeConfig
ValidateCodeController - cn.jiiiiiin.validate.code中的类: 校验码提供控制器流程： !
ValidateCodeController() - 类的构造器cn.jiiiiiin.validate.code.ValidateCodeController
ValidateCodeDict - cn.jiiiiiin.validate.code.dict中的接口
ValidateCodeException - cn.jiiiiiin.validate.code中的异常错误: `AuthenticationException`是框架身份认证处理异常的基类
ValidateCodeException(String) - 异常错误的构造器cn.jiiiiiin.validate.code.ValidateCodeException
ValidateCodeException(String, Throwable) - 异常错误的构造器cn.jiiiiiin.validate.code.ValidateCodeException
ValidateCodeFilter - cn.jiiiiiin.validate.code.sms中的类: 验证码校验包括图形、短信验证码的校验逻辑被配置到ss框架过滤器链的`org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter`之前执行
ValidateCodeFilter(ValidateCodeProperties, ValidateCodeCheckFailureHandler, ValidateCodeProcessorHolder) - 类的构造器cn.jiiiiiin.validate.code.sms.ValidateCodeFilter
validateCodeFilterFailureHandler() - 类中的方法cn.jiiiiiin.validate.code.ValidateCodeBeanConfig
ValidateCodeGenerator - cn.jiiiiiin.validate.code中的接口
ValidateCodeProcessor - cn.jiiiiiin.validate.code中的接口: 校验码处理器，封装不同校验码的处理逻辑
VALIDATECODEPROCESSOR_CLASSNAME_SEPARATOR - 类中的静态变量cn.jiiiiiin.validate.code.impl.AbstractValidateCodeProcessor
ValidateCodeProcessorHolder - cn.jiiiiiin.validate.code中的类: 校验码处理器管理器
ValidateCodeProcessorHolder() - 类的构造器cn.jiiiiiin.validate.code.ValidateCodeProcessorHolder
validateCodeProperties - 类中的变量cn.jiiiiiin.validate.code.image.ImageValidateCodeGenerator
ValidateCodeProperties - cn.jiiiiiin.validate.code.properties中的类: 框架验证码配置类
ValidateCodeProperties() - 类的构造器cn.jiiiiiin.validate.code.properties.ValidateCodeProperties
ValidateCodePropertiesRefreshConfig - cn.jiiiiiin.validate.code.properties.refresh中的类
ValidateCodePropertiesRefreshConfig() - 类的构造器cn.jiiiiiin.validate.code.properties.refresh.ValidateCodePropertiesRefreshConfig
validateCodeRepository() - 类中的方法cn.jiiiiiin.validate.code.config.ValidateCodeConfig: 如果出现上面错误就是缺少指定的验证码存储器，建议如果应用只部署一个实例，那么就选择基于session的存储方案，简单，`SessionValidateCodeRepository`，如果部署多实例且不想做session黏贴就使用redis存储方案，`RedisValidateCodeRepository`；
ValidateCodeRepository - cn.jiiiiiin.validate.code中的接口: 校验码存取器
ValidateCodeType - cn.jiiiiiin.validate.code中的枚举: 校验码类型
ValidateExceptionAdvice - cn.jiiiiiin.validate.code中的类: 异常处理
ValidateExceptionAdvice() - 类的构造器cn.jiiiiiin.validate.code.ValidateExceptionAdvice
ValidateRandomStrategy<T extends ValidateCode> - cn.jiiiiiin.validate.code中的接口: 验证码随机策略
ValidateRandomStrategy.Type - cn.jiiiiiin.validate.code中的枚举
ValidateRandomStrategyHolder - cn.jiiiiiin.validate.code中的类: 校验码随机生成器
ValidateRandomStrategyHolder() - 类的构造器cn.jiiiiiin.validate.code.ValidateRandomStrategyHolder
valueOf(String) - 枚举中的静态方法cn.jiiiiiin.validate.code.properties.ImageCodeProperties.ImageType: 返回带有指定名称的该类型的枚举常量。
valueOf(String) - 枚举中的静态方法cn.jiiiiiin.validate.code.ValidateCodeType: 返回带有指定名称的该类型的枚举常量。
valueOf(String) - 枚举中的静态方法cn.jiiiiiin.validate.code.ValidateRandomStrategy.Type: 返回带有指定名称的该类型的枚举常量。
values() - 枚举中的静态方法cn.jiiiiiin.validate.code.properties.ImageCodeProperties.ImageType: 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。
values() - 枚举中的静态方法cn.jiiiiiin.validate.code.ValidateCodeType: 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。
values() - 枚举中的静态方法cn.jiiiiiin.validate.code.ValidateRandomStrategy.Type: 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。

_

_createShowCode(String, String) - 类中的方法cn.jiiiiiin.validate.code.image.SplitValidateRandomStrategy

A C D F G H I O R S V _