cn.dev33.satoken.stp

类 StpLogic

java.lang.Object

cn.dev33.satoken.stp.StpLogic

public class StpLogic
extends java.lang.Object

sa-token 权限验证，逻辑 实现类

(stp = sa-token-permission 的缩写 )

字段概要

字段

限定符和类型	字段和说明
java.lang.String	login_key

构造器概要

构造器

构造器和说明
StpLogic(java.lang.String login_key)

方法概要

限定符和类型	方法和说明
void	checkLogin() 检验当前会话是否已经登录，如未登录，则抛出异常
void	checkPermission(java.lang.Object pcode) 当前账号是否含有指定权限 ， 没有就抛出异常
void	checkPermissionAnd(java.lang.Object... pcodeArray) 当前账号是否含有指定权限 ， 【指定多个，必须全都有】
void	checkPermissionOr(java.lang.Object... pcodeArray) 当前账号是否含有指定权限 ， 【指定多个，有一个就可以了】
java.lang.String	getKey_LoginId(java.lang.Object login_id) 获取key： id 持久化
java.lang.String	getKey_session(java.lang.Object login_id) 获取key： session 持久化
java.lang.String	getKey_tokenName() 获取key：客户端 tokenName
java.lang.String	getKey_TokenValue(java.lang.String tokenValue) 获取key： tokenValue 持久化
int	getLoginId_asInt() 获取当前会话登录id, 并转换为int
long	getLoginId_asLong() 获取当前会话登录id, 并转换为long
java.lang.String	getLoginId_asString() 获取当前会话登录id, 并转换为String
java.lang.Object	getLoginId_defaultNull() 获取当前会话登录id, 如果未登录，则返回null
java.lang.Object	getLoginId() 获取当前会话登录id, 如果未登录，则抛出异常
<T> T	getLoginId(T default_value) 获取当前会话登录id, 如果未登录，则返回默认值
java.lang.Object	getLoginIdByToken(java.lang.String tokenValue) 获取指定token对应的登录id，如果未登录，则返回 null
SaSession	getSession() 获取当前会话的session
SaSession	getSessionByLoginId(java.lang.Object login_id) 获取指定login_id的session
protected SaSession	getSessionBySessionId(java.lang.String sessionId, boolean is_create) 获取指定key的session, 如果没有，is_create=是否新建并返回
java.util.Map<java.lang.String,java.lang.String>	getTokenInfo() 获取当前会话的token信息：tokenName与tokenValue
java.lang.String	getTokenValue() 获取当前tokenValue
java.lang.String	getTokenValueByLoginId(java.lang.Object login_id) 获取指定id的tokenValue
boolean	hasPermission(java.lang.Object pcode) 当前会话是否含有指定权限
boolean	hasPermission(java.lang.Object login_id, java.lang.Object pcode) 指定login_id是否含有指定权限
boolean	isLogin() 获取当前会话是否已经登录
void	logout() 当前会话注销登录
void	logoutByLoginId(java.lang.Object login_id) 指定login_id的会话注销登录（踢人下线）
java.lang.String	randomTokenValue() 随机生成一个tokenValue
void	setLoginId(java.lang.Object login_id) 在当前会话上登录id

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

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

字段详细资料

login_key

public java.lang.String login_key

构造器详细资料

StpLogic

public StpLogic(java.lang.String login_key)

方法详细资料

randomTokenValue

public java.lang.String randomTokenValue()

随机生成一个tokenValue

返回:

生成的tokenValue

getTokenValue

public java.lang.String getTokenValue()

获取当前tokenValue

返回:

当前tokenValue

getTokenValueByLoginId

public java.lang.String getTokenValueByLoginId(java.lang.Object login_id)

获取指定id的tokenValue

参数:

login_id -

返回:

getTokenInfo

public java.util.Map<java.lang.String,java.lang.String> getTokenInfo()

获取当前会话的token信息：tokenName与tokenValue

返回:

一个Map对象

setLoginId

public void setLoginId(java.lang.Object login_id)

在当前会话上登录id

参数:

login_id - 登录id ，建议的类型：（long | int | String）

logout

public void logout()

当前会话注销登录

logoutByLoginId

public void logoutByLoginId(java.lang.Object login_id)

指定login_id的会话注销登录（踢人下线）

参数:

login_id - 账号id

isLogin

public boolean isLogin()

获取当前会话是否已经登录

返回:

是否已登录

checkLogin

public void checkLogin()

检验当前会话是否已经登录，如未登录，则抛出异常

getLoginId

public java.lang.Object getLoginId()

获取当前会话登录id, 如果未登录，则抛出异常

返回:

getLoginId

public <T> T getLoginId(T default_value)

获取当前会话登录id, 如果未登录，则返回默认值

参数:

default_value -

返回:

getLoginId_defaultNull

public java.lang.Object getLoginId_defaultNull()

获取当前会话登录id, 如果未登录，则返回null

返回:

getLoginId_asString

public java.lang.String getLoginId_asString()

获取当前会话登录id, 并转换为String

返回:

getLoginId_asInt

public int getLoginId_asInt()

获取当前会话登录id, 并转换为int

返回:

getLoginId_asLong

public long getLoginId_asLong()

获取当前会话登录id, 并转换为long

返回:

getLoginIdByToken

public java.lang.Object getLoginIdByToken(java.lang.String tokenValue)

获取指定token对应的登录id，如果未登录，则返回 null

返回:

getSessionBySessionId

protected SaSession getSessionBySessionId(java.lang.String sessionId,
                                          boolean is_create)

获取指定key的session, 如果没有，is_create=是否新建并返回

参数:

sessionId -

is_create -

返回:

getSessionByLoginId

public SaSession getSessionByLoginId(java.lang.Object login_id)

获取指定login_id的session

参数:

login_id -

返回:

getSession

public SaSession getSession()

获取当前会话的session

返回:

hasPermission

public boolean hasPermission(java.lang.Object login_id,
                             java.lang.Object pcode)

指定login_id是否含有指定权限

参数:

login_id -

pcode -

返回:

hasPermission

public boolean hasPermission(java.lang.Object pcode)

当前会话是否含有指定权限

参数:

pcode -

返回:

checkPermission

public void checkPermission(java.lang.Object pcode)

当前账号是否含有指定权限 ， 没有就抛出异常

参数:

pcode -

checkPermissionAnd

public void checkPermissionAnd(java.lang.Object... pcodeArray)

当前账号是否含有指定权限 ， 【指定多个，必须全都有】

参数:

pcodeArray -

checkPermissionOr

public void checkPermissionOr(java.lang.Object... pcodeArray)

当前账号是否含有指定权限 ， 【指定多个，有一个就可以了】

参数:

pcodeArray -

getKey_tokenName

public java.lang.String getKey_tokenName()

获取key：客户端 tokenName

返回:

getKey_TokenValue

public java.lang.String getKey_TokenValue(java.lang.String tokenValue)

获取key： tokenValue 持久化

参数:

tokenValue -

返回:

getKey_LoginId

public java.lang.String getKey_LoginId(java.lang.Object login_id)

获取key： id 持久化

参数:

login_id -

返回:

getKey_session

public java.lang.String getKey_session(java.lang.Object login_id)

获取key： session 持久化

参数:

login_id -

返回: