org.hswebframework.web.authorization.token

接口 UserTokenManager

所有已知实现类:

DefaultUserTokenManager

public interface UserTokenManager

用户令牌管理器,用于管理用户令牌

从以下版本开始:

3.0

作者:

zhouhao

方法概要

限定符和类型	方法和说明
List<UserToken>	allLoggedUser()
void	allLoggedUser(java.util.function.Consumer<UserToken> consumer) 遍历全部token信息
void	changeTokenState(String token, TokenState state) 修改token的状态
void	changeUserState(String userId, TokenState state) 修改userId的状态
void	checkExpiredToken() 检查已过期的token,并将其remove
UserToken	getByToken(String token) 根据token获取用户令牌信息
List<UserToken>	getByUserId(String userId) 根据用户id，获取全部令牌信息，如果没有则返回空集合而不是null
UserToken	signIn(String token, String type, String userId, long maxInactiveInterval) 登记一个用户的token
void	signOutByToken(String token) 根据token删除
void	signOutByUserId(String userId) 删除用户授权信息
boolean	tokenIsLoggedIn(String token)
long	totalToken()
long	totalUser()
void	touch(String token) 更新token,使其不过期
boolean	userIsLoggedIn(String userId)

方法详细资料

getByToken

UserToken getByToken(String token)

根据token获取用户令牌信息

参数:

token - token

返回:

令牌信息, 未授权时返回null

getByUserId

List<UserToken> getByUserId(String userId)

根据用户id，获取全部令牌信息，如果没有则返回空集合而不是null

参数:

userId - 用户id

返回:

授权信息

userIsLoggedIn

boolean userIsLoggedIn(String userId)

参数:

userId - 用户ID

返回:

用户是否已经授权

tokenIsLoggedIn

boolean tokenIsLoggedIn(String token)

参数:

token - token

返回:

token是否已登记

totalUser

long totalUser()

返回:

总用户数量，一个用户多个地方登陆数量算1

totalToken

long totalToken()

返回:

总token数量

allLoggedUser

List<UserToken> allLoggedUser()

返回:

所有token

allLoggedUser

void allLoggedUser(java.util.function.Consumer<UserToken> consumer)

遍历全部token信息

参数:

consumer - token消费者

signOutByUserId

void signOutByUserId(String userId)

删除用户授权信息

参数:

userId - 用户ID

signOutByToken

void signOutByToken(String token)

根据token删除

参数:

token - 令牌

另请参阅:

UserTokenRemovedEvent

changeUserState

void changeUserState(String userId,
                     TokenState state)

修改userId的状态

参数:

userId - userId

state - 状态

另请参阅:

UserTokenChangedEvent, this#changeTokenState

changeTokenState

void changeTokenState(String token,
                      TokenState state)

修改token的状态

参数:

token - token

state - 状态

另请参阅:

UserTokenChangedEvent

signIn

UserToken signIn(String token,
                 String type,
                 String userId,
                 long maxInactiveInterval)

登记一个用户的token

参数:

token - token

type - 令牌类型

userId - 用户id

maxInactiveInterval - 最大不活动时间,超过后令牌状态UserToken.getState()将变为过期TokenState.expired

另请参阅:

UserTokenCreatedEvent

touch

void touch(String token)

更新token,使其不过期

参数:

token - token

checkExpiredToken

void checkExpiredToken()

检查已过期的token,并将其remove

另请参阅:

this#signOutByToken(String)