com.biz.web.token.Token Maven / Gradle / Ivy

Go to download

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

BizX 是一个灵活而高效的业务开发框架, 其中也有很多为业务开发所需要的工具类的提供。

The newest version!

package com.biz.web.token;

import com.biz.web.account.BizAccount;

import javax.servlet.http.HttpServletResponse;
import java.io.Serializable;

/**
 * token
 *
 * @author francis
 * @since 1.0.1
 **/
public interface Token extends Serializable {

    /**
     * 获取当前用户的token
     *
     * @return
     */
    String getCurrentToken();

    /**
     * 获取当前用户信息
     *
     * @return
     */
    BizAccount getCurrentUser();

    /**
     * 设置当前用户信息
     *
     * @param bizAccount
     */
    void setCurrentUser(BizAccount bizAccount);

    /**
     * 销毁
     */
    void destroy();

    /**
     * 判断是否设置当前用户信息
     *
     * @return
     */
    boolean isSetAccount();

    /**
     * 每次调用接口初始化当前用户信息
     *
     * @param token
     */
    void initAccount(String token);

    /**
     * 设置 HttpServletResponse
     *
     * @param response 响应对象
     */
    void setHttpServletResponse(HttpServletResponse response);

    /**
     * token 是否到期
     *
     * @return true 到期 false 未到期
     */
    boolean checkTokenIsExpire();

}