SaTokenConfig (sa-token-core 1.30.0.RC API)

java.lang.Object
- cn.dev33.satoken.config.SaTokenConfig

所有已实现的接口:

java.io.Serializable
```
public class SaTokenConfig
extends java.lang.Object
implements java.io.Serializable
```
Sa-Token 配置类 Model
你可以通过yml、properties、java代码等形式配置本类参数，具体请查阅官方文档: http://sa-token.dev33.cn/

作者:

kong

另请参阅:

序列化表格

字段概要

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

SaCookieConfig cookie
Cookie配置对象

字段
限定符和类型	字段和说明
`SaCookieConfig`	`cookie` Cookie配置对象

构造器概要

构造器
构造器和说明

SaTokenConfig()

构造器
构造器和说明
`SaTokenConfig()`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`long`	`getActivityTimeout()`
`java.lang.Boolean`	`getAutoRenew()`
`java.lang.String`	`getBasic()`
`java.lang.Boolean`	`getCheckIdToken()`
`SaCookieConfig`	`getCookie()`
`java.lang.String`	`getCookieDomain()` 已过时。
`java.lang.String`	`getCurrDomain()`
`int`	`getDataRefreshPeriod()`
`long`	`getIdTokenTimeout()`
`java.lang.Boolean`	`getIsConcurrent()`
`java.lang.Boolean`	`getIsLog()`
`java.lang.Boolean`	`getIsPrint()`
`java.lang.Boolean`	`getIsReadBody()`
`java.lang.Boolean`	`getIsReadCookie()`
`java.lang.Boolean`	`getIsReadHead()`
`java.lang.Boolean`	`getIsShare()`
`java.lang.String`	`getJwtSecretKey()`
`int`	`getMaxLoginCount()`
`long`	`getTimeout()`
`java.lang.String`	`getTokenName()`
`java.lang.String`	`getTokenPrefix()`
`java.lang.Boolean`	`getTokenSessionCheckLogin()`
`java.lang.String`	`getTokenStyle()`
`SaTokenConfig`	`setActivityTimeout(long activityTimeout)`
`SaTokenConfig`	`setAllowConcurrentLogin(java.lang.Boolean allowConcurrentLogin)` 已过时。
`SaTokenConfig`	`setAutoRenew(java.lang.Boolean autoRenew)`
`SaTokenConfig`	`setBasic(java.lang.String basic)`
`SaTokenConfig`	`setCheckIdToken(java.lang.Boolean checkIdToken)`
`SaTokenConfig`	`setCookie(SaCookieConfig cookie)`
`SaTokenConfig`	`setCookieDomain(java.lang.String cookieDomain)` 已过时。
`SaTokenConfig`	`setCurrDomain(java.lang.String currDomain)`
`SaTokenConfig`	`setDataRefreshPeriod(int dataRefreshPeriod)`
`SaTokenConfig`	`setIdTokenTimeout(long idTokenTimeout)`
`SaTokenConfig`	`setIsConcurrent(java.lang.Boolean isConcurrent)`
`SaTokenConfig`	`setIsLog(java.lang.Boolean isLog)`
`SaTokenConfig`	`setIsPrint(java.lang.Boolean isPrint)`
`SaTokenConfig`	`setIsReadBody(java.lang.Boolean isReadBody)`
`SaTokenConfig`	`setIsReadCookie(java.lang.Boolean isReadCookie)`
`SaTokenConfig`	`setIsReadHead(java.lang.Boolean isReadHead)`
`SaTokenConfig`	`setIsShare(java.lang.Boolean isShare)`
`SaTokenConfig`	`setIsV(java.lang.Boolean isV)` 已过时。
`SaTokenConfig`	`setJwtSecretKey(java.lang.String jwtSecretKey)`
`SaTokenConfig`	`setMaxLoginCount(int maxLoginCount)`
`SaTokenConfig`	`setTimeout(long timeout)`
`SaTokenConfig`	`setTokenName(java.lang.String tokenName)`
`SaTokenConfig`	`setTokenPrefix(java.lang.String tokenPrefix)`
`SaTokenConfig`	`setTokenSessionCheckLogin(java.lang.Boolean tokenSessionCheckLogin)`
`SaTokenConfig`	`setTokenStyle(java.lang.String tokenStyle)`
`java.lang.String`	`toString()`

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

