Module  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相关联。 如果它不与URI相关联，则cookie的域和路径属性将指示它来自哪里。 如果与URI相关联，并且未指定其域和路径属性，则给定URI将指示该cookie来自哪里。

        如果对应于给定URI的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。 每个传出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 ，要删除的cookie与添加的URI不相关联; 如果不是null ， null删除的Cookie与添加的给定URI相关联。
        cookie - 要删除的cookie
        结果
        true如果这个商店包含指定的cookie
        异常
        NullPointerException - 如果 cookie是 null

      • removeAll

        boolean removeAll​()
        删除此Cookie商店中的所有Cookie。
        结果
        true如果该商店因呼叫而更改