cn.stylefeng.roses.kernel.auth.api

接口 SessionManagerApi

public interface SessionManagerApi

用户会话管理

会话指的是用户登录后和服务器一直保持一个交互状态的维护

会话具有时效性，反之，当用户不再访问系统的时候，会话应该自动失效

从以下版本开始:

2020/10/19 16:47

作者:

fengshuonan

方法概要

限定符和类型	方法和说明
void	createSession(String token, LoginUser loginUser) 创建会话
LoginUser	getSession(String token) 通过token获取会话
boolean	haveSession(String token) 判断一个token是否还存在会话状态
List<LoginUser>	onlineUserList() 获取在线用户列表
void	refreshSession(String token) 刷新会话的过期时间，刷新后用户当前的过期时间将重置
void	removeSession(String token) 根据token删除一个会话
void	removeSessionExcludeToken(String token) 删除用户所有的会话，但除了参数传的token的会话 用在单端登录中，一个账号只能在一个浏览器登录
void	updateSession(String token, LoginUser loginUser) 更新当前会话的loginUser对象的内容

方法详细资料

createSession

void createSession(String token,
                   LoginUser loginUser)

创建会话

参数:

token - 用户登录的token

loginUser - 登录的用户

从以下版本开始:

2020/10/19 16:47

updateSession

void updateSession(String token,
                   LoginUser loginUser)

更新当前会话的loginUser对象的内容

参数:

token - 用户的当前token

loginUser - 新的登录用户信息

从以下版本开始:

2021/1/9 10:43

getSession

LoginUser getSession(String token)

通过token获取会话

参数:

token - 用户token

返回:

token对应用户的详细信息

从以下版本开始:

2020/10/19 16:48

removeSession

void removeSession(String token)

根据token删除一个会话

参数:

token - 用户token

从以下版本开始:

2020/10/19 16:48

removeSessionExcludeToken

void removeSessionExcludeToken(String token)

删除用户所有的会话，但除了参数传的token的会话

用在单端登录中，一个账号只能在一个浏览器登录

参数:

token - 用户token

从以下版本开始:

2020/10/21 16:18

haveSession

boolean haveSession(String token)

判断一个token是否还存在会话状态

参数:

token - 用户token

返回:

true-存在会话，false-不存在会话或者失效了

从以下版本开始:

2020/10/19 16:49

refreshSession

void refreshSession(String token)

刷新会话的过期时间，刷新后用户当前的过期时间将重置

参数:

token - 用户的token

从以下版本开始:

2020/10/19 16:50

onlineUserList

List<LoginUser> onlineUserList()

获取在线用户列表

从以下版本开始:

2021/1/9 10:41