Package cn.dev33.satoken.config

Class SaTokenConfig

java.lang.Object
cn.dev33.satoken.config.SaTokenConfig
All Implemented Interfaces:
Serializable
public class SaTokenConfig extends Object implements Serializable
Sa-Token 配置类 Model

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

Since:
1.10.0
Author:
click33
See Also:

  • Field Details

  • Constructor Details

    • SaTokenConfig

      public SaTokenConfig()

  • Method Details

    • getTokenName

      public String getTokenName()
      Returns:
      token 名称 （同时也是： cookie 名称、提交 token 时参数的名称、存储 token 时的 key 前缀）

    • setTokenName

      public SaTokenConfig setTokenName(String tokenName)
      Parameters:
      tokenName - token 名称 （同时也是： cookie 名称、提交 token 时参数的名称、存储 token 时的 key 前缀）
      Returns:
      对象自身

    • getTimeout

      public long getTimeout()
      Returns:
      token 有效期（单位：秒） 默认30天，-1 代表永久有效

    • setTimeout

      public SaTokenConfig setTimeout(long timeout)
      Parameters:
      timeout - token 有效期（单位：秒） 默认30天，-1 代表永久有效
      Returns:
      对象自身

    • getActiveTimeout

      public long getActiveTimeout()
      Returns:
      token 最低活跃频率（单位：秒），如果 token 超过此时间没有访问系统就会被冻结，默认-1 代表不限制，永不冻结 （例如可以设置为 1800 代表 30 分钟内无操作就冻结）

    • setActiveTimeout

      public SaTokenConfig setActiveTimeout(long activeTimeout)
      Parameters:
      activeTimeout - token 最低活跃频率（单位：秒），如果 token 超过此时间没有访问系统就会被冻结，默认-1 代表不限制，永不冻结 （例如可以设置为 1800 代表 30 分钟内无操作就冻结）
      Returns:
      对象自身

    • getDynamicActiveTimeout

      public Boolean getDynamicActiveTimeout()
      Returns:
      是否启用动态 activeTimeout 功能，如不需要请设置为 false，节省缓存请求次数

    • setDynamicActiveTimeout

      public SaTokenConfig setDynamicActiveTimeout(Boolean dynamicActiveTimeout)
      Parameters:
      dynamicActiveTimeout - 是否启用动态 activeTimeout 功能，如不需要请设置为 false，节省缓存请求次数
      Returns:
      对象自身

    • getIsConcurrent

      public Boolean getIsConcurrent()
      Returns:
      是否允许同一账号多地同时登录 （为 true 时允许一起登录, 为 false 时新登录挤掉旧登录）

    • setIsConcurrent

      public SaTokenConfig setIsConcurrent(Boolean isConcurrent)
      Parameters:
      isConcurrent - 是否允许同一账号多地同时登录 （为 true 时允许一起登录, 为 false 时新登录挤掉旧登录）
      Returns:
      对象自身

    • getIsShare

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

    • setIsShare

      public SaTokenConfig setIsShare(Boolean isShare)
      Parameters:
      isShare - 在多人登录同一账号时，是否共用一个 token （为 true 时所有登录共用一个token, 为 false 时每次登录新建一个 token）
      Returns:
      对象自身

    • getMaxLoginCount

      public int getMaxLoginCount()
      Returns:
      同一账号最大登录数量，-1代表不限 （只有在 isConcurrent=true, isShare=false 时此配置项才有意义）

    • setMaxLoginCount

      public SaTokenConfig setMaxLoginCount(int maxLoginCount)
      Parameters:
      maxLoginCount - 同一账号最大登录数量，-1代表不限 （只有在 isConcurrent=true, isShare=false 时此配置项才有意义）
      Returns:
      对象自身

    • getMaxTryTimes

      public int getMaxTryTimes()
      Returns:
      在每次创建 token 时的最高循环次数，用于保证 token 唯一性（-1=不循环尝试，直接使用）

    • setMaxTryTimes

      public SaTokenConfig setMaxTryTimes(int maxTryTimes)
      Parameters:
      maxTryTimes - 在每次创建 token 时的最高循环次数，用于保证 token 唯一性（-1=不循环尝试，直接使用）
      Returns:
      对象自身

    • getIsReadBody

      public Boolean getIsReadBody()
      Returns:
      是否尝试从请求体里读取 token

    • setIsReadBody

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

    • getIsReadHeader

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

    • setIsReadHeader

      public SaTokenConfig setIsReadHeader(Boolean isReadHeader)
      Parameters:
      isReadHeader - 是否尝试从 header 里读取 token
      Returns:
      对象自身

    • getIsReadCookie

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

    • setIsReadCookie

      public SaTokenConfig setIsReadCookie(Boolean isReadCookie)
      Parameters:
      isReadCookie - 是否尝试从 cookie 里读取 token
      Returns:
      对象自身

    • getIsLastingCookie

      public Boolean getIsLastingCookie()
      获取 是否为持久Cookie（临时Cookie在浏览器关闭时会自动删除，持久Cookie在重新打开后依然存在）
      Returns:
      isLastingCookie /

    • setIsLastingCookie

      public SaTokenConfig setIsLastingCookie(Boolean isLastingCookie)
      设置 是否为持久Cookie（临时Cookie在浏览器关闭时会自动删除，持久Cookie在重新打开后依然存在）
      Parameters:
      isLastingCookie - /
      Returns:
      对象自身

    • getIsWriteHeader

      public Boolean getIsWriteHeader()
      Returns:
      是否在登录后将 token 写入到响应头

    • setIsWriteHeader

      public SaTokenConfig setIsWriteHeader(Boolean isWriteHeader)
      Parameters:
      isWriteHeader - 是否在登录后将 token 写入到响应头
      Returns:
      对象自身

    • getTokenStyle

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

    • setTokenStyle

      public SaTokenConfig setTokenStyle(String tokenStyle)
      Parameters:
      tokenStyle - token 风格（默认可取值：uuid、simple-uuid、random-32、random-64、random-128、tik）
      Returns:
      对象自身

    • getDataRefreshPeriod

      public int getDataRefreshPeriod()
      Returns:
      默认 SaTokenDao 实现类中，每次清理过期数据间隔的时间（单位: 秒），默认值30秒，设置为 -1 代表不启动定时清理

    • setDataRefreshPeriod

      public SaTokenConfig setDataRefreshPeriod(int dataRefreshPeriod)
      Parameters:
      dataRefreshPeriod - 默认 SaTokenDao 实现类中，每次清理过期数据间隔的时间（单位: 秒），默认值30秒，设置为 -1 代表不启动定时清理
      Returns:
      对象自身

    • getTokenSessionCheckLogin

      public Boolean getTokenSessionCheckLogin()
      Returns:
      获取 Token-Session 时是否必须登录（如果配置为true，会在每次获取 getTokenSession() 时校验当前是否登录）

    • setTokenSessionCheckLogin

      public SaTokenConfig setTokenSessionCheckLogin(Boolean tokenSessionCheckLogin)
      Parameters:
      tokenSessionCheckLogin - 获取 Token-Session 时是否必须登录（如果配置为true，会在每次获取 getTokenSession() 时校验当前是否登录）
      Returns:
      对象自身

    • getAutoRenew

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

    • setAutoRenew

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

    • getTokenPrefix

      public String getTokenPrefix()
      Returns:
      token 前缀, 前端提交 token 时应该填写的固定前缀，格式样例(satoken: Bearer xxxx-xxxx-xxxx-xxxx)

    • setTokenPrefix

      public SaTokenConfig setTokenPrefix(String tokenPrefix)
      Parameters:
      tokenPrefix - token 前缀, 前端提交 token 时应该填写的固定前缀，格式样例(satoken: Bearer xxxx-xxxx-xxxx-xxxx)
      Returns:
      对象自身

    • getCookieAutoFillPrefix

      public Boolean getCookieAutoFillPrefix()
      Returns:
      cookie 模式是否自动填充 token 前缀

    • setCookieAutoFillPrefix

      public SaTokenConfig setCookieAutoFillPrefix(Boolean cookieAutoFillPrefix)
      Parameters:
      cookieAutoFillPrefix - cookie 模式是否自动填充 token 前缀
      Returns:
      对象自身

    • getIsPrint

      public Boolean getIsPrint()
      Returns:
      是否在初始化配置时在控制台打印版本字符画

    • setIsPrint

      public SaTokenConfig setIsPrint(Boolean isPrint)
      Parameters:
      isPrint - 是否在初始化配置时在控制台打印版本字符画
      Returns:
      对象自身

    • getIsLog

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

    • setIsLog

      public SaTokenConfig setIsLog(Boolean isLog)
      Parameters:
      isLog - 是否打印操作日志
      Returns:
      对象自身

    • getLogLevel

      public String getLogLevel()
      Returns:
      日志等级（trace、debug、info、warn、error、fatal），此值与 logLevelInt 联动

    • setLogLevel

      public SaTokenConfig setLogLevel(String logLevel)
      Parameters:
      logLevel - 日志等级（trace、debug、info、warn、error、fatal），此值与 logLevelInt 联动
      Returns:
      对象自身

    • getLogLevelInt

      public int getLogLevelInt()
      Returns:
      日志等级 int 值（1=trace、2=debug、3=info、4=warn、5=error、6=fatal），此值与 logLevel 联动

    • setLogLevelInt

      public SaTokenConfig setLogLevelInt(int logLevelInt)
      Parameters:
      logLevelInt - 日志等级 int 值（1=trace、2=debug、3=info、4=warn、5=error、6=fatal），此值与 logLevel 联动
      Returns:
      对象自身

    • getIsColorLog

      public Boolean getIsColorLog()
      获取：是否打印彩色日志
      Returns:
      isColorLog 是否打印彩色日志

    • setIsColorLog

      public SaTokenConfig setIsColorLog(Boolean isColorLog)
      设置：是否打印彩色日志
      Parameters:
      isColorLog - 是否打印彩色日志
      Returns:
      对象自身

    • getJwtSecretKey

      public String getJwtSecretKey()
      Returns:
      jwt秘钥（只有集成 jwt 相关模块时此参数才会生效）

    • setJwtSecretKey

      public SaTokenConfig setJwtSecretKey(String jwtSecretKey)
      Parameters:
      jwtSecretKey - jwt秘钥（只有集成 jwt 相关模块时此参数才会生效）
      Returns:
      对象自身

    • getHttpBasic

      public String getHttpBasic()
      Returns:
      Http Basic 认证的默认账号和密码，冒号隔开，例如：sa:123456

    • setHttpBasic

      public SaTokenConfig setHttpBasic(String httpBasic)
      Parameters:
      httpBasic - Http Basic 认证的默认账号和密码，冒号隔开，例如：sa:123456
      Returns:
      对象自身

    • getHttpDigest

      public String getHttpDigest()
      Returns:
      Http Digest 认证的默认账号和密码，冒号隔开，例如：sa:123456

    • setHttpDigest

      public SaTokenConfig setHttpDigest(String httpDigest)
      Parameters:
      httpDigest - Http Digest 认证的默认账号和密码，冒号隔开，例如：sa:123456
      Returns:
      对象自身

    • getCurrDomain

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

    • setCurrDomain

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

    • getSameTokenTimeout

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

    • setSameTokenTimeout

      public SaTokenConfig setSameTokenTimeout(long sameTokenTimeout)
      Parameters:
      sameTokenTimeout - Same-Token 的有效期 (单位: 秒)
      Returns:
      对象自身

    • getCheckSameToken

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

    • setCheckSameToken

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

    • getReplacedLoginExitMode

      public SaReplacedLoginExitMode getReplacedLoginExitMode()
      Returns:
      在 isConcurrent=false 时，决定新旧设备谁将放弃会话 (OLD_DEVICE=旧设备下线，新设备登录成功, NEW_DEVICE=新设备登录失败，旧设备维持在线)

    • setReplacedLoginExitMode

      public SaTokenConfig setReplacedLoginExitMode(SaReplacedLoginExitMode replacedLoginExitMode)
      Parameters:
      replacedLoginExitMode - 在 isConcurrent=false 时，决定新旧设备谁将放弃会话 (OLD_DEVICE=旧设备下线，新设备登录成功, NEW_DEVICE=新设备登录失败，旧设备维持在线)
      Returns:
      对象自身

    • getReplacedRange

      public SaReplacedRange getReplacedRange()
      获取 当 isConcurrent=false 时，顶人下线的范围 (CURR_DEVICE_TYPE=当前指定的设备类型端 ALL_DEVICE_TYPE=所有设备类型端)
      Returns:
      /

    • setReplacedRange

      public SaTokenConfig setReplacedRange(SaReplacedRange replacedRange)
      设置 当 isConcurrent=false 时，顶人下线的范围 (CURR_DEVICE_TYPE=当前指定的设备类型端 ALL_DEVICE_TYPE=所有设备类型端)
      Parameters:
      replacedRange - /
      Returns:
      对象自身

    • getOverflowLogoutMode

      public SaLogoutMode getOverflowLogoutMode()
      获取 溢出 maxLoginCount 的客户端，将以何种方式注销下线 (LOGOUT=注销下线, KICKOUT=踢人下线, REPLACED=顶人下线)
      Returns:
      /

    • setOverflowLogoutMode

      public SaTokenConfig setOverflowLogoutMode(SaLogoutMode overflowLogoutMode)
      设置 溢出 maxLoginCount 的客户端，将以何种方式注销下线 (LOGOUT=注销下线, KICKOUT=踢人下线, REPLACED=顶人下线)
      Parameters:
      overflowLogoutMode - /
      Returns:
      对象自身

    • getLogoutRange

      public SaLogoutRange getLogoutRange()
      获取 注销范围 (TOKEN=只注销当前 token 的会话，ACCOUNT=注销当前 token 指向的 loginId 其所有客户端会话)
      (此参数只在调用 StpUtil.logout() 时有效)
      Returns:
      /

    • setLogoutRange

      public SaTokenConfig setLogoutRange(SaLogoutRange logoutRange)
      设置 注销范围 (TOKEN=只注销当前 token 的会话，ACCOUNT=注销当前 token 指向的 loginId 其所有客户端会话)
      (此参数只在调用 StpUtil.logout() 时有效)
      Parameters:
      logoutRange - /
      Returns:
      对象自身

    • getIsLogoutKeepFreezeOps

      public Boolean getIsLogoutKeepFreezeOps()
      获取 如果 token 已被冻结，是否保留其操作权 (是否允许此 token 调用注销API)
      (此参数只在调用 StpUtil.[logoutkickoutreplaced]ByTokenValue("token") 时有效)
      Returns:
      isLogoutKeepFreezeOps /

    • setIsLogoutKeepFreezeOps

      public SaTokenConfig setIsLogoutKeepFreezeOps(Boolean isLogoutKeepFreezeOps)
      设置 如果 token 已被冻结，是否保留其操作权 (是否允许此 token 调用注销API)
      (此参数只在调用 StpUtil.[logoutkickoutreplaced]ByTokenValue("token") 时有效)
      Parameters:
      isLogoutKeepFreezeOps - /
      Returns:
      对象自身

    • getIsLogoutKeepTokenSession

      public Boolean getIsLogoutKeepTokenSession()
      获取 在注销 token 后，是否保留其对应的 Token-Session
      Returns:
      isLogoutKeepTokenSession /

    • setIsLogoutKeepTokenSession

      public SaTokenConfig setIsLogoutKeepTokenSession(Boolean isLogoutKeepTokenSession)
      设置 在注销 token 后，是否保留其对应的 Token-Session
      Parameters:
      isLogoutKeepTokenSession - /
      Returns:
      对象自身

    • getRightNowCreateTokenSession

      public Boolean getRightNowCreateTokenSession()
      获取 在登录时，是否立即创建对应的 Token-Session （true=在登录时立即创建，false=在第一次调用 getTokenSession() 时创建）
      Returns:
      /

    • setRightNowCreateTokenSession

      public SaTokenConfig setRightNowCreateTokenSession(Boolean rightNowCreateTokenSession)
      设置 在登录时，是否立即创建对应的 Token-Session （true=在登录时立即创建，false=在第一次调用 getTokenSession() 时创建）
      Parameters:
      rightNowCreateTokenSession - /
      Returns:
      对象自身

    • getCookie

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

    • setCookie

      public SaTokenConfig setCookie(SaCookieConfig cookie)
      Parameters:
      cookie - Cookie 全局配置对象
      Returns:
      对象自身

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getActivityTimeout

      @Deprecated public long getActivityTimeout()
      Deprecated.

      请更改为 getActiveTimeout()

      Returns:
      token 最低活跃频率（单位：秒），如果 token 超过此时间没有访问系统就会被冻结，默认-1 代表不限制，永不冻结 （例如可以设置为 1800 代表 30 分钟内无操作就冻结）

    • setActivityTimeout

      @Deprecated public SaTokenConfig setActivityTimeout(long activityTimeout)
      Deprecated.

      请更改为 setActiveTimeout()

      Parameters:
      activityTimeout - token 最低活跃频率（单位：秒），如果 token 超过此时间没有访问系统就会被冻结，默认-1 代表不限制，永不冻结 （例如可以设置为 1800 代表 30 分钟内无操作就冻结）
      Returns:
      对象自身

    • getBasic

      @Deprecated public String getBasic()
      Deprecated.

      请更改为 getHttpBasic()

      Returns:
      Http Basic 认证的默认账号和密码

    • setBasic

      @Deprecated public SaTokenConfig setBasic(String basic)
      Deprecated.

      请更改为 setHttpBasic()

      Parameters:
      basic - Http Basic 认证的默认账号和密码
      Returns:
      对象自身