cn.stylefeng.roses.kernel.auth.api

接口 LoginUserApi

public interface LoginUserApi

当前登陆用户相关的一系列方法

从以下版本开始:

2020/10/17 10:27

作者:

fengshuonan

方法概要

限定符和类型	方法和说明
void	endSwitch() 结束临时身份切换 仅应用在当前线程环境中
Long	getCurrentUserCompanyId() 获取当前登录用户当前机构对应的公司id
LoginUser	getLoginUser() 获取当前登陆用户 如果获取不到当前登陆用户会抛出 AuthException
LoginUser	getLoginUserNullable() 获取当前登陆用户 如果获取不到当前登陆用户返回null
boolean	getSuperAdminFlag() 获取是否是超级管理员的标识
String	getToken() 获取当前登陆用户的token 如果获取不到，返回null
boolean	hasLogin() 判断当前用户是否登录
LoginUser	switchTo(Long userId) 切换当前登录用户为指定用户id 仅应用在当前线程环境中，使用后请及时调用endSwitch()方法
void	switchTo(Long userId, java.util.function.Consumer<Long> consumer) 切换身份并执行一次函数回调

方法详细资料

getToken

String getToken()

获取当前登陆用户的token

如果获取不到，返回null

返回:

当前用户的token或null

从以下版本开始:

2020/10/17 11:05

getLoginUser

LoginUser getLoginUser()
                throws AuthException

获取当前登陆用户

如果获取不到当前登陆用户会抛出 AuthException

返回:

当前登陆用户信息

抛出:

AuthException - 权限异常

从以下版本开始:

2020/10/17 10:27

getLoginUserNullable

LoginUser getLoginUserNullable()

获取当前登陆用户

如果获取不到当前登陆用户返回null

返回:

当前登录用户信息

从以下版本开始:

2020/10/17 11:00

hasLogin

boolean hasLogin()

判断当前用户是否登录

返回:

是否登录，true是，false否

从以下版本开始:

2020/10/17 11:02

getSuperAdminFlag

boolean getSuperAdminFlag()

获取是否是超级管理员的标识

返回:

true-是超级管理员，false-不是超级管理员

从以下版本开始:

2020/11/4 15:45

getCurrentUserCompanyId

Long getCurrentUserCompanyId()

获取当前登录用户当前机构对应的公司id

从以下版本开始:

2023/8/1 14:03

switchTo

LoginUser switchTo(Long userId)

切换当前登录用户为指定用户id

仅应用在当前线程环境中，使用后请及时调用endSwitch()方法

参数:

userId - 切换到指定用户身份

从以下版本开始:

2023/11/16 21:03

endSwitch

void endSwitch()

结束临时身份切换

仅应用在当前线程环境中

从以下版本开始:

2023/11/16 21:03

switchTo

void switchTo(Long userId,
              java.util.function.Consumer<Long> consumer)

切换身份并执行一次函数回调

参数:

userId - 指定账号id

consumer - 要执行的方法

从以下版本开始:

2023/11/16 21:12