org.hswebframework.web.authorization.token

接口 UserTokenManager

所有已知实现类:

DefaultUserTokenManager, RedisUserTokenManager

public interface UserTokenManager

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

从以下版本开始:

3.0

作者:

zhouhao

方法概要

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

方法详细资料

getByToken

reactor.core.publisher.Mono<UserToken> getByToken(String token)

根据token获取用户令牌信息

参数:

token - token

返回:

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

getByUserId

reactor.core.publisher.Flux<UserToken> getByUserId(String userId)

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

参数:

userId - 用户id

返回:

授权信息

userIsLoggedIn

reactor.core.publisher.Mono<Boolean> userIsLoggedIn(String userId)

参数:

userId - 用户ID

返回:

用户是否已经授权

tokenIsLoggedIn

reactor.core.publisher.Mono<Boolean> tokenIsLoggedIn(String token)

参数:

token - token

返回:

token是否已登记

totalUser

reactor.core.publisher.Mono<Integer> totalUser()

返回:

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

totalToken

reactor.core.publisher.Mono<Integer> totalToken()

返回:

总token数量

allLoggedUser

reactor.core.publisher.Flux<UserToken> allLoggedUser()

返回:

所有token

signOutByUserId

reactor.core.publisher.Mono<Void> signOutByUserId(String userId)

删除用户授权信息

参数:

userId - 用户ID

signOutByToken

reactor.core.publisher.Mono<Void> signOutByToken(String token)

根据token删除

参数:

token - 令牌

另请参阅:

UserTokenRemovedEvent

changeUserState

reactor.core.publisher.Mono<Void> changeUserState(String userId,
                                                  TokenState state)

修改userId的状态

参数:

userId - userId

state - 状态

另请参阅:

UserTokenChangedEvent, changeTokenState(java.lang.String, org.hswebframework.web.authorization.token.TokenState)

changeTokenState

reactor.core.publisher.Mono<Void> changeTokenState(String token,
                                                   TokenState state)

修改token的状态

参数:

token - token

state - 状态

另请参阅:

UserTokenChangedEvent

signIn

reactor.core.publisher.Mono<UserToken> signIn(String token,
                                              String type,
                                              String userId,
                                              long maxInactiveInterval)

登记一个用户的token

参数:

token - token

type - 令牌类型

userId - 用户id

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

另请参阅:

UserTokenCreatedEvent

touch

reactor.core.publisher.Mono<Void> touch(String token)

更新token,使其不过期

参数:

token - token

checkExpiredToken

reactor.core.publisher.Mono<Void> checkExpiredToken()

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

另请参阅:

this#signOutByToken(String)