DefaultUserTokenManager (hsweb-authorization-api 4.0.12 API)

java.lang.Object
- org.hswebframework.web.authorization.token.DefaultUserTokenManager

所有已实现的接口:

UserTokenManager
```
public class DefaultUserTokenManager
extends Object
implements UserTokenManager
```
默认到用户令牌管理器，使用ConcurrentMap来存储令牌信息

从以下版本开始:

3.0

作者:

zhouhao

字段概要

字段
限定符和类型字段和说明

protected ConcurrentMap<String,LocalUserToken> tokenStorage

protected ConcurrentMap<String,Set<String>> userStorage

字段
限定符和类型	字段和说明
`protected ConcurrentMap<String,LocalUserToken>`	`tokenStorage`
`protected ConcurrentMap<String,Set<String>>`	`userStorage`

构造器概要

构造器
构造器和说明
`DefaultUserTokenManager()`
`DefaultUserTokenManager(ConcurrentMap<String,LocalUserToken> tokenStorage)`
`DefaultUserTokenManager(ConcurrentMap<String,LocalUserToken> tokenStorage, ConcurrentMap<String,Set<String>> userStorage)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`reactor.core.publisher.Flux<UserToken>`	`allLoggedUser()`
`reactor.core.publisher.Mono<Void>`	`changeTokenState(String token, TokenState state)` 修改token的状态
`reactor.core.publisher.Mono<Void>`	`changeTokenState(UserToken userToken, TokenState state)`
`reactor.core.publisher.Mono<Void>`	`changeUserState(String user, TokenState state)` 修改userId的状态
`reactor.core.publisher.Mono<Void>`	`checkExpiredToken()` 检查已过期的token,并将其remove
`AllopatricLoginMode`	`getAllopatricLoginMode()`
`reactor.core.publisher.Mono<UserToken>`	`getByToken(String token)` 根据token获取用户令牌信息
`reactor.core.publisher.Flux<UserToken>`	`getByUserId(String userId)` 根据用户id，获取全部令牌信息，如果没有则返回空集合而不是`null`
`protected Set<String>`	`getUserToken(String userId)`
`protected void`	`publishEvent(org.springframework.context.ApplicationEvent event)`
`void`	`setAllopatricLoginMode(AllopatricLoginMode allopatricLoginMode)`
`void`	`setEventPublisher(org.springframework.context.ApplicationEventPublisher eventPublisher)`
`reactor.core.publisher.Mono<UserToken>`	`signIn(String token, String type, String userId, long maxInactiveInterval)` 登记一个用户的token
`reactor.core.publisher.Mono<AuthenticationUserToken>`	`signIn(String token, String type, String userId, long maxInactiveInterval, Authentication authentication)` 登记一个包含认证信息的token
`reactor.core.publisher.Mono<Void>`	`signOutByToken(String token)` 根据token删除
`reactor.core.publisher.Mono<Void>`	`signOutByUserId(String userId)` 删除用户授权信息
`protected void`	`syncToken(UserToken userToken)` 同步令牌信息,如果使用redisson等来存储token，应该重写此方法并调用`this#tokenStorage`.put
`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)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

tokenStorage

protected final ConcurrentMap<String,LocalUserToken> tokenStorage

userStorage

protected final ConcurrentMap<String,Set<String>> userStorage

构造器详细资料

DefaultUserTokenManager
```
public DefaultUserTokenManager()
```

DefaultUserTokenManager

public DefaultUserTokenManager(ConcurrentMap<String,LocalUserToken> tokenStorage)

DefaultUserTokenManager

public DefaultUserTokenManager(ConcurrentMap<String,LocalUserToken> tokenStorage,
                               ConcurrentMap<String,Set<String>> userStorage)

方法详细资料
- setEventPublisher
```
@Autowired(required=false)
public void setEventPublisher(org.springframework.context.ApplicationEventPublisher eventPublisher)
```
- setAllopatricLoginMode
```
public void setAllopatricLoginMode(AllopatricLoginMode allopatricLoginMode)
```
- getAllopatricLoginMode
```
public AllopatricLoginMode getAllopatricLoginMode()
```
- getUserToken
```
protected Set<String> getUserToken(String userId)
```
- getByToken
```
public reactor.core.publisher.Mono<UserToken> getByToken(String token)
```
  从接口复制的说明: UserTokenManager
  
  根据token获取用户令牌信息
  
  指定者:
  
  getByToken 在接口中 UserTokenManager
  
  参数:
  
  token - token
  
  返回:
  
  令牌信息, 未授权时返回null
- getByUserId
```
public reactor.core.publisher.Flux<UserToken> getByUserId(String userId)
```
  从接口复制的说明: UserTokenManager
  
  根据用户id，获取全部令牌信息，如果没有则返回空集合而不是null
  
  指定者:
  
  getByUserId 在接口中 UserTokenManager
  
  参数:
  
  userId - 用户id
  
  返回:
  
  授权信息
- userIsLoggedIn
```
public reactor.core.publisher.Mono<Boolean> userIsLoggedIn(String userId)
```
  指定者:
  
  userIsLoggedIn 在接口中 UserTokenManager
  
  参数:
  
  userId - 用户ID
  
  返回:
  
  用户是否已经授权
- tokenIsLoggedIn
```
public reactor.core.publisher.Mono<Boolean> tokenIsLoggedIn(String token)
```
  指定者:
  
  tokenIsLoggedIn 在接口中 UserTokenManager
  
  参数:
  
  token - token
  
  返回:
  
  token是否已登记
- totalUser
```
public reactor.core.publisher.Mono<Integer> totalUser()
```
  指定者:
  
  totalUser 在接口中 UserTokenManager
  
  返回:
  
  总用户数量，一个用户多个地方登陆数量算1
- totalToken
```
public reactor.core.publisher.Mono<Integer> totalToken()
```
  指定者:
  
  totalToken 在接口中 UserTokenManager
  
  返回:
  
  总token数量
- allLoggedUser
```
public reactor.core.publisher.Flux<UserToken> allLoggedUser()
```
  指定者:
  
  allLoggedUser 在接口中 UserTokenManager
  
  返回:
  
  所有token
- signOutByUserId
```
public reactor.core.publisher.Mono<Void> signOutByUserId(String userId)
```
  从接口复制的说明: UserTokenManager
  
  删除用户授权信息
  
  指定者:
  
  signOutByUserId 在接口中 UserTokenManager
  
  参数:
  
  userId - 用户ID
- signOutByToken
```
public reactor.core.publisher.Mono<Void> signOutByToken(String token)
```
  从接口复制的说明: UserTokenManager
  
  根据token删除
  
  指定者:
  
  signOutByToken 在接口中 UserTokenManager
  
  参数:
  
  token - 令牌
  
  另请参阅:
  
  UserTokenRemovedEvent
- publishEvent
```
protected void publishEvent(org.springframework.context.ApplicationEvent event)
```
- changeTokenState
```
public reactor.core.publisher.Mono<Void> changeTokenState(UserToken userToken,
                                                          TokenState state)
