程序包 cn.dev33.satoken.stp.parameter

类 SaLogoutParameter

java.lang.Object
cn.dev33.satoken.stp.parameter.SaLogoutParameter
public class SaLogoutParameter extends Object
在会话注销时的 配置参数对象，决定注销时的一些细节行为 
        // 例如：
        StpUtil.logout(10001, new SaLogoutParameter());
从以下版本开始:
1.41.0
作者:
click33

  • 构造器详细资料

    • SaLogoutParameter

      public SaLogoutParameter()

    • SaLogoutParameter

      public SaLogoutParameter(SaTokenConfig config)

  • 方法详细资料

    • setDefaultValues

      public SaLogoutParameter setDefaultValues(SaTokenConfig config)
      根据 SaTokenConfig 对象初始化默认值
      参数:
      config - 使用的配置对象
      返回:
      对象自身

    • create

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

    • getIsKeepTokenSession

      public Boolean getIsKeepTokenSession()
      返回:
      在注销 token 后，是否保留其对应的 Token-Session

    • setIsKeepTokenSession

      public SaLogoutParameter setIsKeepTokenSession(Boolean isKeepTokenSession)
      参数:
      isKeepTokenSession - 在注销 token 后，是否保留其对应的 Token-Session
      返回:
      对象自身

    • getIsKeepFreezeOps

      public Boolean getIsKeepFreezeOps()
      获取 如果 token 已被冻结，是否保留其操作权 (是否允许此 token 调用注销API)
      (此参数只在调用 StpUtil.[logout/kickout/replaced]ByTokenValue("token", param) 时有效)
      返回:
      /

    • setIsKeepFreezeOps

      public SaLogoutParameter setIsKeepFreezeOps(Boolean isKeepFreezeOps)
      设置 如果 token 已被冻结，是否保留其操作权 (是否允许此 token 调用注销API)
      (此参数只在调用 StpUtil.[logout/kickout/replaced]ByTokenValue("token", param) 时有效)
      参数:
      isKeepFreezeOps - /
      返回:
      对象自身

    • getDeviceType

      public String getDeviceType()
      需要注销的设备类型 (为 null 代表不限制，为具体值代表只注销此设备类型的会话)
      (此参数只在调用 StpUtil.logout(id, parame) 时有效)
      返回:
      deviceType /

    • setDeviceType

      public SaLogoutParameter setDeviceType(String deviceType)
      需要注销的设备类型 (为 null 代表不限制，为具体值代表只注销此设备类型的会话)
      (此参数只在调用 StpUtil.logout(id, parame) 时有效)
      参数:
      deviceType - /
      返回:
      /

    • getDeviceId

      public String getDeviceId()
      需要注销的设备ID (为 null 代表不限制，为具体值代表只注销此设备 ID 的会话)
      (此参数只在调用 StpUtil.logout(id, parame) 时有效)
      返回:
      /

    • setDeviceId

      public SaLogoutParameter setDeviceId(String deviceId)
      需要注销的设备类型 (为 null 代表不限制，为具体值代表只注销此设备 ID 的会话)
      (此参数只在调用 StpUtil.logout(id, parame) 时有效)
      参数:
      deviceId - /
      返回:
      /

    • getMode

      public SaLogoutMode getMode()
      注销类型 (LOGOUT=注销下线、KICKOUT=踢人下线，REPLACED=顶人下线)
      返回:
      logoutMode 注销类型

    • setMode

      public SaLogoutParameter setMode(SaLogoutMode mode)
      注销类型 (LOGOUT=注销下线、KICKOUT=踢人下线，REPLACED=顶人下线)
      参数:
      mode - 注销类型
      返回:
      /

    • getRange

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

    • setRange

      public SaLogoutParameter setRange(SaLogoutRange range)
      注销范围 (TOKEN=只注销当前 token 的会话，ACCOUNT=注销当前 token 指向的 loginId 其所有客户端会话)
      (此参数只在调用 StpUtil.logout(param) 时有效)
      参数:
      range - /
      返回:
      /

    • toString

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