Package cn.dev33.satoken.stp.parameter

Class SaLoginParameter

java.lang.Object
cn.dev33.satoken.stp.parameter.SaLoginParameter
Direct Known Subclasses:
SaLoginModel
public class SaLoginParameter extends Object
在调用 `StpUtil.login()` 时的 配置参数对象，决定登录的一些细节行为 
        // 例如：在登录时指定 token 有效期为七天，代码如下：
        StpUtil.login(10001, new SaLoginParameter().setTimeout(60 * 60 * 24 * 7));
Since:
1.13.2
Author:
click33

  • Field Details

  • Constructor Details

    • SaLoginParameter

      public SaLoginParameter()

    • SaLoginParameter

      public SaLoginParameter(SaTokenConfig config)

  • Method Details

    • setDefaultValues

      public SaLoginParameter setDefaultValues(SaTokenConfig config)
      根据 SaTokenConfig 对象初始化默认值
      Parameters:
      config - 使用的配置对象
      Returns:
      对象自身

    • setExtra

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

    • getExtra

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

    • haveExtraData

      public boolean haveExtraData()
      判断是否设置了扩展数据（只在jwt模式下生效）
      Returns:
      /

    • setTerminalExtra

      public SaLoginParameter setTerminalExtra(String key, Object value)
      写入本次登录挂载到 SaTerminalInfo 的自定义扩展数据
      Parameters:
      key - 键
      value - 值
      Returns:
      对象自身

    • getTerminalExtra

      public Object getTerminalExtra(String key)
      获取本次登录挂载到 SaTerminalInfo 的自定义扩展数据
      Parameters:
      key - 键
      Returns:
      扩展数据的值

    • haveTerminalExtraData

      public boolean haveTerminalExtraData()
      判断是否设置了本次登录挂载到 SaTerminalInfo 的自定义扩展数据
      Returns:
      /

    • getCookieTimeout

      public int getCookieTimeout()
      计算 Cookie 时长
      Returns:
      /

    • create

      public static SaLoginParameter create()
      静态方法获取一个 SaLoginParameter 对象
      Returns:
      SaLoginParameter 对象

    • setupCookieConfig

      public SaLoginParameter setupCookieConfig(SaParamFunction<SaCookieConfig> fun)
      设置 Cookie 配置项
      Parameters:
      fun - /
      Returns:
      对象自身

    • getDeviceType

      public String getDeviceType()
      Returns:
      此次登录的客户端设备类型

    • setDeviceType

      public SaLoginParameter setDeviceType(String deviceType)
      Parameters:
      deviceType - 此次登录的客户端设备类型
      Returns:
      对象自身

    • getDeviceId

      public String getDeviceId()
      获取 此次登录的客户端设备id
      Returns:
      deviceId 此次登录的客户端设备id

    • setDeviceId

      public SaLoginParameter setDeviceId(String deviceId)
      设置 此次登录的客户端设备id
      Parameters:
      deviceId - 此次登录的客户端设备id

    • getReplacedRange

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

    • setReplacedRange

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

    • getOverflowLogoutMode

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

    • setOverflowLogoutMode

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

    • getIsLastingCookie

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

    • setIsLastingCookie

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

    • getTimeout

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

    • setTimeout

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

    • getActiveTimeout

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

    • setActiveTimeout

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

    • getIsConcurrent

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

    • setIsConcurrent

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

    • getIsShare

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

    • setIsShare

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

    • getMaxLoginCount

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

    • setMaxLoginCount

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

    • getMaxTryTimes

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

    • setMaxTryTimes

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

    • getExtraData

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

    • setExtraData

      public SaLoginParameter setExtraData(Map<String,Object> extraData)
      Parameters:
      extraData - 扩展信息（只在jwt模式下生效）
      Returns:
      对象自身

    • getToken

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

    • setToken

      public SaLoginParameter setToken(String token)
      Parameters:
      token - 预定Token（预定本次登录生成的Token值）
      Returns:
      对象自身

    • getIsWriteHeader

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

    • setIsWriteHeader

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

    • getTerminalExtraData

      public Map<String,Object> getTerminalExtraData()
      获取 本次登录挂载到 SaTerminalInfo 的自定义扩展数据
      Returns:
      /

    • setTerminalExtraData

      public SaLoginParameter setTerminalExtraData(Map<String,Object> terminalExtraData)
      设置 本次登录挂载到 SaTerminalInfo 的自定义扩展数据
      Parameters:
      terminalExtraData - /
      Returns:
      对象自身

    • getRightNowCreateTokenSession

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

    • setRightNowCreateTokenSession

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

    • getCookie

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

    • setCookie

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

    • getReplacedLoginExitMode

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

    • setReplacedLoginExitMode

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getDevice

      @Deprecated public String getDevice()
      Deprecated.

      请更换为 getDeviceType

      Returns:
      此次登录的客户端设备类型

    • setDevice

      @Deprecated public SaLoginParameter setDevice(String device)
      Deprecated.

      请更换为 setDeviceType

      Parameters:
      device - 此次登录的客户端设备类型
      Returns:
      对象自身