public class StpLogic
extends java.lang.Object
(stp = sa-token-permission 的缩写 )
| 限定符和类型 | 字段和说明 |
|---|---|
java.lang.String |
loginKey
持久化的key前缀,多账号体系时以此值区分,比如:login、user、admin
|
| 构造器和说明 |
|---|
StpLogic(java.lang.String loginKey)
初始化StpLogic, 并制定loginKey
|
| 限定符和类型 | 方法和说明 |
|---|---|
void |
checkLogin()
检验当前会话是否已经登录,如未登录,则抛出异常
|
void |
checkPermission(java.lang.Object pcode)
当前账号是否含有指定权限 , 没有就抛出异常
|
void |
checkPermissionAnd(java.lang.Object... pcodeArray)
当前账号是否含有指定权限 , 【指定多个,必须全都有】
|
void |
checkPermissionOr(java.lang.Object... pcodeArray)
当前账号是否含有指定权限 , 【指定多个,有一个就可以了】
|
java.lang.String |
getKeyLoginId(java.lang.Object loginId)
获取key: id 持久化
|
java.lang.String |
getKeySession(java.lang.Object loginId)
获取key: session 持久化
|
java.lang.String |
getKeyTokenName()
获取key:客户端 tokenName
|
java.lang.String |
getKeyTokenValue(java.lang.String tokenValue)
获取key: tokenValue 持久化
|
java.lang.Object |
getLoginId()
获取当前会话登录id, 如果未登录,则抛出异常
|
<T> T |
getLoginId(T defaultValue)
获取当前会话登录id, 如果未登录,则返回默认值
|
int |
getLoginIdAsInt()
获取当前会话登录id, 并转换为int
|
long |
getLoginIdAsLong()
获取当前会话登录id, 并转换为long
|
java.lang.String |
getLoginIdAsString()
获取当前会话登录id, 并转换为String
|
java.lang.Object |
getLoginIdByToken(java.lang.String tokenValue)
获取指定token对应的登录id,如果未登录,则返回 null
|
java.lang.Object |
getLoginIdDefaultNull()
获取当前会话登录id, 如果未登录,则返回null
|
SaSession |
getSession()
获取当前会话的session
|
SaSession |
getSessionByLoginId(java.lang.Object loginId)
获取指定loginId的session
|
SaSession |
getSessionByLoginId(java.lang.Object loginId,
boolean isCreate)
获取指定loginId的session, 如果没有,isCreate=是否新建并返回
|
protected SaSession |
getSessionBySessionId(java.lang.String sessionId,
boolean isCreate)
获取指定key的session, 如果没有,isCreate=是否新建并返回
|
java.util.Map<java.lang.String,java.lang.String> |
getTokenInfo()
获取当前会话的token信息:tokenName与tokenValue
|
java.lang.String |
getTokenName()
返回token名称
|
java.lang.String |
getTokenValue()
获取当前tokenValue
|
java.lang.String |
getTokenValueByLoginId(java.lang.Object loginId)
获取指定id的tokenValue
|
boolean |
hasPermission(java.lang.Object pcode)
当前会话是否含有指定权限
|
boolean |
hasPermission(java.lang.Object loginId,
java.lang.Object pcode)
指定loginId是否含有指定权限
|
boolean |
isLogin()
获取当前会话是否已经登录
|
void |
kickoutByLoginId(java.lang.Object loginId)
指定loginId的会话注销登录(踢人下线)
|
void |
logout()
当前会话注销登录
|
void |
logoutByLoginId(java.lang.Object loginId)
指定loginId的会话注销登录(清退下线)
|
java.lang.String |
randomTokenValue(java.lang.Object loginId)
随机生成一个tokenValue
|
void |
setLoginId(java.lang.Object loginId)
在当前会话上登录id
|
public StpLogic(java.lang.String loginKey)
loginKey - .public java.lang.String getTokenName()
public java.lang.String randomTokenValue(java.lang.Object loginId)
loginId - loginIdpublic java.lang.String getTokenValue()
public java.lang.String getTokenValueByLoginId(java.lang.Object loginId)
loginId - .public java.util.Map<java.lang.String,java.lang.String> getTokenInfo()
public void setLoginId(java.lang.Object loginId)
loginId - 登录id ,建议的类型:(long | int | String)public void logout()
public void logoutByLoginId(java.lang.Object loginId)
loginId - 账号idpublic void kickoutByLoginId(java.lang.Object loginId)
loginId - 账号idpublic boolean isLogin()
public void checkLogin()
public java.lang.Object getLoginId()
public <T> T getLoginId(T defaultValue)
defaultValue - .public java.lang.Object getLoginIdDefaultNull()
public java.lang.String getLoginIdAsString()
public int getLoginIdAsInt()
public long getLoginIdAsLong()
public java.lang.Object getLoginIdByToken(java.lang.String tokenValue)
protected SaSession getSessionBySessionId(java.lang.String sessionId, boolean isCreate)
sessionId - .isCreate - .public SaSession getSessionByLoginId(java.lang.Object loginId, boolean isCreate)
loginId - 登录idisCreate - 是否新建public SaSession getSessionByLoginId(java.lang.Object loginId)
loginId - .public SaSession getSession()
public boolean hasPermission(java.lang.Object loginId,
java.lang.Object pcode)
loginId - .pcode - .public boolean hasPermission(java.lang.Object pcode)
pcode - .public void checkPermission(java.lang.Object pcode)
pcode - .public void checkPermissionAnd(java.lang.Object... pcodeArray)
pcodeArray - .public void checkPermissionOr(java.lang.Object... pcodeArray)
pcodeArray - .public java.lang.String getKeyTokenName()
public java.lang.String getKeyTokenValue(java.lang.String tokenValue)
tokenValue - .public java.lang.String getKeyLoginId(java.lang.Object loginId)
loginId - .public java.lang.String getKeySession(java.lang.Object loginId)
loginId - .Copyright © 2020. All Rights Reserved.