```
- changeTokenState
```
public reactor.core.publisher.Mono<Void> changeTokenState(String token,
                                                          TokenState state)
```
  从接口复制的说明: UserTokenManager
  
  修改token的状态
  
  指定者:
  
  changeTokenState 在接口中 UserTokenManager
  
  参数:
  
  token - token
  
  state - 状态
  
  另请参阅:
  
  UserTokenChangedEvent
- changeUserState
```
public reactor.core.publisher.Mono<Void> changeUserState(String user,
                                                         TokenState state)
```
  从接口复制的说明: UserTokenManager
  
  修改userId的状态
  
  指定者:
  
  changeUserState 在接口中 UserTokenManager
  
  参数:
  
  user - userId
  
  state - 状态
  
  另请参阅:
  
  UserTokenChangedEvent, UserTokenManager.changeTokenState(java.lang.String, org.hswebframework.web.authorization.token.TokenState)
- signIn
```
public reactor.core.publisher.Mono<UserToken> signIn(String token,
                                                     String type,
                                                     String userId,
                                                     long maxInactiveInterval)
```
  从接口复制的说明: UserTokenManager
  
  登记一个用户的token
  
  指定者:
  
  signIn 在接口中 UserTokenManager
  
  参数:
  
  token - token
  
  type - 令牌类型
  
  userId - 用户id
  
  maxInactiveInterval - 最大不活动时间(单位毫秒),超过后令牌状态UserToken.getState()将变为过期TokenState.expired
  
  另请参阅:
  
  UserTokenCreatedEvent
- signIn
```
public reactor.core.publisher.Mono<AuthenticationUserToken> signIn(String token,
                                                                   String type,
                                                                   String userId,
                                                                   long maxInactiveInterval,
                                                                   Authentication authentication)
```
  从接口复制的说明: UserTokenManager
  
  登记一个包含认证信息的token
  
  指定者:
  
  signIn 在接口中 UserTokenManager
  
  参数:
  
  token - token
  
  type - 令牌类型
  
  userId - 用户ID
  
  maxInactiveInterval - 最大不活动时间(单位毫秒),小于0永不过期,超过后令牌状态UserToken.getState()将变为过期TokenState.expired
  
  authentication - 认证信息
  
  返回:
  
  token信息
- touch
```
public reactor.core.publisher.Mono<Void> touch(String token)
```
  从接口复制的说明: UserTokenManager
  
  更新token,使其不过期
  
  指定者:
  
  touch 在接口中 UserTokenManager
  
  参数:
  
  token - token
- checkExpiredToken
```
public reactor.core.publisher.Mono<Void> checkExpiredToken()
```
  从接口复制的说明: UserTokenManager
  
  检查已过期的token,并将其remove
  
  指定者:
  
  checkExpiredToken 在接口中 UserTokenManager
  
  另请参阅:
  
  UserTokenManager.signOutByToken(String)
- syncToken
```
protected void syncToken(UserToken userToken)
```
  同步令牌信息,如果使用redisson等来存储token，应该重写此方法并调用this#tokenStorage.put
  
  参数:
  
  userToken - 令牌

类 DefaultUserTokenManager

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

tokenStorage

userStorage

构造器详细资料

DefaultUserTokenManager

DefaultUserTokenManager

DefaultUserTokenManager

方法详细资料

setEventPublisher

setAllopatricLoginMode

getAllopatricLoginMode

getUserToken

getByToken

getByUserId

userIsLoggedIn

tokenIsLoggedIn

totalUser

totalToken

allLoggedUser

signOutByUserId

signOutByToken

publishEvent

changeTokenState

changeTokenState

changeUserState

signIn

signIn

touch

checkExpiredToken

syncToken