- 字段详细资料
  - cookie
```
public SaCookieConfig cookie
```
    Cookie配置对象
- 构造器详细资料
  - SaTokenConfig
```
public SaTokenConfig()
```
- 方法详细资料
  - getTokenName
```
public java.lang.String getTokenName()
```
    返回:
    
    token名称 (同时也是cookie名称)
  - setTokenName
```
public SaTokenConfig setTokenName(java.lang.String tokenName)
```
    参数:
    
    tokenName - token名称 (同时也是cookie名称)
    
    返回:
    
    对象自身
  - getTimeout
```
public long getTimeout()
```
    返回:
    
    token的长久有效期(单位:秒) 默认30天, -1代表永久
  - setTimeout
```
public SaTokenConfig setTimeout(long timeout)
```
    参数:
    
    timeout - token的长久有效期(单位:秒) 默认30天, -1代表永久
    
    返回:
    
    对象自身
  - getActivityTimeout
```
public long getActivityTimeout()
```
    返回:
    
    token临时有效期 [指定时间内无操作就视为token过期] (单位: 秒), 默认-1 代表不限制 (例如可以设置为1800代表30分钟内无操作就过期)
  - setActivityTimeout
```
public SaTokenConfig setActivityTimeout(long activityTimeout)
```
    参数:
    
    activityTimeout - token临时有效期 [指定时间内无操作就视为token过期] (单位: 秒), 默认-1 代表不限制 (例如可以设置为1800代表30分钟内无操作就过期)
    
    返回:
    
    对象自身
  - getIsConcurrent
```
public java.lang.Boolean getIsConcurrent()
```
    返回:
    
    是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录)
  - setIsConcurrent
```
public SaTokenConfig setIsConcurrent(java.lang.Boolean isConcurrent)
```
    参数:
    
    isConcurrent - 是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录)
    
    返回:
    
    对象自身
  - getIsShare
```
public java.lang.Boolean getIsShare()
```
    返回:
    
    在多人登录同一账号时，是否共用一个token (为true时所有登录共用一个token, 为false时每次登录新建一个token)
  - setIsShare
```
public SaTokenConfig setIsShare(java.lang.Boolean isShare)
```
    参数:
    
    isShare - 在多人登录同一账号时，是否共用一个token (为true时所有登录共用一个token, 为false时每次登录新建一个token)
    
    返回:
    
    对象自身
  - getMaxLoginCount
```
public int getMaxLoginCount()
```
    返回:
    
    同一账号最大登录数量，-1代表不限（只有在 isConcurrent=true, isShare=false 时此配置才有效）
  - setMaxLoginCount
```
public SaTokenConfig setMaxLoginCount(int maxLoginCount)
```
    参数:
    
    maxLoginCount - 同一账号最大登录数量，-1代表不限（只有在 isConcurrent=true, isShare=false 时此配置才有效）
    
    返回:
    
    对象自身
  - getIsReadBody
```
public java.lang.Boolean getIsReadBody()
```
    返回:
    
    是否尝试从请求体里读取token
  - setIsReadBody
```
public SaTokenConfig setIsReadBody(java.lang.Boolean isReadBody)
```
    参数:
    
    isReadBody - 是否尝试从请求体里读取token
    
    返回:
    
    对象自身
  - getIsReadHead
```
public java.lang.Boolean getIsReadHead()
```
    返回:
    
    是否尝试从header里读取token
  - setIsReadHead
```
public SaTokenConfig setIsReadHead(java.lang.Boolean isReadHead)
```
    参数:
    
    isReadHead - 是否尝试从header里读取token
    
    返回:
    
    对象自身
  - getIsReadCookie
```
public java.lang.Boolean getIsReadCookie()
```
    返回:
    
    是否尝试从cookie里读取token
  - setIsReadCookie
```
public SaTokenConfig setIsReadCookie(java.lang.Boolean isReadCookie)
```
    参数:
    
    isReadCookie - 是否尝试从cookie里读取token
    
    返回:
    
    对象自身
  - getTokenStyle
```
public java.lang.String getTokenStyle()
```
    返回:
    
    token风格(默认可取值：uuid、simple-uuid、random-32、random-64、random-128、tik)
  - setTokenStyle
