模块  java.base
软件包  java.net

Interface CookieStore

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

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

    从以下版本开始：
    1.6

    • 方法详细信息

      • add

        void add​(URI uri,
         HttpCookie cookie)
        向商店添加一个HTTP cookie。 每次传入的HTTP响应都会调用此方法。

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

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

        参数
        uri - 与此cookie相关的uri。 如果是null ，则此cookie不会与URI关联
        cookie - 要存储的cookie
        异常
        NullPointerException - 如果 cookie是 null
        另请参见：
        get(java.net.URI)

      • get

        List<HttpCookie> get​(URI uri)
        检索与给定URI关联的cookie，或其域与给定URI匹配的cookie。 仅返回未过期的cookie。 每个传出的HTTP请求都会调用此方法。
        参数
        uri - 与要返回的cookie相关联的uri
        结果
        一个HttpCookie的不可变列表，如果没有cookie匹配给定的URI，则返回空列表
        异常
        NullPointerException - 如果 uri是 null
        另请参见：
        add(java.net.URI, java.net.HttpCookie)

      • getCookies

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

      • getURIs

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

      • remove

        boolean remove​(URI uri,
               HttpCookie cookie)
        从商店中删除cookie。
        参数
        uri - 与此cookie相关联的uri。 如果是null ， null的cookie在添加时不与URI关联; 如果不是null ， null的cookie在添加时与给定的URI相关联。
        cookie - 要删除的cookie
        结果
        true如果此商店包含指定的cookie
        异常
        NullPointerException - 如果 cookie是 null

      • removeAll

        boolean removeAll()
        删除此Cookie存储中的所有Cookie。
        结果
        true如果此商店因调用而更改