类 SaSameTemplate
java.lang.Object
cn.dev33.satoken.same.SaSameTemplate
Sa Same-Token 同源系统身份认证模块 - 模板方法类
解决同源系统互相调用时的身份认证校验, 例如:微服务网关请求转发鉴权、微服务RPC调用鉴权
- 从以下版本开始:
- 2022-10-24
- 作者:
- kong
-
字段概要
字段 -
构造器概要
构造器 -
方法概要
修饰符和类型方法说明void校验当前 Request 上下文提供的 Same-Token 是否有效 (如果无效则抛出异常)voidcheckToken(String token) 校验一个 Same-Token 是否有效 (如果无效则抛出异常)创建一个 Same-Token获取 Past-Same-Token,不做任何处理getToken()获取当前 Same-Token, 如果不存在,则立即创建并返回获取 Same-Token,不做任何处理long获取 Same-Token 的剩余有效期 (单位:秒)boolean判断一个 Same-Token 是否有效刷新一次 Same-Token (注意集群环境中不要多个服务重复调用)voidsavePastToken(String token, long timeout) 保存 Past-Same-Tokenvoid保存 Same-Token拼接key:次级 Same-Token 的存储 key拼接key:Same-Token 的存储 key
-
字段详细资料
-
SAME_TOKEN
提交 Same-Token 时,建议使用的参数名称- 另请参阅:
-
-
构造器详细资料
-
SaSameTemplate
public SaSameTemplate()
-
-
方法详细资料
-
getToken
获取当前 Same-Token, 如果不存在,则立即创建并返回- 返回:
- /
-
isValid
判断一个 Same-Token 是否有效- 参数:
token- /- 返回:
- /
-
checkToken
校验一个 Same-Token 是否有效 (如果无效则抛出异常)- 参数:
token- /
-
checkCurrentRequestToken
public void checkCurrentRequestToken()校验当前 Request 上下文提供的 Same-Token 是否有效 (如果无效则抛出异常) -
refreshToken
刷新一次 Same-Token (注意集群环境中不要多个服务重复调用)- 返回:
- 刷新后产生的新 Same-Token
-
saveToken
保存 Same-Token- 参数:
token- /
-
savePastToken
保存 Past-Same-Token- 参数:
token- tokentimeout- 有效期(单位:秒)
-
getTokenNh
获取 Same-Token,不做任何处理- 返回:
- /
-
getPastTokenNh
获取 Past-Same-Token,不做任何处理- 返回:
- /
-
getTokenTimeout
public long getTokenTimeout()获取 Same-Token 的剩余有效期 (单位:秒)- 返回:
- /
-
createToken
创建一个 Same-Token- 返回:
- Token
-
splicingTokenSaveKey
拼接key:Same-Token 的存储 key- 返回:
- key
-
splicingPastTokenSaveKey
拼接key:次级 Same-Token 的存储 key- 返回:
- key
-