public class StpUtil
extends java.lang.Object
| 构造器和说明 |
|---|
StpUtil() |
| 限定符和类型 | 方法和说明 |
|---|---|
static void |
checkActivityTimeout()
检查当前token 是否已经[临时过期],如果已经过期则抛出异常
|
static void |
checkLogin()
检验当前会话是否已经登录,如未登录,则抛出异常
|
static void |
checkPermission(java.lang.String permissionCode)
当前账号是否含有指定权限, 没有就抛出异常
|
static void |
checkPermissionAnd(java.lang.String... permissionCodeArray)
当前账号是否含有指定权限, [指定多个,必须全都有]
|
static void |
checkPermissionOr(java.lang.String... permissionCodeArray)
当前账号是否含有指定权限, [指定多个,有一个就可以通过]
|
static void |
checkRole(java.lang.String role)
当前账号是否含有指定角色标识,没有就抛出异常
|
static void |
checkRoleAnd(java.lang.String... roleArray)
当前账号是否含有指定角色标识, [指定多个,必须全都有]
|
static void |
checkRoleOr(java.lang.String... roleArray)
当前账号是否含有指定角色标识, [指定多个,有一个就可以通过]
|
static java.lang.String |
getLoginDevice()
返回当前token的登录设备
|
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 java.lang.String |
getLoginKey()
获取当前StpLogin的loginKey
|
static SaSession |
getSession()
获取当前会话的session,如果session尚未创建,则新建并返回
|
static SaSession |
getSession(boolean isCreate)
获取当前会话的session, 如果session尚未创建,isCreate=是否新建并返回
|
static SaSession |
getSessionByLoginId(java.lang.Object loginId)
获取指定loginId的session,如果session尚未创建,则新建并返回
|
static SaSession |
getSessionByLoginId(java.lang.Object loginId,
boolean isCreate)
获取指定loginId的session, 如果session尚未创建,isCreate=是否新建并返回
|
static SaSession |
getSessionBySessionId(java.lang.String sessionId)
获取指定key的session, 如果session尚未创建,则返回null
|
static long |
getSessionTimeout()
获取当前登录者的Session剩余有效时间 (单位: 秒)
|
static long |
getTokenActivityTimeout()
获取当前token[临时过期]剩余有效时间 (单位: 秒)
|
static SaTokenInfo |
getTokenInfo()
获取当前会话的token信息
|
static java.lang.String |
getTokenName()
返回token名称
|
static SaSession |
getTokenSession()
获取当前token的专属-session,如果session尚未创建,则新建并返回
|
static SaSession |
getTokenSessionByToken(java.lang.String tokenValue)
获取指定token的专属session,如果session尚未创建,则新建并返回
|
static long |
getTokenSessionTimeout()
获取当前token的专属Session剩余有效时间 (单位: 秒)
|
static long |
getTokenTimeout()
获取当前登录者的token剩余有效时间 (单位: 秒)
|
static java.lang.String |
getTokenValue()
获取当前tokenValue
|
static java.lang.String |
getTokenValueByLoginId(java.lang.Object loginId)
获取指定loginId的tokenValue
在配置为允许并发登录时,此方法只会返回队列的最后一个token,
如果你需要返回此账号id的所有token,请调用 getTokenValueListByLoginId
|
static java.lang.String |
getTokenValueByLoginId(java.lang.Object loginId,
java.lang.String device)
获取指定loginId指定设备端的tokenValue
在配置为允许并发登录时,此方法只会返回队列的最后一个token,
如果你需要返回此账号id的所有token,请调用 getTokenValueListByLoginId
|
static java.util.List<java.lang.String> |
getTokenValueListByLoginId(java.lang.Object loginId)
获取指定loginId的tokenValue集合
|
static java.util.List<java.lang.String> |
getTokenValueListByLoginId(java.lang.Object loginId,
java.lang.String device)
获取指定loginId指定设备端的tokenValue集合
|
static boolean |
hasPermission(java.lang.Object loginId,
java.lang.String permissionCode)
指定账号id是否含有指定权限
|
static boolean |
hasPermission(java.lang.String permissionCode)
当前账号id是否含有指定权限
|
static boolean |
hasRole(java.lang.Object loginId,
java.lang.String role)
指定账号id是否含有角色标识
|
static boolean |
hasRole(java.lang.String role)
当前账号id是否含有指定角色标识
|
static boolean |
isLogin()
获取当前会话是否已经登录
|
static void |
logout()
当前会话注销登录
|
static void |
logoutByLoginId(java.lang.Object loginId)
指定loginId的会话注销登录(踢人下线)
当对方再次访问系统时,会抛出NotLoginException异常,场景值=-2
|
static void |
logoutByLoginId(java.lang.Object loginId,
java.lang.String device)
指定loginId指定设备的会话注销登录(踢人下线)
当对方再次访问系统时,会抛出NotLoginException异常,场景值=-2
|
static void |
logoutByTokenValue(java.lang.String tokenValue)
指定token的会话注销登录
|
static java.util.List<java.lang.String> |
searchSessionId(java.lang.String keyword,
int start,
int size)
根据条件查询SessionId
|
static java.util.List<java.lang.String> |
searchTokenSessionId(java.lang.String keyword,
int start,
int size)
根据条件查询token专属Session的Id
|
static java.util.List<java.lang.String> |
searchTokenValue(java.lang.String keyword,
int start,
int size)
根据条件查询token
|
static void |
setLoginId(java.lang.Object loginId)
在当前会话上登录id
|
static void |
setLoginId(java.lang.Object loginId,
java.lang.String device)
在当前会话上登录id
|
static void |
updateLastActivityToNow()
续签当前token:(将 [最后操作时间] 更新为当前时间戳)
请注意: 即时token已经 [临时过期] 也可续签成功,
如果此场景下需要提示续签失败,可在此之前调用 checkActivityTimeout() 强制检查是否过期即可
|
public static StpLogic stpLogic
public static java.lang.String getTokenName()
public static java.lang.String getTokenValue()
public static java.lang.String getLoginKey()
public static SaTokenInfo getTokenInfo()
public static void setLoginId(java.lang.Object loginId)
loginId - 登录id,建议的类型:(long | int | String)public static void setLoginId(java.lang.Object loginId,
java.lang.String device)
loginId - 登录id,建议的类型:(long | int | String)device - 设备标识public static void logout()
public static void logoutByTokenValue(java.lang.String tokenValue)
tokenValue - 指定tokenpublic static void logoutByLoginId(java.lang.Object loginId)
当对方再次访问系统时,会抛出NotLoginException异常,场景值=-2
loginId - 账号idpublic static void logoutByLoginId(java.lang.Object loginId,
java.lang.String device)
当对方再次访问系统时,会抛出NotLoginException异常,场景值=-2
loginId - 账号iddevice - 设备标识public static boolean isLogin()
public static void checkLogin()
public static java.lang.Object getLoginId()
public static <T> T getLoginId(T defaultValue)
T - 返回类型defaultValue - 默认值public static java.lang.Object getLoginIdDefaultNull()
public static java.lang.String getLoginIdAsString()
public static int getLoginIdAsInt()
public static long getLoginIdAsLong()
public static java.lang.Object getLoginIdByToken(java.lang.String tokenValue)
tokenValue - tokenpublic static SaSession getSessionByLoginId(java.lang.Object loginId, boolean isCreate)
loginId - 账号idisCreate - 是否新建public static SaSession getSessionBySessionId(java.lang.String sessionId)
sessionId - sessionIdpublic static SaSession getSessionByLoginId(java.lang.Object loginId)
loginId - 账号idpublic static SaSession getSession(boolean isCreate)
isCreate - 是否新建public static SaSession getSession()
public static SaSession getTokenSessionByToken(java.lang.String tokenValue)
tokenValue - token值public static SaSession getTokenSession()
public static void checkActivityTimeout()
public static void updateLastActivityToNow()
public static long getTokenTimeout()
public static long getSessionTimeout()
public static long getTokenSessionTimeout()
public static long getTokenActivityTimeout()
public static boolean hasRole(java.lang.Object loginId,
java.lang.String role)
loginId - 账号idrole - 角色标识public static boolean hasRole(java.lang.String role)
role - 角色标识public static void checkRole(java.lang.String role)
role - 角色标识public static void checkRoleAnd(java.lang.String... roleArray)
roleArray - 角色标识数组public static void checkRoleOr(java.lang.String... roleArray)
roleArray - 角色标识数组public static boolean hasPermission(java.lang.Object loginId,
java.lang.String permissionCode)
loginId - 账号idpermissionCode - 权限码public static boolean hasPermission(java.lang.String permissionCode)
permissionCode - 权限码public static void checkPermission(java.lang.String permissionCode)
permissionCode - 权限码public static void checkPermissionAnd(java.lang.String... permissionCodeArray)
permissionCodeArray - 权限码数组public static void checkPermissionOr(java.lang.String... permissionCodeArray)
permissionCodeArray - 权限码数组public static java.lang.String getTokenValueByLoginId(java.lang.Object loginId)
在配置为允许并发登录时,此方法只会返回队列的最后一个token, 如果你需要返回此账号id的所有token,请调用 getTokenValueListByLoginId
loginId - 账号idpublic static java.lang.String getTokenValueByLoginId(java.lang.Object loginId,
java.lang.String device)
在配置为允许并发登录时,此方法只会返回队列的最后一个token, 如果你需要返回此账号id的所有token,请调用 getTokenValueListByLoginId
loginId - 账号iddevice - 设备标识public static java.util.List<java.lang.String> getTokenValueListByLoginId(java.lang.Object loginId)
loginId - 账号idpublic static java.util.List<java.lang.String> getTokenValueListByLoginId(java.lang.Object loginId,
java.lang.String device)
loginId - 账号iddevice - 设备标识public static java.lang.String getLoginDevice()
public static java.util.List<java.lang.String> searchTokenValue(java.lang.String keyword,
int start,
int size)
keyword - 关键字start - 开始处索引 (-1代表查询所有)size - 获取数量public static java.util.List<java.lang.String> searchSessionId(java.lang.String keyword,
int start,
int size)
keyword - 关键字start - 开始处索引 (-1代表查询所有)size - 获取数量public static java.util.List<java.lang.String> searchTokenSessionId(java.lang.String keyword,
int start,
int size)
keyword - 关键字start - 开始处索引 (-1代表查询所有)size - 获取数量Copyright © 2021. All Rights Reserved.