cn.dev33.satoken.id

类 SaIdTemplate

java.lang.Object

cn.dev33.satoken.id.SaIdTemplate

public class SaIdTemplate
extends java.lang.Object

Sa-Token-Id 身份凭证模块

身份凭证的获取与校验，可用于微服务内部调用鉴权

作者:

kong

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	ID_TOKEN 在 Request 上储存 Id-Token 时建议使用的key

构造器概要

构造器

构造器和说明
SaIdTemplate()

方法概要

限定符和类型	方法和说明
void	checkCurrentRequestToken() 校验当前Request提供的Id-Token是否有效 (如果无效则抛出异常)
void	checkToken(java.lang.String token) 校验一个Id-Token是否有效 (如果无效则抛出异常)
java.lang.String	createToken() 创建一个Id-Token
java.lang.String	getPastTokenNh() 获取Past-Id-Token，不做任何处理
java.lang.String	getToken() 获取当前Id-Token, 如果不存在，则立即创建并返回
java.lang.String	getTokenNh() 获取Id-Token，不做任何处理
long	getTokenTimeout() 获取Id-Token的剩余有效期 (单位：秒)
boolean	isValid(java.lang.String token) 判断一个Id-Token是否有效
java.lang.String	refreshToken() 刷新一次Id-Token (注意集群环境中不要多个服务重复调用)
void	savePastToken(java.lang.String token, long timeout) 保存Past-Id-Token
void	saveToken(java.lang.String token) 保存Id-Token
java.lang.String	splicingPastTokenSaveKey() 拼接key：次级 Id-Token 的存储 key
java.lang.String	splicingTokenSaveKey() 拼接key：Id-Token 的存储 key

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

ID_TOKEN

public static final java.lang.String ID_TOKEN

在 Request 上储存 Id-Token 时建议使用的key

另请参阅:

常量字段值

构造器详细资料

SaIdTemplate

public SaIdTemplate()

方法详细资料

getToken

public java.lang.String getToken()

获取当前Id-Token, 如果不存在，则立即创建并返回

返回:

当前token

isValid

public boolean isValid(java.lang.String token)

判断一个Id-Token是否有效

参数:

token - 要验证的token

返回:

这个token是否有效

checkToken

public void checkToken(java.lang.String token)

校验一个Id-Token是否有效 (如果无效则抛出异常)

参数:

token - 要验证的token

checkCurrentRequestToken

public void checkCurrentRequestToken()

校验当前Request提供的Id-Token是否有效 (如果无效则抛出异常)

refreshToken

public java.lang.String refreshToken()

刷新一次Id-Token (注意集群环境中不要多个服务重复调用)

返回:

新Token

saveToken

public void saveToken(java.lang.String token)

保存Id-Token

参数:

token - token

savePastToken

public void savePastToken(java.lang.String token,
                          long timeout)

保存Past-Id-Token

参数:

token - token

timeout - 有效期（单位：秒）

getTokenNh

public java.lang.String getTokenNh()

获取Id-Token，不做任何处理

返回:

token

getPastTokenNh

public java.lang.String getPastTokenNh()

获取Past-Id-Token，不做任何处理

返回:

token

getTokenTimeout

public long getTokenTimeout()

获取Id-Token的剩余有效期 (单位：秒)

返回:

token

createToken

public java.lang.String createToken()

创建一个Id-Token

返回:

Token

splicingTokenSaveKey

public java.lang.String splicingTokenSaveKey()

拼接key：Id-Token 的存储 key

返回:

key

splicingPastTokenSaveKey

public java.lang.String splicingPastTokenSaveKey()

拼接key：次级 Id-Token 的存储 key

返回:

key