类的使用
cn.dev33.satoken.stp.parameter.SaLogoutParameter
使用SaLogoutParameter的程序包
-
cn.dev33.satoken.stp中SaLogoutParameter的使用
参数类型为SaLogoutParameter的cn.dev33.satoken.stp中的方法修饰符和类型方法说明voidStpLogic._logout(Object loginId, SaLogoutParameter logoutParameter) [work] 会话注销,根据账号id 和 注销参数voidStpLogic._logoutByTokenValue(String tokenValue, SaLogoutParameter logoutParameter) [work] 注销下线,根据指定 token 、注销参数voidStpLogic._removeTerminal(SaSession session, SaTerminalInfo terminal, SaLogoutParameter logoutParameter) 在 Account-Session 上移除 Terminal 信息 (内部方法,仅为减少重复代码,外部调用意义不大)voidStpLogic.kickout(Object loginId, SaLogoutParameter logoutParameter) 踢人下线,根据账号id 和 注销参数static voidStpUtil.kickout(Object loginId, SaLogoutParameter logoutParameter) 踢人下线,根据账号id 和 注销参数voidStpLogic.kickoutByTokenValue(String tokenValue, SaLogoutParameter logoutParameter) 踢人下线,根据指定 token、注销参数static voidStpUtil.kickoutByTokenValue(String tokenValue, SaLogoutParameter logoutParameter) 踢人下线,根据指定 token、注销参数voidStpLogic.logout(SaLogoutParameter logoutParameter) 在当前客户端会话注销,根据注销参数voidStpLogic.logout(Object loginId, SaLogoutParameter logoutParameter) 会话注销,根据账号id 和 注销参数static voidStpUtil.logout(SaLogoutParameter logoutParameter) 在当前客户端会话注销,根据注销参数static voidStpUtil.logout(Object loginId, SaLogoutParameter logoutParameter) 会话注销,根据账号id 和 注销参数voidStpLogic.logoutByTokenValue(String tokenValue, SaLogoutParameter logoutParameter) 注销下线,根据指定 token、注销参数static voidStpUtil.logoutByTokenValue(String tokenValue, SaLogoutParameter logoutParameter) 注销下线,根据指定 token、注销参数voidStpLogic.replaced(Object loginId, SaLogoutParameter logoutParameter) 顶人下线,根据账号id 和 注销参数static voidStpUtil.replaced(Object loginId, SaLogoutParameter logoutParameter) 顶人下线,根据账号id 和 注销参数voidStpLogic.replacedByTokenValue(String tokenValue, SaLogoutParameter logoutParameter) 顶人下线,根据指定 token、注销参数static voidStpUtil.replacedByTokenValue(String tokenValue, SaLogoutParameter logoutParameter) 顶人下线,根据指定 token、注销参数 -
cn.dev33.satoken.stp.parameter中SaLogoutParameter的使用
修饰符和类型方法说明static SaLogoutParameterSaLogoutParameter.create()静态方法获取一个 SaLoginParameter 对象SaLogoutParameter.setDefaultValues(SaTokenConfig config) 根据 SaTokenConfig 对象初始化默认值SaLogoutParameter.setDeviceId(String deviceId) 需要注销的设备类型 (为 null 代表不限制,为具体值代表只注销此设备 ID 的会话)
(此参数只在调用 StpUtil.logout(id, parame) 时有效)SaLogoutParameter.setDeviceType(String deviceType) 需要注销的设备类型 (为 null 代表不限制,为具体值代表只注销此设备类型的会话)
(此参数只在调用 StpUtil.logout(id, parame) 时有效)SaLogoutParameter.setIsKeepFreezeOps(Boolean isKeepFreezeOps) 设置 如果 token 已被冻结,是否保留其操作权 (是否允许此 token 调用注销API)
(此参数只在调用 StpUtil.SaLogoutParameter.setIsKeepTokenSession(Boolean isKeepTokenSession) SaLogoutParameter.setMode(SaLogoutMode mode) 注销类型 (LOGOUT=注销下线、KICKOUT=踢人下线,REPLACED=顶人下线)SaLogoutParameter.setRange(SaLogoutRange range) 注销范围 (TOKEN=只注销当前 token 的会话,ACCOUNT=注销当前 token 指向的 loginId 其所有客户端会话)
(此参数只在调用 StpUtil.logout(param) 时有效)