com.xingyuv.captcha.service.CaptchaService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of captcha-plus Show documentation

captcha-plus.jar

The newest version!

/*
 *Copyright © 2018 anji-plus
 *安吉加加信息技术有限公司
 *http://www.anji-plus.com
 *All rights reserved.
 */
package com.xingyuv.captcha.service;

import com.xingyuv.captcha.model.common.ResponseModel;
import com.xingyuv.captcha.model.vo.CaptchaVO;

import java.util.Properties;

/**
 * 验证码服务接口
 *
 * @author [email protected]
 */
public interface CaptchaService {
    /**
     * 配置初始化
     * @param config config
     */
    void init(Properties config);

    /**
     * 获取验证码
     *
     * @param captchaVO captchaVO
     * @return ResponseModel
     */
    ResponseModel get(CaptchaVO captchaVO);

    /**
     * 核对验证码(前端)
     *
     * @param captchaVO captchaVO
     * @return ResponseModel
     */
    ResponseModel check(CaptchaVO captchaVO);

    /**
     * 二次校验验证码(后端)
     *
     * @param captchaVO captchaVO
     * @return ResponseModel
     */
    ResponseModel verification(CaptchaVO captchaVO);

    /***
     * 验证码类型
     * 通过java SPI机制，接入方可自定义实现类，实现新的验证类型
     * @return captchaType
     */
    String captchaType();

    /**
     * 历史资源清除(过期的图片文件，生成的临时图片...)
     *
     * @param config 配置项 控制资源清理的粒度
     */
    void destroy(Properties config);
}