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

概述

软件包

类

使用

树

已过时

索引

帮助

Java^TM Platform
Standard Ed. 6

上一个类 下一个类

框架 无框架

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

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

java.net
类 CookieHandler

java.lang.Object
  java.net.CookieHandler

直接已知子类：: CookieManager

public abstract class CookieHandler
extends Object
extends Object

CookieHandler 对象提供一种回调机制以将 HTTP 状态管理策略实现挂钩到 HTTP 协议处理程序。HTTP 状态管理机制利用 HTTP 请求和响应指定创建有状态的会话的方式。

可以通过执行 CookieHandler.setDefault(CookieHandler) 来注册 HTTP 协议处理程序要使用的系统级 CookieHandler。调用 CookieHandler.getDefault() 可以获取当前注册的 CookieHandler。有关 HTTP 状态管理的更多信息，请参见 RFC 2965: HTTP 状态管理机制

从以下版本开始：: 1.5

构造方法摘要

CookieHandler()


方法摘要

abstract Map<String,List<String>> get(URI uri, Map<String,List<String>> requestHeaders)
          从请求头中指定 uri 的 cookie 缓存中获取所有可用的 cookie。

static CookieHandler getDefault()
          获取系统级 cookie 处理程序。

abstract void put(URI uri, Map<String,List<String>> responseHeaders)
          将响应头中出现的所有可用 cookie（例如名为 Set-Cookie2 的响应头字段）设置到 cookie 缓存中。

static void setDefault(CookieHandler cHandler)
          设置（或取消设置）系统级 cookie 处理程序。

从类 java.lang.Object 继承的方法

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法摘要
`CookieHandler()`

方法摘要
`abstract Map<String,List<String>>`	`get(URI uri, Map<String,List<String>> requestHeaders)` 从请求头中指定 uri 的 cookie 缓存中获取所有可用的 cookie。
`static CookieHandler`	`getDefault()` 获取系统级 cookie 处理程序。
`abstract void`	`put(URI uri, Map<String,List<String>> responseHeaders)` 将响应头中出现的所有可用 cookie（例如名为 Set-Cookie2 的响应头字段）设置到 cookie 缓存中。
`static void`	`setDefault(CookieHandler cHandler)` 设置（或取消设置）系统级 cookie 处理程序。

从类 java.lang.Object 继承的方法
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

构造方法详细信息

CookieHandler

public CookieHandler()

方法详细信息

getDefault

public static CookieHandler getDefault()

获取系统级 cookie 处理程序。

返回：: 系统级 cookie 处理程序；返回 null 表示当前没有设置任何系统级 cookie 处理程序。
抛出：: SecurityException - 如果安装了安全管理器并且它拒绝 NetPermission<tt>("getCookieHandler")</tt>
另请参见：: setDefault(CookieHandler)

setDefault

public static void setDefault(CookieHandler cHandler)

设置（或取消设置）系统级 cookie 处理程序。注：非标准 http 协议处理程序可能忽略此设置。

参数：: cHandler - HTTP cookie 处理程序；或者 <code>null</code>，表示取消设置。
抛出：: SecurityException - 如果安装了安全管理器并且它拒绝 NetPermission<tt>("setCookieHandler")</tt>
另请参见：: getDefault()

get

public abstract Map<String,List<String>> get(URI uri,
                                             Map<String,List<String>> requestHeaders)
                                      throws IOException

从请求头中指定 uri 的 cookie 缓存中获取所有可用的 cookie。 HTTP 协议实现程序应该确保在添加所有与选择 cookie 相关的请求头之后且在发送请求之前调用此方法。

参数：: uri - 作为请求中 cookie 发送目标的 <code>URI</code>; requestHeaders - 从请求头字段名到表示当前请求头的字段值列表的 Map
返回：: 从字段名为 "Cookie" 或 "Cookie2" 的状态管理头到包含状态信息的 cookie 列表的映射
抛出：: IOException - 如果发生 I/O * 错误; IllegalArgumentException - 如果其中任意一个参数为 null
另请参见：: put(URI, Map)

put

public abstract void put(URI uri,
                         Map<String,List<String>> responseHeaders)
                  throws IOException

将响应头中出现的所有可用 cookie（例如名为 Set-Cookie2 的响应头字段）设置到 cookie 缓存中。

参数：: uri - <code>URI</code>，cookie 来自其中; responseHeaders - 从字段名到表示返回的响应头字段的字段值列表的不可变映射
抛出：: IOException - 如果发生 I/O 错误; IllegalArgumentException - 如果其中任意一个参数为 null
另请参见：: get(URI, Map)