HttpCookie

HttpCookie

HttpCookie (String name, 
                String value)

构造一个具有指定名称和值的cookie。

该名称必须符合RFC 2965.这意味着它只能包含ASCII字母数字字符，不能包含逗号，分号或空格或以$字符开头。 Cookie的名称在创建后无法更改。

该值可以是服务器选择发送的任何内容。 它的价值可能只对服务器有意义。 使用setValue方法创建cookie后，可以更改cookie的值。

默认情况下，根据RFC 2965 cookie规范创建cookie。 该版本可以使用setVersion方法进行更改。

clone

Object clone ()

创建并返回此对象的副本。

domainMatches

boolean domainMatches (String domain, 
                String host)

检查主机名是否在域中的实用程序方法。

这个概念在cookie规范中有描述。 为了理解这个概念，首先需要定义一些术语：

effective host name = hostname if host name contains dot
                 or = hostname.local if not

在以下情况下，主机A的域名与主机B匹配：

• their host name strings string-compare equal; or
• A is a HDN string and has the form NB, where N is a non-empty name string, B has the form .B', and B' is a HDN string. (So, x.y.com domain-matches .Y.com but not Y.com.)

如果以下情况，主机不在域中（RFC 2965 sec。3.3.2）：

• The value for the Domain attribute contains no embedded dots, and the value is not .local.
• The effective host name that derives from the request-host does not domain-match the Domain attribute.
• The request-host is a HDN (not IP address) and has the form HD, where D is the value of the Domain attribute, and H is a string that contains one or more dots.

例子：

• A Set-Cookie2 from request-host y.x.foo.com for Domain=.foo.com would be rejected, because H is y.x and contains a dot.
• A Set-Cookie2 from request-host x.foo.com for Domain=.foo.com would be accepted.
• A Set-Cookie2 with Domain=.com or Domain=.com., will always be rejected, because there is no embedded dot.
• A Set-Cookie2 with Domain=ajax.com will be accepted, and the value for Domain will be taken to be .ajax.com, because a dot gets prepended to the value.
• A Set-Cookie2 from request-host example for Domain=.local will be accepted, because the effective host name for the request- host is example.local, and example.local domain-matches .local.

equals

boolean equals (Object obj)

测试两个http cookie的相等性。

仅当两个cookie来自同一个域（不区分大小写），具有相同名称（不区分大小写）并且路径相同（区分大小写）时，结果为 true 。

getComment

String getComment ()

返回描述此cookie用途的注释，如果cookie没有评论，则返回 null 。

getCommentURL

String getCommentURL ()

返回描述此cookie用途的注释url，如果cookie没有注释url，则返回 null 。

getDiscard

boolean getDiscard ()

返回cookie的丢弃属性

getDomain

String getDomain ()

返回为此cookie设置的域名。 域名的格式由RFC 2965设置。

getMaxAge

long getMaxAge ()

返回cookie的最大年龄，以秒为单位指定。 默认情况下，表示Cookie的-1将持续到浏览器关闭。

getName

String getName ()

返回cookie的名称。 该名称在创建后无法更改。

getPath

String getPath ()

返回浏览器返回此cookie的服务器上的路径。 该cookie对服务器上的所有子路径都可见。

getPortlist

String getPortlist ()

返回cookie的端口列表属性

getSecure

boolean getSecure ()

返回 true如果发送此cookie应该被限制在一个安全的协议，或者 false如果它可以使用任何协议发送。

getValue

String getValue ()

返回cookie的值。

getVersion

int getVersion ()

返回此cookie符合的协议版本。 版本1符合RFC 2965/2109，版本0符合由Netscape起草的原始cookie规范。 浏览器提供的Cookie使用并识别浏览器的Cookie版本。

hasExpired

boolean hasExpired ()

报告这个http cookie是否已过期。

hashCode

int hashCode ()

返回这个http cookie的哈希码。 结果是此Cookie的三个重要组件的哈希代码值的总和：名称，域和路径。 也就是说，哈希码是表达式的值：

getName().toLowerCase().hashCode()
+ getDomain().toLowerCase().hashCode()
+ getPath().hashCode()

isHttpOnly

boolean isHttpOnly ()

如果此cookie包含HttpOnly属性，则返回true 。 这意味着cookie不应该被JavaScript等脚本引擎访问。

parse

List<HttpCookie> parse (String header)

从set-cookie或set-cookie2标题字符串构造cookie。 RFC 2965第3.2.2节set-cookie2语法表明一个标题行可能包含多个cookie定义，因此这是一个静态实用程序方法，而不是另一个构造函数。

setComment

void setComment (String purpose)

指定描述cookie用途的注释。 如果浏览器向用户显示cookie，则该评论很有用。 Netscape版本0 cookie不支持评论。

setCommentURL

void setCommentURL (String purpose)

指定描述cookie用途的注释url。 如果浏览器向用户显示cookie，则注释网址很有用。 评论网址只是RFC 2965。

setDiscard

void setDiscard (boolean discard)

指定用户代理是否应无条件放弃Cookie。 这是RFC 2965唯一的属性。

setDomain

void setDomain (String pattern)

指定应在其中呈现此Cookie的域。

域名的格式由RFC 2965指定。域名以点开头（ .foo.com ），表示该cookie对指定域名系统（DNS）区域中的服务器可见（例如， www.foo.com ，但不包括a.b.foo.com ）。 默认情况下，Cookie只会返回给发送它们的服务器。

setHttpOnly

void setHttpOnly (boolean httpOnly)

指示Cookie是否应被视为仅HTTP。 如果设置为true这意味着cookie不应该可以通过JavaScript等脚本引擎访问。

setMaxAge

void setMaxAge (long expiry)

以秒为单位设置Cookie的最大使用年限。

一个正值表示该cookie将在经过许多秒后过期。 请注意，此值是Cookie到期时的最大年龄，而不是Cookie的当前年龄。

负值意味着cookie不会永久存储，并且在Web浏览器退出时将被删除。 零值会导致Cookie被删除。

setPath

void setPath (String uri)

指定客户端应该返回cookie的cookie的路径。

该Cookie对于您指定的目录中的所有页面以及该目录子目录中的所有页面均可见。 Cookie的路径必须包含设置cookie的servlet，例如/ catalog ，这使得cookie在/ catalog下的服务器上的所有目录都可见。

有关设置Cookie路径名的更多信息，请参阅RFC 2965（可在Internet上获得）。

setPortlist

void setPortlist (String ports)

指定cookie的portlist，该cookie限制Cookie可以在Cookie标头中发回的cookie的端口。

setSecure

void setSecure (boolean flag)

指示是否只应使用安全协议（例如HTTPS或SSL）发送Cookie。

默认值是 false 。

setValue

void setValue (String newValue)

创建cookie后，为cookie分配一个新值。 如果您使用二进制值，则可能需要使用BASE64编码。

使用版本0 cookie时，值不应在符号，冒号和分号中包含空格，括号，括号，等号，逗号，双引号，斜线，问号。 在所有浏览器上，空值的行为可能不尽相同。

setVersion

void setVersion (int v)

设置此cookie符合的cookie协议的版本。 版本0符合最初的Netscape cookie规范。 版本1符合RFC 2965/2109。

toString

String toString ()

构造此Cookie的Cookie头字符串表示形式，该形式采用相应的Cookie规范定义的格式，但没有前导的“Cookie：”标记。