程序包 cn.dev33.satoken.stp

类 SaLoginModel

java.lang.Object
cn.dev33.satoken.stp.SaLoginModel
public class SaLoginModel extends Object
在调用 `StpUtil.login()` 时的 配置参数 Model，决定登录的一些细节行为 
        // 例如：在登录时指定 token 有效期为七天，代码如下：
        StpUtil.login(10001, new SaLoginModel().setTimeout(60 * 60 * 24 * 7));
从以下版本开始:
1.13.2
作者:
click33

  • 字段详细资料

    • device

      public String device
      此次登录的客户端设备类型

    • isLastingCookie

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

    • timeout

      public Long timeout
      指定此次登录 token 有效期，单位：秒 （如未指定，自动取全局配置的 timeout 值）

    • extraData

      public Map<String,Object> extraData
      扩展信息（只在jwt模式下生效）

    • token

      public String token
      预定Token（预定本次登录生成的Token值）

  • 构造器详细资料

    • SaLoginModel

      public SaLoginModel()

  • 方法详细资料

    • getDevice

      public String getDevice()
      返回:
      此次登录的客户端设备类型

    • setDevice

      public SaLoginModel setDevice(String device)
      参数:
      device - 此次登录的客户端设备类型
      返回:
      对象自身

    • getIsLastingCookie

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

    • setIsLastingCookie

      public SaLoginModel setIsLastingCookie(Boolean isLastingCookie)
      参数:
      isLastingCookie - 是否为持久Cookie（临时Cookie在浏览器关闭时会自动删除，持久Cookie在重新打开后依然存在）
      返回:
      对象自身

    • getTimeout

      public Long getTimeout()
      返回:
      指定此次登录 token 有效期，单位：秒

    • setTimeout

      public SaLoginModel setTimeout(long timeout)
      参数:
      timeout - 指定此次登录 token 有效期，单位：秒 （如未指定，自动取全局配置的 timeout 值）
      返回:
      对象自身

    • getActiveTimeout

      public Long getActiveTimeout()
      返回:
      此次登录 token 最低活跃频率，单位：秒（如未指定，则使用全局配置的 activeTimeout 值）

    • setActiveTimeout

      public SaLoginModel setActiveTimeout(long activeTimeout)
      参数:
      activeTimeout - 指定此次登录 token 最低活跃频率，单位：秒（如未指定，则使用全局配置的 activeTimeout 值）
      返回:
      对象自身

    • getExtraData

      public Map<String,Object> getExtraData()
      返回:
      扩展信息（只在jwt模式下生效）

    • setExtraData

      public SaLoginModel setExtraData(Map<String,Object> extraData)
      参数:
      extraData - 扩展信息（只在jwt模式下生效）
      返回:
      对象自身

    • getToken

      public String getToken()
      返回:
      预定Token（预定本次登录生成的Token值）

    • setToken

      public SaLoginModel setToken(String token)
      参数:
      token - 预定Token（预定本次登录生成的Token值）
      返回:
      对象自身

    • getIsWriteHeader

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

    • setIsWriteHeader

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

    • getTokenSignTag

      public Object getTokenSignTag()
      获取 本次登录挂载到 TokenSign 的数据
      返回:
      tokenSignTag 本次登录挂载到 TokenSign 的数据

    • setTokenSignTag

      public SaLoginModel setTokenSignTag(Object tokenSignTag)
      设置 本次登录挂载到 TokenSign 的数据
      参数:
      tokenSignTag - 本次登录挂载到 TokenSign 的数据
      返回:
      对象自身

    • toString

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

    • getIsLastingCookieOrFalse

      public Boolean getIsLastingCookieOrFalse()
      返回:
      是否为持久Cookie（临时Cookie在浏览器关闭时会自动删除，持久Cookie在重新打开后依然存在）

    • getTimeoutOrGlobalConfig

      public Long getTimeoutOrGlobalConfig()
      返回:
      timeout 值 （如果此配置项尚未配置，则取全局配置的值）

    • getIsWriteHeaderOrGlobalConfig

      public Boolean getIsWriteHeaderOrGlobalConfig()
      返回:
      是否在登录后将 Token 写入到响应头 （如果此配置项尚未配置，则取全局配置的值）

    • setExtra

      public SaLoginModel setExtra(String key, Object value)
      写入扩展数据（只在jwt模式下生效）
      参数:
      key - 键
      value - 值
      返回:
      对象自身

    • getExtra

      public Object getExtra(String key)
      获取扩展数据（只在jwt模式下生效）
      参数:
      key - 键
      返回:
      扩展数据的值

    • isSetExtraData

      public boolean isSetExtraData()
      判断是否设置了扩展数据
      返回:
      /

    • getCookieTimeout

      public int getCookieTimeout()
      返回:
      Cookie时长

    • getDeviceOrDefault

      public String getDeviceOrDefault()
      返回:
      获取device参数，如果为null，则返回默认值

    • build

      public SaLoginModel build()
      构建对象，初始化默认值
      返回:
      对象自身

    • build

      public SaLoginModel build(SaTokenConfig config)
      构建对象，初始化默认值
      参数:
      config - 配置对象
      返回:
      对象自身

    • create

      public static SaLoginModel create()
      静态方法获取一个 SaLoginModel 对象
      返回:
      SaLoginModel 对象