程序包 cn.dev33.satoken.config

类 SaTokenConfig

java.lang.Object
cn.dev33.satoken.config.SaTokenConfig
所有已实现的接口:
Serializable
public class SaTokenConfig extends Object implements Serializable
Sa-Token 配置类 Model

你可以通过yml、properties、java代码等形式配置本类参数，具体请查阅官方文档: https://sa-token.cc/

作者:
kong
另请参阅:

  • 字段详细资料

  • 构造器详细资料

    • SaTokenConfig

      public SaTokenConfig()

  • 方法详细资料

    • getTokenName

      public String getTokenName()
      返回:
      token名称 (同时也是cookie名称)

    • setTokenName

      public SaTokenConfig setTokenName(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 Boolean getIsConcurrent()
      返回:
      是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录)

    • setIsConcurrent

      public SaTokenConfig setIsConcurrent(Boolean isConcurrent)
      参数:
      isConcurrent - 是否允许同一账号并发登录 (为true时允许一起登录, 为false时新登录挤掉旧登录)
      返回:
      对象自身

    • getIsShare

      public Boolean getIsShare()
      返回:
      在多人登录同一账号时，是否共用一个token (为true时所有登录共用一个token, 为false时每次登录新建一个token)

    • setIsShare

      public SaTokenConfig setIsShare(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 Boolean getIsReadBody()
      返回:
      是否尝试从请求体里读取token

    • setIsReadBody

      public SaTokenConfig setIsReadBody(Boolean isReadBody)
      参数:
      isReadBody - 是否尝试从请求体里读取token
      返回:
      对象自身

    • getIsReadHeader

      public Boolean getIsReadHeader()
      返回:
      是否尝试从header里读取token

    • setIsReadHeader

      public SaTokenConfig setIsReadHeader(Boolean isReadHeader)
      参数:
      isReadHeader - 是否尝试从header里读取token
      返回:
      对象自身

    • getIsReadCookie

      public Boolean getIsReadCookie()
      返回:
      是否尝试从cookie里读取token

    • setIsReadCookie

      public SaTokenConfig setIsReadCookie(Boolean isReadCookie)
      参数:
      isReadCookie - 是否尝试从cookie里读取token
      返回:
      对象自身

    • getIsWriteHeader

      public Boolean getIsWriteHeader()
      返回:
      是否在登录后将 Token 写入到响应头

    • setIsWriteHeader

      public SaTokenConfig setIsWriteHeader(Boolean isWriteHeader)
      参数:
      isWriteHeader - 是否在登录后将 Token 写入到响应头
      返回:
      对象自身

    • getTokenStyle

      public String getTokenStyle()
      返回:
      token风格(默认可取值：uuid、simple-uuid、random-32、random-64、random-128、tik)

    • setTokenStyle

      public SaTokenConfig setTokenStyle(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 Boolean getTokenSessionCheckLogin()
      返回:
      获取[token专属session]时是否必须登录 (如果配置为true，会在每次获取[token-session]时校验是否登录)

    • setTokenSessionCheckLogin

      public SaTokenConfig setTokenSessionCheckLogin(Boolean tokenSessionCheckLogin)
      参数:
      tokenSessionCheckLogin - 获取[token专属session]时是否必须登录 (如果配置为true，会在每次获取[token-session]时校验是否登录)
      返回:
      对象自身

    • getAutoRenew

      public Boolean getAutoRenew()
      返回:
      是否打开了自动续签 (如果此值为true, 框架会在每次直接或间接调用getLoginId()时进行一次过期检查与续签操作)

    • setAutoRenew

      public SaTokenConfig setAutoRenew(Boolean autoRenew)
      参数:
      autoRenew - 是否打开自动续签 (如果此值为true, 框架会在每次直接或间接调用getLoginId()时进行一次过期检查与续签操作)
      返回:
      对象自身

    • getTokenPrefix

      public String getTokenPrefix()
      返回:
      token前缀, 格式样例(satoken: Bearer xxxx-xxxx-xxxx-xxxx)

    • setTokenPrefix

      public SaTokenConfig setTokenPrefix(String tokenPrefix)
      参数:
      tokenPrefix - token前缀, 格式样例(satoken: Bearer xxxx-xxxx-xxxx-xxxx)
      返回:
      对象自身

    • getIsPrint

      public Boolean getIsPrint()
      返回:
      是否在初始化配置时打印版本字符画

    • setIsPrint

      public SaTokenConfig setIsPrint(Boolean isPrint)
      参数:
      isPrint - 是否在初始化配置时打印版本字符画
      返回:
      对象自身

    • getIsLog

      public Boolean getIsLog()
      返回:
      是否打印操作日志

    • setIsLog

      public SaTokenConfig setIsLog(Boolean isLog)
      参数:
      isLog - 是否打印操作日志
      返回:
      对象自身

    • getLogLevel

      public String getLogLevel()
      返回:
      日志等级（trace、debug、info、warn、error、fatal）

    • setLogLevel

      public SaTokenConfig setLogLevel(String logLevel)
      参数:
      logLevel - 日志等级（trace、debug、info、warn、error、fatal）
      返回:
      对象自身

    • getLogLevelInt

      public int getLogLevelInt()
      返回:
      日志等级 int 值（1=trace、2=debug、3=info、4=warn、5=error、6=fatal）

    • setLogLeveInt

      public SaTokenConfig setLogLeveInt(int logLevelInt)
      参数:
      logLevelInt - 日志等级 int 值（1=trace、2=debug、3=info、4=warn、5=error、6=fatal）
      返回:
      对象自身

    • getJwtSecretKey

      public String getJwtSecretKey()
      返回:
      jwt秘钥 (只有集成 jwt 模块时此参数才会生效)

    • setJwtSecretKey

      public SaTokenConfig setJwtSecretKey(String jwtSecretKey)
      参数:
      jwtSecretKey - jwt秘钥 (只有集成 jwt 模块时此参数才会生效)
      返回:
      对象自身

    • getBasic

      public String getBasic()
      返回:
      Http Basic 认证的账号和密码

    • setBasic

      public SaTokenConfig setBasic(String basic)
      参数:
      basic - Http Basic 认证的账号和密码
      返回:
      对象自身

    • getCurrDomain

      public String getCurrDomain()
      返回:
      配置当前项目的网络访问地址

    • setCurrDomain

      public SaTokenConfig setCurrDomain(String currDomain)
      参数:
      currDomain - 配置当前项目的网络访问地址
      返回:
      对象自身

    • getSameTokenTimeout

      public long getSameTokenTimeout()
      返回:
      Same-Token 的有效期 (单位: 秒)

    • setSameTokenTimeout

      public SaTokenConfig setSameTokenTimeout(long sameTokenTimeout)
      参数:
      sameTokenTimeout - Same-Token 的有效期 (单位: 秒)
      返回:
      对象自身

    • getCheckSameToken

      public Boolean getCheckSameToken()
      返回:
      是否校验Same-Token（部分rpc插件有效）

    • setCheckSameToken

      public SaTokenConfig setCheckSameToken(Boolean checkSameToken)
      参数:
      checkSameToken - 是否校验Same-Token（部分rpc插件有效）
      返回:
      对象自身

    • getCookie

      public SaCookieConfig getCookie()
      返回:
      Cookie 全局配置对象

    • setCookie

      public SaTokenConfig setCookie(SaCookieConfig cookie)
      参数:
      cookie - Cookie 全局配置对象
      返回:
      对象自身

    • toString

      public String toString()
      覆盖:
      toString 在类中 Object

    • getIsReadHead

      @Deprecated public Boolean getIsReadHead()
      已过时。

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

      返回:
      是否尝试从header里读取token

    • setIsReadHead

      @Deprecated public SaTokenConfig setIsReadHead(Boolean isReadHead)
      已过时。

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

      参数:
      isReadHead - 是否尝试从header里读取token
      返回:
      对象自身

    • getIdTokenTimeout

      @Deprecated public long getIdTokenTimeout()
      已过时。

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

      返回:
      Id-Token的有效期 (单位: 秒)

    • setIdTokenTimeout

      @Deprecated public SaTokenConfig setIdTokenTimeout(long idTokenTimeout)
      已过时。

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

      参数:
      idTokenTimeout - Id-Token的有效期 (单位: 秒)
      返回:
      对象自身

    • getCheckIdToken

      @Deprecated public Boolean getCheckIdToken()
      已过时。

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

      返回:
      是否校验Id-Token（部分rpc插件有效）

    • setCheckIdToken

      @Deprecated public SaTokenConfig setCheckIdToken(Boolean checkIdToken)
      已过时。

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

      参数:
      checkIdToken - 是否校验Id-Token（部分rpc插件有效）
      返回:
      对象自身