cn.dev33.satoken.listener

接口 SaTokenListener

所有已知实现类:

SaTokenListenerForLog, SaTokenListenerForSimple

public interface SaTokenListener

Sa-Token 侦听器

你可以通过实现此接口在用户登陆、退出等关键性操作时进行一些AOP操作

作者:

kong

方法概要

限定符和类型	方法和说明
void	doCloseSafe(java.lang.String loginType, java.lang.String tokenValue, java.lang.String service) 每次关闭二级认证时触发
void	doCreateSession(java.lang.String id) 每次创建Session时触发
void	doDisable(java.lang.String loginType, java.lang.Object loginId, java.lang.String service, int level, long disableTime) 每次被封禁时触发
void	doKickout(java.lang.String loginType, java.lang.Object loginId, java.lang.String tokenValue) 每次被踢下线时触发
void	doLogin(java.lang.String loginType, java.lang.Object loginId, java.lang.String tokenValue, SaLoginModel loginModel) 每次登录时触发
void	doLogout(java.lang.String loginType, java.lang.Object loginId, java.lang.String tokenValue) 每次注销时触发
void	doLogoutSession(java.lang.String id) 每次注销Session时触发
void	doOpenSafe(java.lang.String loginType, java.lang.String tokenValue, java.lang.String service, long safeTime) 每次打开二级认证时触发
default void	doRegisterComponent(java.lang.String comtName, java.lang.Object comtObj) 全局组件载入
void	doRenewTimeout(java.lang.String tokenValue, java.lang.Object loginId, long timeout) 每次Token续期时触发
void	doReplaced(java.lang.String loginType, java.lang.Object loginId, java.lang.String tokenValue) 每次被顶下线时触发
default void	doSetConfig(SaTokenConfig config) 载入全局配置
default void	doSetStpLogic(StpLogic stpLogic) StpLogic 对象替换
void	doUntieDisable(java.lang.String loginType, java.lang.Object loginId, java.lang.String service) 每次被解封时触发

方法详细资料

doLogin

void doLogin(java.lang.String loginType,
             java.lang.Object loginId,
             java.lang.String tokenValue,
             SaLoginModel loginModel)

每次登录时触发

参数:

loginType - 账号类别

loginId - 账号id

tokenValue - 本次登录产生的 token 值

loginModel - 登录参数

doLogout

void doLogout(java.lang.String loginType,
              java.lang.Object loginId,
              java.lang.String tokenValue)

每次注销时触发

参数:

loginType - 账号类别

loginId - 账号id

tokenValue - token值

doKickout

void doKickout(java.lang.String loginType,
               java.lang.Object loginId,
               java.lang.String tokenValue)

每次被踢下线时触发

参数:

loginType - 账号类别

loginId - 账号id

tokenValue - token值

doReplaced

void doReplaced(java.lang.String loginType,
                java.lang.Object loginId,
                java.lang.String tokenValue)

每次被顶下线时触发

参数:

loginType - 账号类别

loginId - 账号id

tokenValue - token值

doDisable

void doDisable(java.lang.String loginType,
               java.lang.Object loginId,
               java.lang.String service,
               int level,
               long disableTime)

每次被封禁时触发

参数:

loginType - 账号类别

loginId - 账号id

service - 指定服务

level - 封禁等级

disableTime - 封禁时长，单位: 秒

doUntieDisable

void doUntieDisable(java.lang.String loginType,
                    java.lang.Object loginId,
                    java.lang.String service)

每次被解封时触发

参数:

loginType - 账号类别

loginId - 账号id

service - 指定服务

doOpenSafe

void doOpenSafe(java.lang.String loginType,
                java.lang.String tokenValue,
                java.lang.String service,
                long safeTime)

每次打开二级认证时触发

参数:

loginType - 账号类别

tokenValue - token值

service - 指定服务

safeTime - 认证时间，单位：秒

doCloseSafe

void doCloseSafe(java.lang.String loginType,
                 java.lang.String tokenValue,
                 java.lang.String service)

每次关闭二级认证时触发

参数:

loginType - 账号类别

tokenValue - token值

service - 指定服务

doCreateSession

void doCreateSession(java.lang.String id)

每次创建Session时触发

参数:

id - SessionId

doLogoutSession

void doLogoutSession(java.lang.String id)

每次注销Session时触发

参数:

id - SessionId

doRenewTimeout

void doRenewTimeout(java.lang.String tokenValue,
                    java.lang.Object loginId,
                    long timeout)

每次Token续期时触发

参数:

tokenValue - token 值

loginId - 账号id

timeout - 续期时间

doRegisterComponent

default void doRegisterComponent(java.lang.String comtName,
                                 java.lang.Object comtObj)

全局组件载入

参数:

comtName - 组件名称

comtObj - 组件对象

doSetStpLogic

default void doSetStpLogic(StpLogic stpLogic)

StpLogic 对象替换

参数:

stpLogic - /

doSetConfig

default void doSetConfig(SaTokenConfig config)

载入全局配置

参数:

config - /