• Home
• com.github.fangzhengjin
• common-verification-code-spring-boot-starter
• 0.0.1
• source code
• VerificationValidateProvider.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github.fangzhengjin.common.component.verification.service.VerificationValidateProvider.kt Maven / Gradle / Ivy

package com.github.fangzhengjin.common.component.verification.service

import com.github.fangzhengjin.common.component.verification.VerificationHelper
import com.github.fangzhengjin.common.component.verification.vo.VerificationValidateData
import javax.servlet.http.HttpServletRequest
import javax.servlet.http.HttpServletResponse
import javax.servlet.http.HttpSession

/**
 * @version V1.0
 * @title: VerificationGeneratorProvider
 * @package com.github.fangzhengjin.common.component.verification.service
 * @description: 验证码验证提供者
 * @author fangzhengjin
 * @date 2019/2/26 16:56
 */
interface VerificationValidateProvider {

    /**
     * 验证码校验
     * @param session                           当前请求的session
     * @param request                           当前请求的request
     * @param response                           当前请求的response
     * @param verificationValidateData          验证信息
     * @return 如果选择验证不通过不抛出异常,则返回VerificationStatus验证状态枚举
     */
    fun render(
            request: HttpServletRequest,
            response: HttpServletResponse,
            session: HttpSession,
            verificationValidateData: VerificationValidateData
    ): VerificationStatus

    /**
     * 清理Session中的验证码信息
     */
    fun removeSessionVerificationInfo(session: HttpSession) {
        session.removeAttribute(VerificationHelper.VERIFICATION_CODE_SESSION_KEY)
        session.removeAttribute(VerificationHelper.VERIFICATION_CODE_SESSION_DATE)
        session.removeAttribute(VerificationHelper.VERIFICATION_CODE_SESSION_TYPE)
    }
}