org.apache.http.cookie

Interface CookieSpec

所有已知实现类：

AbstractCookieSpec ， BestMatchSpec ， BrowserCompatSpec ， CookieSpecBase ， DefaultCookieSpec ， IgnoreSpec ， NetscapeDraftSpec ， RFC2109Spec ， RFC2965Spec ， RFC6265CookieSpec ， RFC6265LaxSpec ， RFC6265StrictSpec

public interface CookieSpec

定义cookie管理规范。

Cookie管理规范必须定义

• 解析“Set-Cookie”标题的规则
• 已解析的Cookie的验证规则
• 格式化“Cookie”头

对于给定的主机，端口和起源路径

请不要使用标记为@Obsolete的方法。 它们被RFC 6265废弃了。

从以下版本开始：

4

方法摘要

Methods

Modifier and Type	Method and Description
List<Header>	formatCookies(List<Cookie> cookies) 为Cookie数组创建 "Cookie"标题。
int	getVersion() 返回该cookie规范符合的状态管理版本。
Header	getVersionHeader() 返回一个标识什么版本的状态管理规范被理解的请求头。
boolean	match(Cookie cookie, CookieOrigin origin) 确定Cookie是否与目标位置匹配。
List<Cookie>	parse(Header header, CookieOrigin origin) 将 "Set-Cookie"标题解析成一个Cookie数组。
void	validate(Cookie cookie, CookieOrigin origin) 根据cookie规范定义的验证规则验证cookie。

方法详细信息

getVersion

@Obsolete
int getVersion()

返回该cookie规范符合的状态管理版本。

结果

版本的状态管理规范

parse

List<Cookie> parse(Header header,
                 CookieOrigin origin)
                   throws MalformedCookieException

将"Set-Cookie"标题解析成一组Cookie。

该方法将不会对所得的Cookie进行验证

参数

header - 从服务器收到的 Set-Cookie

origin - cookie起源的细节

结果

从标题中解析出 Cookie的数组

异常

MalformedCookieException - 解析时是否发生异常

另请参见：

validate(org.apache.http.cookie.Cookie, org.apache.http.cookie.CookieOrigin)

validate

void validate(Cookie cookie,
            CookieOrigin origin)
              throws MalformedCookieException

根据cookie规范定义的验证规则验证cookie。

参数

cookie - 要验证的Cookie

origin - cookie起源的细节

异常

MalformedCookieException - 如果cookie无效

match

boolean match(Cookie cookie,
            CookieOrigin origin)

确定Cookie是否与目标位置匹配。

参数

cookie - 要匹配的Cookie

origin - 测试对象的目标

结果

true如果cookie应该提交具有给定属性的请求，否则为 false 。

formatCookies

List<Header> formatCookies(List<Cookie> cookies)

为Cookie数组创建 "Cookie"标题。

参数

cookies - 将Cookie格式转换为Cookie标题

结果

给定Cookie的标题。

异常

IllegalArgumentException - 输入参数是否为非法

getVersionHeader

@Obsolete
Header getVersionHeader()

返回一个标识什么版本的状态管理规范被理解的请求头。 如果cookie规范不支持Cookie2标题，可以是null 。