CookieStore (Java Platform SE 6) - JavaTM 2 Platform Standard Edition 6.0 API 规范中文版

概述

软件包

类

使用

树

已过时

索引

帮助

Java^TM Platform
Standard Ed. 6

上一个类 下一个类

框架 无框架

摘要：嵌套 | 字段 | 构造方法 | 方法

详细信息：字段 | 构造方法 | 方法

java.net
接口 CookieStore

public interface CookieStore

表示 cookie 存储区的 CookieStore 对象。可以存储和获取 cookie。

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

从以下版本开始：: 1.6

方法摘要

void add(URI uri, HttpCookie cookie)
          将一个 HTTP cookie 添加到存储区中。

List<HttpCookie> get(URI uri)
          获取与给定 URI 关联或其域与给定 URI 匹配的 cookie。

List<HttpCookie> getCookies()
          获取 cookie 存储区中所有未过期的 cookie。

List<URI> getURIs()
          获取所有标识此 cookie 存储区中 cookie 的 URI。

boolean remove(URI uri, HttpCookie cookie)
          从存储区中移除 cookie。

boolean removeAll()
          移除此 cookie 存储区中的所有 cookie。

方法摘要
`void`	`add(URI uri, HttpCookie cookie)` 将一个 HTTP cookie 添加到存储区中。
`List<HttpCookie>`	`get(URI uri)` 获取与给定 URI 关联或其域与给定 URI 匹配的 cookie。
`List<HttpCookie>`	`getCookies()` 获取 cookie 存储区中所有未过期的 cookie。
`List<URI>`	`getURIs()` 获取所有标识此 cookie 存储区中 cookie 的 URI。
`boolean`	`remove(URI uri, HttpCookie cookie)` 从存储区中移除 cookie。
`boolean`	`removeAll()` 移除此 cookie 存储区中的所有 cookie。

方法详细信息

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(java.net.URI)

get

List<HttpCookie> get(URI uri)

获取与给定 URI 关联或其域与给定 URI 匹配的 cookie。只返回未过期的 cookie。为每个传出的 HTTP 请求调用此方法。

返回：: HttpCookie 的不可变列表；如果没有与给定 URI 匹配的 cookie，则返回空列表
抛出：: 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，则添加时要移除的 cookie 与给定的 URI 关联。; cookie - 要移除的 cookie
返回：: 如果此存储区包含指定的 cookie，则返回 true
抛出：: NullPointerException - 如果 cookie 为 null