StpLogic (sa-token-core 1.6.0 API)

java.lang.Object
- cn.dev33.satoken.stp.StpLogic

```
public class StpLogic
extends java.lang.Object
```
sa-token 权限验证，逻辑实现类
(stp = sa-token-permission 的缩写 )

作者:

kong

字段概要

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

java.lang.String loginKey
持久化的key前缀，多账号体系时以此值区分，比如：login、user、admin

字段
限定符和类型	字段和说明
`java.lang.String`	`loginKey` 持久化的key前缀，多账号体系时以此值区分，比如：login、user、admin

构造器概要

构造器
构造器和说明

StpLogic(java.lang.String loginKey)
初始化StpLogic, 并制定loginKey

构造器
构造器和说明
`StpLogic(java.lang.String loginKey)` 初始化StpLogic, 并制定loginKey

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`checkLogin()` 检验当前会话是否已经登录，如未登录，则抛出异常
`void`	`checkPermission(java.lang.Object pcode)` 当前账号是否含有指定权限，没有就抛出异常
`void`	`checkPermissionAnd(java.lang.Object... pcodeArray)` 当前账号是否含有指定权限，【指定多个，必须全都有】
`void`	`checkPermissionOr(java.lang.Object... pcodeArray)` 当前账号是否含有指定权限，【指定多个，有一个就可以了】
`java.lang.String`	`getKeyLoginId(java.lang.Object loginId)` 获取key： id 持久化
`java.lang.String`	`getKeySession(java.lang.Object loginId)` 获取key： session 持久化
`java.lang.String`	`getKeyTokenName()` 获取key：客户端 tokenName
`java.lang.String`	`getKeyTokenValue(java.lang.String tokenValue)` 获取key： tokenValue 持久化
`java.lang.Object`	`getLoginId()` 获取当前会话登录id, 如果未登录，则抛出异常
`<T> T`	`getLoginId(T defaultValue)` 获取当前会话登录id, 如果未登录，则返回默认值
`int`	`getLoginIdAsInt()` 获取当前会话登录id, 并转换为int
`long`	`getLoginIdAsLong()` 获取当前会话登录id, 并转换为long
`java.lang.String`	`getLoginIdAsString()` 获取当前会话登录id, 并转换为String
`java.lang.Object`	`getLoginIdByToken(java.lang.String tokenValue)` 获取指定token对应的登录id，如果未登录，则返回 null
`java.lang.Object`	`getLoginIdDefaultNull()` 获取当前会话登录id, 如果未登录，则返回null
`SaSession`	`getSession()` 获取当前会话的session
`SaSession`	`getSessionByLoginId(java.lang.Object loginId)` 获取指定loginId的session
`SaSession`	`getSessionByLoginId(java.lang.Object loginId, boolean isCreate)` 获取指定loginId的session, 如果没有，isCreate=是否新建并返回
`protected SaSession`	`getSessionBySessionId(java.lang.String sessionId, boolean isCreate)` 获取指定key的session, 如果没有，isCreate=是否新建并返回
`java.util.Map<java.lang.String,java.lang.String>`	`getTokenInfo()` 获取当前会话的token信息：tokenName与tokenValue
`java.lang.String`	`getTokenName()` 返回token名称
`java.lang.String`	`getTokenValue()` 获取当前tokenValue
`java.lang.String`	`getTokenValueByLoginId(java.lang.Object loginId)` 获取指定id的tokenValue
`boolean`	`hasPermission(java.lang.Object pcode)` 当前会话是否含有指定权限
`boolean`	`hasPermission(java.lang.Object loginId, java.lang.Object pcode)` 指定loginId是否含有指定权限
`boolean`	`isLogin()` 获取当前会话是否已经登录
`void`	`kickoutByLoginId(java.lang.Object loginId)` 指定loginId的会话注销登录（踢人下线）
`void`	`logout()` 当前会话注销登录
`void`	`logoutByLoginId(java.lang.Object loginId)` 指定loginId的会话注销登录（清退下线）
`java.lang.String`	`randomTokenValue(java.lang.Object loginId)` 随机生成一个tokenValue
`void`	`setLoginId(java.lang.Object loginId)` 在当前会话上登录id

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

- 字段详细资料
  - loginKey
```
public java.lang.String loginKey
```
    持久化的key前缀，多账号体系时以此值区分，比如：login、user、admin
- 构造器详细资料
  - StpLogic
```
public StpLogic(java.lang.String loginKey)
```
    初始化StpLogic, 并制定loginKey
    
    参数:
    
    loginKey - .
- 方法详细资料
  - getTokenName
```
public java.lang.String getTokenName()
```
    返回token名称
    
    返回:
    
    此StpLogic的token名称
  - randomTokenValue
```
public java.lang.String randomTokenValue(java.lang.Object loginId)
```
    随机生成一个tokenValue
    
    参数:
    
    loginId - loginId
    
    返回:
    
    生成的tokenValue
  - getTokenValue
```
public java.lang.String getTokenValue()
```
    获取当前tokenValue
    
    返回:
    
    当前tokenValue
  - getTokenValueByLoginId
```
public java.lang.String getTokenValueByLoginId(java.lang.Object loginId)
```
    获取指定id的tokenValue
    
    参数:
    
    loginId - .
    
    返回:
    
    .
  - getTokenInfo
```
public java.util.Map<java.lang.String,java.lang.String> getTokenInfo()
```
    获取当前会话的token信息：tokenName与tokenValue
    
    返回:
    
    一个Map对象
  - setLoginId
