com.baomidou.kisso.captcha.ICaptcha Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kisso Show documentation

An enhanced toolkit of SSO to simplify development.

There is a newer version: 3.9.1

/**
 * Copyright (c) 2017-2022, hubin ([email protected]).
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 

 * http://www.apache.org/licenses/LICENSE-2.0
 * 

 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.baomidou.kisso.captcha;

import java.io.IOException;
import java.io.OutputStream;
import java.io.Serializable;

import javax.servlet.http.HttpServletRequest;

/**
 * 

 * 图片验证码接口
 * 
 *
 * @author hubin
 * @since 2018-08-11
 */
public interface ICaptcha extends Serializable {

    /**
     * 
     * 生成图片验证码
     * 
     *
     * @param request 当前请求
     * @param out     输出流
     * @param ticket  验证码票据
     * @return String 验证码内容
     */
    void generate(HttpServletRequest request, OutputStream out, String ticket) throws IOException;

    /**
     * 
     * 判断验证码是否正确
     * 
     *
     * @param request 当前请求
     * @param ticket  验证码票据
     * @param captcha 验证码内容
     * @return boolean true 正确，false 错误
     */
    boolean verification(HttpServletRequest request, String ticket, String captcha);

}