```
public SaTokenConfig setTokenStyle(java.lang.String tokenStyle)
```
    参数:
    
    tokenStyle - token风格(默认可取值：uuid、simple-uuid、random-32、random-64、random-128、tik)
    
    返回:
    
    对象自身
  - getDataRefreshPeriod
```
public int getDataRefreshPeriod()
```
    返回:
    
    默认dao层实现类中，每次清理过期数据间隔的时间 (单位: 秒) ，默认值30秒，设置为-1代表不启动定时清理
  - setDataRefreshPeriod
```
public SaTokenConfig setDataRefreshPeriod(int dataRefreshPeriod)
```
    参数:
    
    dataRefreshPeriod - 默认dao层实现类中，每次清理过期数据间隔的时间 (单位: 秒) ，默认值30秒，设置为-1代表不启动定时清理
    
    返回:
    
    对象自身
  - getTokenSessionCheckLogin
```
public java.lang.Boolean getTokenSessionCheckLogin()
```
    返回:
    
    获取[token专属session]时是否必须登录 (如果配置为true，会在每次获取[token-session]时校验是否登录)
  - setTokenSessionCheckLogin
```
public SaTokenConfig setTokenSessionCheckLogin(java.lang.Boolean tokenSessionCheckLogin)
```
    参数:
    
    tokenSessionCheckLogin - 获取[token专属session]时是否必须登录 (如果配置为true，会在每次获取[token-session]时校验是否登录)
    
    返回:
    
    对象自身
  - getAutoRenew
```
public java.lang.Boolean getAutoRenew()
```
    返回:
    
    是否打开了自动续签 (如果此值为true, 框架会在每次直接或间接调用getLoginId()时进行一次过期检查与续签操作)
  - setAutoRenew
```
public SaTokenConfig setAutoRenew(java.lang.Boolean autoRenew)
```
    参数:
    
    autoRenew - 是否打开自动续签 (如果此值为true, 框架会在每次直接或间接调用getLoginId()时进行一次过期检查与续签操作)
    
    返回:
    
    对象自身
  - getTokenPrefix
```
public java.lang.String getTokenPrefix()
```
    返回:
    
    token前缀, 格式样例(satoken: Bearer xxxx-xxxx-xxxx-xxxx)
  - setTokenPrefix
```
public SaTokenConfig setTokenPrefix(java.lang.String tokenPrefix)
```
    参数:
    
    tokenPrefix - token前缀, 格式样例(satoken: Bearer xxxx-xxxx-xxxx-xxxx)
    
    返回:
    
    对象自身
  - getIsPrint
```
public java.lang.Boolean getIsPrint()
```
    返回:
    
    是否在初始化配置时打印版本字符画
  - setIsPrint
```
public SaTokenConfig setIsPrint(java.lang.Boolean isPrint)
```
    参数:
    
    isPrint - 是否在初始化配置时打印版本字符画
    
    返回:
    
    对象自身
  - getIsLog
```
public java.lang.Boolean getIsLog()
```
    返回:
    
    是否打印操作日志
  - setIsLog
```
public SaTokenConfig setIsLog(java.lang.Boolean isLog)
```
    参数:
    
    isLog - 是否打印操作日志
    
    返回:
    
    对象自身
  - getJwtSecretKey
```
public java.lang.String getJwtSecretKey()
```
    返回:
    
    jwt秘钥 (只有集成 jwt 模块时此参数才会生效)
  - setJwtSecretKey
```
public SaTokenConfig setJwtSecretKey(java.lang.String jwtSecretKey)
```
    参数:
    
    jwtSecretKey - jwt秘钥 (只有集成 jwt 模块时此参数才会生效)
    
    返回:
    
    对象自身
  - getIdTokenTimeout
```
public long getIdTokenTimeout()
```
    返回:
    
    Id-Token的有效期 (单位: 秒)
  - setIdTokenTimeout
```
public SaTokenConfig setIdTokenTimeout(long idTokenTimeout)
```
    参数:
    
    idTokenTimeout - Id-Token的有效期 (单位: 秒)
    
    返回:
    
    对象自身
  - getBasic
```
public java.lang.String getBasic()
```
    返回:
    
    Http Basic 认证的账号和密码
  - setBasic
```
public SaTokenConfig setBasic(java.lang.String basic)
```
    参数:
    
    basic - Http Basic 认证的账号和密码
    
    返回:
    
    对象自身
  - getCurrDomain