```
public void setLoginId(java.lang.Object loginId)
```
    在当前会话上登录id
    
    参数:
    
    loginId - 登录id ，建议的类型：（long | int | String）
  - logout
```
public void logout()
```
    当前会话注销登录
  - logoutByLoginId
```
public void logoutByLoginId(java.lang.Object loginId)
```
    指定loginId的会话注销登录（清退下线）
    
    参数:
    
    loginId - 账号id
  - kickoutByLoginId
```
public void kickoutByLoginId(java.lang.Object loginId)
```
    指定loginId的会话注销登录（踢人下线）
    
    参数:
    
    loginId - 账号id
  - isLogin
```
public boolean isLogin()
```
    获取当前会话是否已经登录
    
    返回:
    
    是否已登录
  - checkLogin
```
public void checkLogin()
```
    检验当前会话是否已经登录，如未登录，则抛出异常
  - getLoginId
```
public java.lang.Object getLoginId()
```
    获取当前会话登录id, 如果未登录，则抛出异常
    
    返回:
    
    .
  - getLoginId
```
public <T> T getLoginId(T defaultValue)
```
    获取当前会话登录id, 如果未登录，则返回默认值
    
    参数:
    
    defaultValue - .
    
    返回:
    
    .
  - getLoginIdDefaultNull
```
public java.lang.Object getLoginIdDefaultNull()
```
    获取当前会话登录id, 如果未登录，则返回null
    
    返回:
    
    .
  - getLoginIdAsString
```
public java.lang.String getLoginIdAsString()
```
    获取当前会话登录id, 并转换为String
    
    返回:
  - getLoginIdAsInt
```
public int getLoginIdAsInt()
```
    获取当前会话登录id, 并转换为int
    
    返回:
    
    .
  - getLoginIdAsLong
```
public long getLoginIdAsLong()
```
    获取当前会话登录id, 并转换为long
    
    返回:
    
    .
  - getLoginIdByToken
```
public java.lang.Object getLoginIdByToken(java.lang.String tokenValue)
```
    获取指定token对应的登录id，如果未登录，则返回 null
    
    返回:
    
    .
  - getSessionBySessionId
```
protected SaSession getSessionBySessionId(java.lang.String sessionId,
                                          boolean isCreate)
```
    获取指定key的session, 如果没有，isCreate=是否新建并返回
    
    参数:
    
    sessionId - .
    
    isCreate - .
    
    返回:
    
    .
  - getSessionByLoginId
```
public SaSession getSessionByLoginId(java.lang.Object loginId,
                                     boolean isCreate)
```
    获取指定loginId的session, 如果没有，isCreate=是否新建并返回
    
    参数:
    
    loginId - 登录id
    
    isCreate - 是否新建
    
    返回:
    
    SaSession
  - getSessionByLoginId
```
public SaSession getSessionByLoginId(java.lang.Object loginId)
```
    获取指定loginId的session
    
    参数:
    
    loginId - .
    
    返回:
    
    .
  - getSession
```
public SaSession getSession()
```
    获取当前会话的session
    
    返回:
  - hasPermission
```
public boolean hasPermission(java.lang.Object loginId,
                             java.lang.Object pcode)
```
    指定loginId是否含有指定权限
    
    参数:
    
    loginId - .
    
    pcode - .
    
    返回:
    
    .
  - hasPermission
```
public boolean hasPermission(java.lang.Object pcode)
```
    当前会话是否含有指定权限
    
    参数:
    
    pcode - .
    
    返回:
    
    .
  - checkPermission
```
public void checkPermission(java.lang.Object pcode)
```
    当前账号是否含有指定权限，没有就抛出异常
    
    参数:
    
    pcode - .
  - checkPermissionAnd
```
public void checkPermissionAnd(java.lang.Object... pcodeArray)
```
    当前账号是否含有指定权限，【指定多个，必须全都有】
    
    参数:
    
    pcodeArray - .
  - checkPermissionOr
```
public void checkPermissionOr(java.lang.Object... pcodeArray)
```
    当前账号是否含有指定权限，【指定多个，有一个就可以了】
    
    参数:
    
    pcodeArray - .
  - getKeyTokenName
```
public java.lang.String getKeyTokenName()
```
    获取key：客户端 tokenName
    
    返回:
  - getKeyTokenValue
```
public java.lang.String getKeyTokenValue(java.lang.String tokenValue)
```
    获取key： tokenValue 持久化
    
    参数:
    
    tokenValue - .
    
    返回:
  - getKeyLoginId
```
public java.lang.String getKeyLoginId(java.lang.Object loginId)
```
    获取key： id 持久化
    
    参数:
    
    loginId - .
    
    返回:
  - getKeySession
```
public java.lang.String getKeySession(java.lang.Object loginId)
```
    获取key： session 持久化
    
    参数:
    
    loginId - .
    
    返回:
    
    .

类 StpLogic

字段概要

构造器概要

方法概要

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

字段详细资料

loginKey

构造器详细资料

StpLogic

方法详细资料

getTokenName

randomTokenValue

getTokenValue

getTokenValueByLoginId

getTokenInfo

setLoginId

logout

logoutByLoginId

kickoutByLoginId

isLogin

checkLogin

getLoginId

getLoginId

getLoginIdDefaultNull

getLoginIdAsString

getLoginIdAsInt

getLoginIdAsLong

getLoginIdByToken

getSessionBySessionId

getSessionByLoginId

getSessionByLoginId

getSession

hasPermission

hasPermission

checkPermission

checkPermissionAnd

checkPermissionOr

getKeyTokenName

getKeyTokenValue

getKeyLoginId

getKeySession