@@ -30,7 +30,7 @@ Sa-Token 是一个轻量级 Java 权限认证框架，目前拥有五大核心
当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-5
+ * + * @param tokenValue 指定 token + */ + public static void kickoutByTokenValue(String tokenValue) { + stpLogic.kickoutByTokenValue(tokenValue); + } + + /** + * 踢人下线，根据指定 token、注销参数 + *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-5
+ * + * @param tokenValue 指定 token + * @param logoutParameter 注销参数 + */ + public static void kickoutByTokenValue(String tokenValue, SaLogoutParameter logoutParameter) { + stpLogic.kickoutByTokenValue(tokenValue, logoutParameter); + } + + /** + * 顶人下线，根据指定 token + *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-4
+ * + * @param tokenValue 指定 token + */ + public static void replacedByTokenValue(String tokenValue) { + stpLogic.replacedByTokenValue(tokenValue); + } + + /** + * 顶人下线，根据指定 token、注销参数 + *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-4
+ * + * @param tokenValue 指定 token + * @param logoutParameter / + */ + public static void replacedByTokenValue(String tokenValue, SaLogoutParameter logoutParameter) { + stpLogic.replacedByTokenValue(tokenValue, logoutParameter); + } + + // --- 注销 (根据 loginId) + /** * 会话注销，根据账号id * @@ -252,12 +324,13 @@ public class StpUserUtil { } /** - * 会话注销，根据指定 Token + * 会话注销，根据账号id 和 注销参数 * - * @param tokenValue 指定 token + * @param loginId 账号id + * @param logoutParameter 注销参数 */ - public static void logoutByTokenValue(String tokenValue) { - stpLogic.logoutByTokenValue(tokenValue); + public static void logout(Object loginId, SaLogoutParameter logoutParameter) { + stpLogic.logout(loginId, logoutParameter); } /** @@ -282,13 +355,24 @@ public class StpUserUtil { } /** - * 踢人下线，根据指定 token + * 踢人下线，根据账号id 和 注销参数 *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-5
* - * @param tokenValue 指定 token + * @param loginId 账号id + * @param logoutParameter 注销参数 */ - public static void kickoutByTokenValue(String tokenValue) { - stpLogic.kickoutByTokenValue(tokenValue); + public static void kickout(Object loginId, SaLogoutParameter logoutParameter) { + stpLogic.kickout(loginId, logoutParameter); + } + + /** + * 顶人下线，根据账号id + *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-4
+ * + * @param loginId 账号id + */ + public static void replaced(Object loginId) { + stpLogic.replaced(loginId); } /** @@ -302,6 +386,47 @@ public class StpUserUtil { stpLogic.replaced(loginId, deviceType); } + /** + * 顶人下线，根据账号id 和 注销参数 + *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-4
+ * + * @param loginId 账号id + * @param logoutParameter 注销参数 + */ + public static void replaced(Object loginId, SaLogoutParameter logoutParameter) { + stpLogic.replaced(loginId, logoutParameter); + } + + // --- 注销 (会话管理辅助方法) + + /** + * 在 Account-Session 上移除 Terminal 信息 (注销下线方式) + * @param session / + * @param terminal / + */ + public static void removeTerminalByLogout(SaSession session, SaTerminalInfo terminal) { + stpLogic.removeTerminalByLogout(session, terminal); + } + + /** + * 在 Account-Session 上移除 Terminal 信息 (踢人下线方式) + * @param session / + * @param terminal / + */ + public static void removeTerminalByKickout(SaSession session, SaTerminalInfo terminal) { + stpLogic.removeTerminalByKickout(session, terminal); + } + + /** + * 在 Account-Session 上移除 Terminal 信息 (顶人下线方式) + * @param session / + * @param terminal / + */ + public static void removeTerminalByReplaced(SaSession session, SaTerminalInfo terminal) { + stpLogic.removeTerminalByReplaced(session, terminal); + } + + // 会话查询 /** @@ -386,7 +511,7 @@ public class StpUserUtil { } /** - * 获取指定 token 对应的账号id，如果未登录，则返回 null + * 获取指定 token 对应的账号id，如果 token 无效或 token 处于被踢、被顶、被冻结等状态，则返回 null * * @param tokenValue token * @return 账号id @@ -395,6 +520,16 @@ public class StpUserUtil { return stpLogic.getLoginIdByToken(tokenValue); } + /** + * 获取指定 token 对应的账号id，如果 token 无效或 token 处于被踢、被顶等状态 (不考虑被冻结)，则返回 null + * + * @param tokenValue token + * @return 账号id + */ + public Object getLoginIdByTokenNotThinkFreeze(String tokenValue) { + return stpLogic.getLoginIdByTokenNotThinkFreeze(tokenValue); + } + /** * 获取当前 Token 的扩展信息（此函数只在jwt模式下生效） * @@ -823,7 +958,17 @@ public class StpUserUtil { } /** - * 获取指定账号 id 指定设备类型端的 SaTerminalInfo 集合 + * 获取指定账号 id 已登录设备信息集合 + * + * @param loginId 账号id + * @return 此 loginId 的所有登录 token + */ + public static List当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-5
+ * + * @param tokenValue 指定 token + */ + public static void kickoutByTokenValue(String tokenValue) { + stpLogic.kickoutByTokenValue(tokenValue); + } + + /** + * 踢人下线，根据指定 token、注销参数 + *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-5
+ * + * @param tokenValue 指定 token + * @param logoutParameter 注销参数 + */ + public static void kickoutByTokenValue(String tokenValue, SaLogoutParameter logoutParameter) { + stpLogic.kickoutByTokenValue(tokenValue, logoutParameter); + } + + /** + * 顶人下线，根据指定 token + *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-4
+ * + * @param tokenValue 指定 token + */ + public static void replacedByTokenValue(String tokenValue) { + stpLogic.replacedByTokenValue(tokenValue); + } + + /** + * 顶人下线，根据指定 token、注销参数 + *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-4
+ * + * @param tokenValue 指定 token + * @param logoutParameter / + */ + public static void replacedByTokenValue(String tokenValue, SaLogoutParameter logoutParameter) { + stpLogic.replacedByTokenValue(tokenValue, logoutParameter); + } + + // --- 注销 (根据 loginId) + /** * 会话注销，根据账号id * @@ -244,19 +317,20 @@ public class StpUserUtil { * 会话注销，根据账号id 和 设备类型 * * @param loginId 账号id - * @param device 设备类型 (填 null 代表注销该账号的所有设备类型) + * @param deviceType 设备类型 (填 null 代表注销该账号的所有设备类型) */ - public static void logout(Object loginId, String device) { - stpLogic.logout(loginId, device); + public static void logout(Object loginId, String deviceType) { + stpLogic.logout(loginId, deviceType); } /** - * 会话注销，根据指定 Token + * 会话注销，根据账号id 和 注销参数 * - * @param tokenValue 指定 token + * @param loginId 账号id + * @param logoutParameter 注销参数 */ - public static void logoutByTokenValue(String tokenValue) { - stpLogic.logoutByTokenValue(tokenValue); + public static void logout(Object loginId, SaLogoutParameter logoutParameter) { + stpLogic.logout(loginId, logoutParameter); } /** @@ -274,20 +348,31 @@ public class StpUserUtil { *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-5
* * @param loginId 账号id - * @param device 设备类型 (填 null 代表踢出该账号的所有设备类型) + * @param deviceType 设备类型 (填 null 代表踢出该账号的所有设备类型) */ - public static void kickout(Object loginId, String device) { - stpLogic.kickout(loginId, device); + public static void kickout(Object loginId, String deviceType) { + stpLogic.kickout(loginId, deviceType); } /** - * 踢人下线，根据指定 token + * 踢人下线，根据账号id 和 注销参数 *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-5
* - * @param tokenValue 指定 token + * @param loginId 账号id + * @param logoutParameter 注销参数 */ - public static void kickoutByTokenValue(String tokenValue) { - stpLogic.kickoutByTokenValue(tokenValue); + public static void kickout(Object loginId, SaLogoutParameter logoutParameter) { + stpLogic.kickout(loginId, logoutParameter); + } + + /** + * 顶人下线，根据账号id + *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-4
+ * + * @param loginId 账号id + */ + public static void replaced(Object loginId) { + stpLogic.replaced(loginId); } /** @@ -295,12 +380,53 @@ public class StpUserUtil { *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-4
* * @param loginId 账号id - * @param device 设备类型 （填 null 代表顶替该账号的所有设备类型） + * @param deviceType 设备类型 （填 null 代表顶替该账号的所有设备类型） */ - public static void replaced(Object loginId, String device) { - stpLogic.replaced(loginId, device); + public static void replaced(Object loginId, String deviceType) { + stpLogic.replaced(loginId, deviceType); } + /** + * 顶人下线，根据账号id 和 注销参数 + *当对方再次访问系统时，会抛出 NotLoginException 异常，场景值=-4
+ * + * @param loginId 账号id + * @param logoutParameter 注销参数 + */ + public static void replaced(Object loginId, SaLogoutParameter logoutParameter) { + stpLogic.replaced(loginId, logoutParameter); + } + + // --- 注销 (会话管理辅助方法) + + /** + * 在 Account-Session 上移除 Terminal 信息 (注销下线方式) + * @param session / + * @param terminal / + */ + public static void removeTerminalByLogout(SaSession session, SaTerminalInfo terminal) { + stpLogic.removeTerminalByLogout(session, terminal); + } + + /** + * 在 Account-Session 上移除 Terminal 信息 (踢人下线方式) + * @param session / + * @param terminal / + */ + public static void removeTerminalByKickout(SaSession session, SaTerminalInfo terminal) { + stpLogic.removeTerminalByKickout(session, terminal); + } + + /** + * 在 Account-Session 上移除 Terminal 信息 (顶人下线方式) + * @param session / + * @param terminal / + */ + public static void removeTerminalByReplaced(SaSession session, SaTerminalInfo terminal) { + stpLogic.removeTerminalByReplaced(session, terminal); + } + + // 会话查询 /** @@ -312,6 +438,15 @@ public class StpUserUtil { return stpLogic.isLogin(); } + /** + * 判断指定账号是否已经登录 + * + * @return 已登录返回 true，未登录返回 false + */ + public static boolean isLogin(Object loginId) { + return stpLogic.isLogin(loginId); + } + /** * 检验当前会话是否已经登录，如未登录，则抛出异常 */ @@ -376,7 +511,7 @@ public class StpUserUtil { } /** - * 获取指定 token 对应的账号id，如果未登录，则返回 null + * 获取指定 token 对应的账号id，如果 token 无效或 token 处于被踢、被顶、被冻结等状态，则返回 null * * @param tokenValue token * @return 账号id @@ -385,6 +520,16 @@ public class StpUserUtil { return stpLogic.getLoginIdByToken(tokenValue); } + /** + * 获取指定 token 对应的账号id，如果 token 无效或 token 处于被踢、被顶等状态 (不考虑被冻结)，则返回 null + * + * @param tokenValue token + * @return 账号id + */ + public Object getLoginIdByTokenNotThinkFreeze(String tokenValue) { + return stpLogic.getLoginIdByTokenNotThinkFreeze(tokenValue); + } + /** * 获取当前 Token 的扩展信息（此函数只在jwt模式下生效） * @@ -784,11 +929,11 @@ public class StpUserUtil { * * * @param loginId 账号id - * @param device 设备类型，填 null 代表不限设备类型 + * @param deviceType 设备类型，填 null 代表不限设备类型 * @return token值 */ - public static String getTokenValueByLoginId(Object loginId, String device) { - return stpLogic.getTokenValueByLoginId(loginId, device); + public static String getTokenValueByLoginId(Object loginId, String deviceType) { + return stpLogic.getTokenValueByLoginId(loginId, deviceType); } /** @@ -805,11 +950,42 @@ public class StpUserUtil { * 获取指定账号 id 指定设备类型端的 token 集合 * * @param loginId 账号id - * @param device 设备类型，填 null 代表不限设备类型 + * @param deviceType 设备类型，填 null 代表不限设备类型 * @return 此 loginId 的所有登录 token */ - public static List
diff --git a/sa-token-doc/doc.html b/sa-token-doc/doc.html
index f2cdce29..c8b658d7 100644
--- a/sa-token-doc/doc.html
+++ b/sa-token-doc/doc.html
@@ -18,7 +18,7 @@
