Module java.base
Package java.net

Interface CookieStore

public interface CookieStore
CookieStore对象表示cookie的存储。可以存储和检索cookie。

CookieManager将调用CookieStore.add来保存每个传入的HTTP响应的cookie，并调用CookieStore.get来检索每个传出的HTTP请求的cookie。CookieStore负责删除已过期的HttpCookie实例。

自版本:
1.6

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(URI uri, HttpCookie cookie)
    向存储添加一个HTTP cookie。
    List<HttpCookie>
    get(URI uri)
    检索与给定URI关联的cookie，或者其域与给定URI匹配的cookie。
    List<HttpCookie>
    getCookies()
    获取存储中所有未过期的cookie。
    List<URI>
    getURIs()
    获取标识此cookie存储中的cookie的所有URI。
    boolean
    remove(URI uri, HttpCookie cookie)
    从存储中删除一个cookie。
    boolean
    removeAll()
    删除此cookie存储中的所有cookie。

  • Method Details

    • add

      void add(URI uri, HttpCookie cookie)
      向存储添加一个HTTP cookie。这将针对每个传入的HTTP响应调用。

      要存储的cookie可能与URI关联，也可能不与URI关联。如果它不与URI关联，则cookie的域和路径属性将指示其来源。如果它与URI关联且其域和路径属性未指定，则给定的URI将指示此cookie的来源。

      如果与给定URI对应的cookie已存在，则将其替换为新的cookie。

      参数:
      uri - 与此cookie关联的URI。如果为null，则此cookie将不与URI关联
      cookie - 要存储的cookie
      抛出:
      NullPointerException - 如果cookie为null
      参见:

    • get

      List<HttpCookie> get(URI uri)
      检索与给定URI关联的cookie，或者其域与给定URI匹配的cookie。仅返回未过期的cookie。这将针对每个传出的HTTP请求调用。
      参数:
      uri - 与要返回的cookie关联的URI
      返回:
      一个不可变的HttpCookie列表，如果没有与给定URI匹配的cookie，则返回空列表
      抛出:
      NullPointerException - 如果uri为null
      参见:

    • getCookies

      List<HttpCookie> getCookies()
      获取存储中所有未过期的cookie。
      返回:
      一个不可变的http cookie列表；如果存储中没有http cookie，则返回空列表

    • getURIs

      List<URI> getURIs()
      获取标识此cookie存储中的cookie的所有URI。
      返回:
      一个不可变的URI列表；如果此cookie存储中没有与URI关联的cookie，则返回空列表

    • remove

      boolean remove(URI uri, HttpCookie cookie)
      从存储中删除一个cookie。
      参数:
      uri - 与此cookie关联的URI。如果为null，则要删除的cookie在添加时未与URI关联；如果不为null，则要删除的cookie在添加时与给定的URI关联。
      cookie - 要删除的cookie
      返回:
      true如果此存储包含指定的cookie
      抛出:
      NullPointerException - 如果cookie为null

    • removeAll

      boolean removeAll()
      删除此cookie存储中的所有cookie。
      返回:
      true如果此存储由于调用而发生更改