Package cn.dev33.satoken.context.model

Class SaCookie

java.lang.Object
cn.dev33.satoken.context.model.SaCookie
public class SaCookie extends Object
Cookie Model，代表一个 Cookie 应该具有的所有参数
Since:
1.16.0
Author:
click33

  • Field Details

  • Constructor Details

    • SaCookie

      public SaCookie()
      构造一个

    • SaCookie

      public SaCookie(String name, String value)
      构造一个
      Parameters:
      name - 名字
      value - 值

  • Method Details

    • getName

      public String getName()
      Returns:
      名称

    • setName

      public SaCookie setName(String name)
      Parameters:
      name - 名称
      Returns:
      对象自身

    • getValue

      public String getValue()
      Returns:
      值

    • setValue

      public SaCookie setValue(String value)
      Parameters:
      value - 值
      Returns:
      对象自身

    • getMaxAge

      public int getMaxAge()
      Returns:
      有效时长 （单位：秒），-1 代表为临时Cookie 浏览器关闭后自动删除

    • setMaxAge

      public SaCookie setMaxAge(int maxAge)
      Parameters:
      maxAge - 有效时长 （单位：秒），-1 代表为临时Cookie 浏览器关闭后自动删除
      Returns:
      对象自身

    • getDomain

      public String getDomain()
      Returns:
      域

    • setDomain

      public SaCookie setDomain(String domain)
      Parameters:
      domain - 域
      Returns:
      对象自身

    • getPath

      public String getPath()
      Returns:
      路径

    • setPath

      public SaCookie setPath(String path)
      Parameters:
      path - 路径
      Returns:
      对象自身

    • getSecure

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

    • setSecure

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

    • getHttpOnly

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

    • setHttpOnly

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

    • getSameSite

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

    • setSameSite

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

    • getExtraAttrs

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

    • setExtraAttrs

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

    • addExtraAttr

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

    • addExtraAttr

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

    • removeExtraAttr

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public void builder()
      构建一下

    • toHeaderValue

      public String toHeaderValue()
      转换为响应头 Set-Cookie 参数需要的值
      Returns:
      /