```
public java.lang.String getCurrDomain()
```
    返回:
    
    配置当前项目的网络访问地址
  - setCurrDomain
```
public SaTokenConfig setCurrDomain(java.lang.String currDomain)
```
    参数:
    
    currDomain - 配置当前项目的网络访问地址
    
    返回:
    
    对象自身
  - getCheckIdToken
```
public java.lang.Boolean getCheckIdToken()
```
    返回:
    
    是否校验Id-Token（部分rpc插件有效）
  - setCheckIdToken
```
public SaTokenConfig setCheckIdToken(java.lang.Boolean checkIdToken)
```
    参数:
    
    checkIdToken - 是否校验Id-Token（部分rpc插件有效）
    
    返回:
    
    对象自身
  - getCookie
```
public SaCookieConfig getCookie()
```
    返回:
    
    Cookie 全局配置对象
  - setCookie
```
public SaTokenConfig setCookie(SaCookieConfig cookie)
```
    参数:
    
    cookie - Cookie 全局配置对象
    
    返回:
    
    对象自身
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - setAllowConcurrentLogin
```
@Deprecated
public SaTokenConfig setAllowConcurrentLogin(java.lang.Boolean allowConcurrentLogin)
```
    已过时。
    
    本函数设计已过时，未来版本可能移除此函数，请及时更换为 setIsConcurrent() ，使用方式保持不变
    
    参数:
    
    allowConcurrentLogin - see note
    
    返回:
    
    see note
  - setIsV
```
@Deprecated
public SaTokenConfig setIsV(java.lang.Boolean isV)
```
    已过时。
    
    本函数设计已过时，未来版本可能移除此函数，请及时更换为 setIsConcurrent() ，使用方式保持不变
    
    参数:
    
    isV - see note
    
    返回:
    
    see note
  - getCookieDomain
```
@Deprecated
public java.lang.String getCookieDomain()
```
    已过时。
    
    本函数设计已过时，未来版本可能移除此函数，请及时更换为 getCookie().getDomain() ，使用方式保持不变
    
    返回:
    
    写入Cookie时显式指定的作用域, 常用于单点登录二级域名共享Cookie的场景
  - setCookieDomain
```
@Deprecated
public SaTokenConfig setCookieDomain(java.lang.String cookieDomain)
```
    已过时。
    
    本函数设计已过时，未来版本可能移除此函数，请及时更换为 getCookie().setDomain() ，使用方式保持不变
    
    参数:
    
    cookieDomain - 写入Cookie时显式指定的作用域, 常用于单点登录二级域名共享Cookie的场景
    
    返回:
    
    对象自身

类 SaTokenConfig

字段概要

构造器概要

方法概要

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

字段详细资料

cookie

构造器详细资料

SaTokenConfig

方法详细资料

getTokenName

setTokenName

getTimeout

setTimeout

getActivityTimeout

setActivityTimeout

getIsConcurrent

setIsConcurrent

getIsShare

setIsShare

getMaxLoginCount

setMaxLoginCount

getIsReadBody

setIsReadBody

getIsReadHead

setIsReadHead

getIsReadCookie

setIsReadCookie

getTokenStyle

setTokenStyle

getDataRefreshPeriod

setDataRefreshPeriod

getTokenSessionCheckLogin

setTokenSessionCheckLogin

getAutoRenew

setAutoRenew

getTokenPrefix

setTokenPrefix

getIsPrint

setIsPrint

getIsLog

setIsLog

getJwtSecretKey

setJwtSecretKey

getIdTokenTimeout

setIdTokenTimeout

getBasic

setBasic

getCurrDomain

setCurrDomain

getCheckIdToken

setCheckIdToken

getCookie

setCookie

toString

setAllowConcurrentLogin

本函数设计已过时，未来版本可能移除此函数，请及时更换为 setIsConcurrent() ，使用方式保持不变

setIsV

本函数设计已过时，未来版本可能移除此函数，请及时更换为 setIsConcurrent() ，使用方式保持不变

getCookieDomain

本函数设计已过时，未来版本可能移除此函数，请及时更换为 getCookie().getDomain() ，使用方式保持不变

setCookieDomain

本函数设计已过时，未来版本可能移除此函数，请及时更换为 getCookie().setDomain() ，使用方式保持不变