程序包 cn.dev33.satoken.stp

类 SaLoginConfig

java.lang.Object
cn.dev33.satoken.stp.SaLoginConfig
public class SaLoginConfig extends Object
快速、简洁的构建：调用 `StpUtil.login()` 时的 [ 配置参数 SaLoginModel ] 
        // 例如：在登录时指定 token 有效期为七天，代码如下：
        StpUtil.login(10001, SaLoginConfig.setTimeout(60 * 60 * 24 * 7));

        // 上面的代码与下面的代码等价
        StpUtil.login(10001, new SaLoginModel().setTimeout(60 * 60 * 24 * 7));
从以下版本开始:
1.29.0
作者:
click33

  • 方法详细资料

    • setDevice

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

    • setIsLastingCookie

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

    • setTimeout

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

    • setActiveTimeout

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

    • setExtraData

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

    • setToken

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

    • setExtra

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

    • setIsWriteHeader

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

    • setTokenSignTag

      public static SaLoginModel setTokenSignTag(Object tokenSignTag)
      设置 本次登录挂载到 TokenSign 的数据
      参数:
      tokenSignTag - /
      返回:
      登录参数 Model

    • create

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