cn.dev33.satoken.stp

类 StpUtil

java.lang.Object

cn.dev33.satoken.stp.StpUtil

public class StpUtil
extends java.lang.Object

一个默认的实现

作者:

kong

字段概要

字段

限定符和类型	字段和说明
static StpLogic	stpLogic 底层的 StpLogic 对象

构造器概要

构造器

构造器和说明
StpUtil()

方法概要

限定符和类型	方法和说明
static void	checkLogin() 检验当前会话是否已经登录，如未登录，则抛出异常
static void	checkPermission(java.lang.Object pcode) 当前账号是否含有指定权限 ， 没有就抛出异常
static void	checkPermissionAnd(java.lang.Object... pcodeArray) 当前账号是否含有指定权限 ， 【指定多个，必须全都有】
static void	checkPermissionOr(java.lang.Object... pcodeArray) 当前账号是否含有指定权限 ， 【指定多个，有一个就可以了】
static java.lang.Object	getLoginId() 获取当前会话登录id, 如果未登录，则抛出异常
static <T> T	getLoginId(T defaultValue) 获取当前会话登录id, 如果未登录，则返回默认值
static int	getLoginIdAsInt() 获取当前会话登录id, 并转换为int
static long	getLoginIdAsLong() 获取当前会话登录id, 并转换为long
static java.lang.String	getLoginIdAsString() 获取当前会话登录id, 并转换为String
static java.lang.Object	getLoginIdByToken(java.lang.String tokenValue) 获取指定token对应的登录id，如果未登录，则返回 null
static java.lang.Object	getLoginIdDefaultNull() 获取当前会话登录id, 如果未登录，则返回null
static SaSession	getSession() 获取当前会话的session
static SaSession	getSessionByLoginId(java.lang.Object loginId) 获取指定loginId的session
static SaSession	getSessionByLoginId(java.lang.Object loginId, boolean isCreate) 获取指定loginId的session, 如果没有，isCreate=是否新建并返回
static java.util.Map<java.lang.String,java.lang.String>	getTokenInfo() 获取当前会话的token信息：tokenName与tokenValue
static java.lang.String	getTokenName() 返回token名称
static java.lang.String	getTokenValue() 获取当前tokenValue
static java.lang.String	getTokenValueByLoginId(java.lang.Object loginId) 获取指定id的tokenValue
static boolean	hasPermission(java.lang.Object pcode) 当前会话是否含有指定权限
static boolean	hasPermission(java.lang.Object loginId, java.lang.Object pcode) 指定loginId是否含有指定权限
static boolean	isLogin() 获取当前会话是否已经登录
static void	kickoutByLoginId(java.lang.Object loginId) 指定loginId的会话注销登录（踢人下线）
static void	logout() 当前会话注销登录
static void	logoutByLoginId(java.lang.Object loginId) 指定loginId的会话注销登录（清退下线）
static void	setLoginId(java.lang.Object loginId) 在当前会话上登录id

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

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

字段详细资料

stpLogic

public static StpLogic stpLogic

底层的 StpLogic 对象

构造器详细资料

StpUtil

public StpUtil()

方法详细资料

getTokenName

public static java.lang.String getTokenName()

返回token名称

返回:

此StpLogic的token名称

getTokenValue

public static java.lang.String getTokenValue()

获取当前tokenValue

返回:

当前tokenValue

getTokenValueByLoginId

public static java.lang.String getTokenValueByLoginId(java.lang.Object loginId)

获取指定id的tokenValue

参数:

loginId - .

返回:

getTokenInfo

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

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

返回:

一个Map对象

setLoginId

public static void setLoginId(java.lang.Object loginId)

在当前会话上登录id

参数:

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

logout

public static void logout()

当前会话注销登录

logoutByLoginId

public static void logoutByLoginId(java.lang.Object loginId)

指定loginId的会话注销登录（清退下线）

参数:

loginId - 账号id

kickoutByLoginId

public static void kickoutByLoginId(java.lang.Object loginId)

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

参数:

loginId - 账号id

isLogin

public static boolean isLogin()

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

返回:

是否已登录

checkLogin

public static void checkLogin()

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

getLoginId

public static java.lang.Object getLoginId()

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

返回:

.

getLoginId

public static <T> T getLoginId(T defaultValue)

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

参数:

defaultValue - .

返回:

.

getLoginIdDefaultNull

public static java.lang.Object getLoginIdDefaultNull()

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

返回:

getLoginIdAsString

public static java.lang.String getLoginIdAsString()

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

返回:

getLoginIdAsInt

public static int getLoginIdAsInt()

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

返回:

getLoginIdAsLong

public static long getLoginIdAsLong()

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

返回:

getLoginIdByToken

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

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

返回:

.

getSessionByLoginId

public static SaSession getSessionByLoginId(java.lang.Object loginId,
                                            boolean isCreate)

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

参数:

loginId - 登录id

isCreate - 是否新建

返回:

SaSession

getSessionByLoginId

public static SaSession getSessionByLoginId(java.lang.Object loginId)

获取指定loginId的session

参数:

loginId - .

返回:

.

getSession

public static SaSession getSession()

获取当前会话的session

返回:

hasPermission

public static boolean hasPermission(java.lang.Object loginId,
                                    java.lang.Object pcode)

指定loginId是否含有指定权限

参数:

loginId - .

pcode - .

返回:

.

hasPermission

public static boolean hasPermission(java.lang.Object pcode)

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

参数:

pcode - .

返回:

.

checkPermission

public static void checkPermission(java.lang.Object pcode)

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

参数:

pcode - .

checkPermissionAnd

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

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

参数:

pcodeArray - .

checkPermissionOr

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

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

参数:

pcodeArray - .