Package cn.dev33.satoken.config

Class SaCookieConfig

java.lang.Object
cn.dev33.satoken.config.SaCookieConfig
public class SaCookieConfig extends Object
Sa-Token Cookie写入 相关配置
Since:
1.27.0
Author:
click33

  • Constructor Details

    • SaCookieConfig

      public SaCookieConfig()

  • Method Details

    • getDomain

      public String getDomain()
      获取：Cookie 作用域

      写入 Cookie 时显式指定的作用域, 常用于单点登录二级域名共享 Cookie 的场景。

      一般情况下你不需要设置此值，因为浏览器默认会把 Cookie 写到当前域名下。

      Returns:
      /

    • setDomain

      public SaCookieConfig setDomain(String domain)
      写入：Cookie 作用域

      写入 Cookie 时显式指定的作用域, 常用于单点登录二级域名共享 Cookie 的场景。

      一般情况下你不需要设置此值，因为浏览器默认会把 Cookie 写到当前域名下。

      Parameters:
      domain - /
      Returns:
      对象自身

    • getPath

      public String getPath()
      Returns:
      路径 （一般只有当你在一个域名下部署多个项目时才会用到此值。）

    • setPath

      public SaCookieConfig setPath(String path)
      Parameters:
      path - 路径 （一般只有当你在一个域名下部署多个项目时才会用到此值。）
      Returns:
      对象自身

    • getSecure

      public Boolean getSecure()
      Returns:
      是否只在 https 协议下有效

    • setSecure

      public SaCookieConfig setSecure(Boolean secure)
      Parameters:
      secure - 是否只在 https 协议下有效
      Returns:
      对象自身

    • getHttpOnly

      public Boolean getHttpOnly()
      Returns:
      是否禁止 js 操作 Cookie

    • setHttpOnly

      public SaCookieConfig setHttpOnly(Boolean httpOnly)
      Parameters:
      httpOnly - 是否禁止 js 操作 Cookie
      Returns:
      对象自身

    • getSameSite

      public String getSameSite()
      Returns:
      第三方限制级别（Strict=完全禁止，Lax=部分允许，None=不限制）

    • setSameSite

      public SaCookieConfig setSameSite(String sameSite)
      Parameters:
      sameSite - 第三方限制级别（Strict=完全禁止，Lax=部分允许，None=不限制）
      Returns:
      对象自身

    • getExtraAttrs

      public Map<String,String> getExtraAttrs()
      Returns:
      获取额外扩展属性

    • setExtraAttrs

      public SaCookieConfig setExtraAttrs(Map<String,String> extraAttrs)
      写入额外扩展属性
      Parameters:
      extraAttrs - /
      Returns:
      对象自身

    • addExtraAttr

      public SaCookieConfig addExtraAttr(String name, String value)
      追加扩展属性
      Parameters:
      name - /
      value - /
      Returns:
      对象自身

    • addExtraAttr

      public SaCookieConfig addExtraAttr(String name)
      追加扩展属性
      Parameters:
      name - /
      Returns:
      对象自身

    • removeExtraAttr

      public SaCookieConfig removeExtraAttr(String name)
      移除指定扩展属性
      Parameters:
      name - /
      Returns:
      对象自身

    • toString

      public String toString()
      Overrides:
      toString in class Object