Create and return a copy of this object.

  Create and return a copy of this object.
Returns: a clone of this http cookie

  The utility method to check whether a host name is in a domain or not.

  The utility method to check whether a host name is in a domain or not.

This concept is described in the cookie specification. To understand the concept, some terminologies need to be defined first:

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

Host A's name domain-matches host B's if:

• 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.)

A host isn't in a domain (RFC 2965 sec. 3.3.2) if:

• 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.

Examples:

• 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.

Returns: true if they domain-matches; false if not
Parameters:
- domain - the domain name to check host name with
- host - the host name in question

  Test the equality of two http cookies.

  Test the equality of two http cookies.

The result is true only if two cookies come from same domain (case-insensitive), have same name (case-insensitive), and have same path (case-sensitive).
Returns: true if 2 http cookies equal to each other; otherwise, false

  Returns the comment describing the purpose of this cookie, or null if the cookie has no comment.

  Returns the comment describing the purpose of this cookie, or
null if the cookie has no comment.
Returns: a String containing the comment, or null if none
See Also: HttpCookie.setComment(java.lang.String),

  Returns the comment url describing the purpose of this cookie, or null if the cookie has no comment url.

  Returns the comment url describing the purpose of this cookie, or
null if the cookie has no comment url.
Returns: a String containing the comment url, or null if none
See Also: HttpCookie.setCommentURL(java.lang.String),

  Return the discard attribute of the cookie

  Return the discard attribute of the cookie
Returns: a boolean to represent this cookie's discard attribute
See Also: HttpCookie.setDiscard(boolean),

  Returns the domain name set for this cookie.

  Returns the domain name set for this cookie. The form of
the domain name is set by RFC 2965.
Returns: a String containing the domain name
See Also: HttpCookie.setDomain(java.lang.String),

  Returns the maximum age of the cookie, specified in seconds.

  Returns the maximum age of the cookie, specified in seconds.
By default, -1 indicating the cookie will persist
until browser shutdown.
Returns: an integer specifying the maximum age of the cookie in seconds
See Also: HttpCookie.setMaxAge(long),

  Returns the name of the cookie.

  Returns the name of the cookie. The name cannot be changed after
creation.
Returns: a String specifying the cookie's name

  Returns the path on the server to which the browser returns this cookie.

  Returns the path on the server
to which the browser returns this cookie. The
cookie is visible to all subpaths on the server.
Returns: a String specifying a path that contains a servlet name, for example, /catalog
See Also: HttpCookie.setPath(java.lang.String),

  Return the port list attribute of the cookie

  Return the port list attribute of the cookie
Returns: a String contains the port list or null if none
See Also: HttpCookie.setPortlist(java.lang.String),

  Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.

  Returns true if the browser is sending cookies
only over a secure protocol, or false if the
browser can send cookies using any protocol.
Returns: true if the browser can use any standard protocol; otherwise, false
See Also: HttpCookie.setSecure(boolean),

  Returns the value of the cookie.

  Returns the value of the cookie.
Returns: a String containing the cookie's present value
See Also: HttpCookie.setValue(java.lang.String),

  Returns the version of the protocol this cookie complies with.

  Returns the version of the protocol this cookie complies
with. Version 1 complies with RFC 2965/2109,
and version 0 complies with the original
cookie specification drafted by Netscape. Cookies provided
by a browser use and identify the browser's cookie version.
Returns: 0 if the cookie complies with the original Netscape specification; 1 if the cookie complies with RFC 2965/2109
See Also: HttpCookie.setVersion(int),

  Reports whether this http cookie has expired or not.

  Reports whether this http cookie has expired or not.
Returns: true to indicate this http cookie has expired; otherwise, false

  Return hash code of this http cookie.

  Return hash code of this http cookie. The result is the sum of
hash code value of three significant components of this cookie:
name, domain, and path.
That is, the hash code is the value of the expression:

getName().toLowerCase().hashCode()

+ getDomain().toLowerCase().hashCode()

+ getPath().hashCode()

Returns: this http cookie's hash code

  Constructs cookies from set-cookie or set-cookie2 header string.

  Constructs cookies from set-cookie or set-cookie2 header string.
RFC 2965 section 3.2.2 set-cookie2 syntax indicates that one header line
may contain more than one cookie definitions, so this is a static
utility method instead of another constructor.
Returns: a List of cookie parsed from header line string
Parameters:
- header - a String specifying the set-cookie header. The header should start with "set-cookie", or "set-cookie2" token; or it should have no leading token at all.
Throws:
- IllegalArgumentException - if header string violates the cookie specification's syntax, or the cookie name contains llegal characters, or the cookie name is one of the tokens reserved for use by the cookie protocol
- NullPointerException - if the header string is null

  Specifies a comment that describes a cookie's purpose.

  Specifies a comment that describes a cookie's purpose.
The comment is useful if the browser presents the cookie
to the user. Comments
are not supported by Netscape Version 0 cookies.
Parameters:
- purpose - a String specifying the comment to display to the user
See Also: HttpCookie.getComment(),

  Specifies a comment url that describes a cookie's purpose.

  Specifies a comment url that describes a cookie's purpose.
The comment url is useful if the browser presents the cookie
to the user. Comment url is RFC 2965 only.
Parameters:
- purpose - a String specifying the comment url to display to the user
See Also: HttpCookie.getCommentURL(),

  Specify whether user agent should discard the cookie unconditionally.

  Specify whether user agent should discard the cookie unconditionally.
This is RFC 2965 only attribute.
Parameters:
- discard - true indicates to discard cookie unconditionally
See Also: HttpCookie.getDiscard(),

  Specifies the domain within which this cookie should be presented.

  Specifies the domain within which this cookie should be presented.

The form of the domain name is specified by RFC 2965. A domain name begins with a dot (.foo.com) and means that the cookie is visible to servers in a specified Domain Name System (DNS) zone (for example, www.foo.com, but not a.b.foo.com). By default, cookies are only returned to the server that sent them.
Parameters:
- pattern - a String containing the domain name within which this cookie is visible; form is according to RFC 2965
See Also: HttpCookie.getDomain(),

  Sets the maximum age of the cookie in seconds.

  Sets the maximum age of the cookie in seconds.

A positive value indicates that the cookie will expire after that many seconds have passed. Note that the value is the maximum age when the cookie will expire, not the cookie's current age.

A negative value means that the cookie is not stored persistently and will be deleted when the Web browser exits. A zero value causes the cookie to be deleted.
Parameters:
- expiry - an integer specifying the maximum age of the cookie in seconds; if zero, the cookie should be discarded immediately; otherwise, the cookie's max age is unspecified.
See Also: HttpCookie.getMaxAge(),

  Specifies a path for the cookie to which the client should return the cookie.

  Specifies a path for the cookie to which the client should return the cookie.

The cookie is visible to all the pages in the directory you specify, and all the pages in that directory's subdirectories. A cookie's path must include the servlet that set the cookie, for example, /catalog, which makes the cookie visible to all directories on the server under /catalog.

Consult RFC 2965 (available on the Internet) for more information on setting path names for cookies.
Parameters:
- uri - a String specifying a path
See Also: HttpCookie.getPath(),

  Specify the portlist of the cookie, which restricts the port(s) to which a cookie may be sent back in a Cookie header.

  Specify the portlist of the cookie, which restricts the port(s)
to which a cookie may be sent back in a Cookie header.
Parameters:
- ports - a String specify the port list, which is comma seperated series of digits
See Also: HttpCookie.getPortlist(),

  Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.

  Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.

The default value is false.
Parameters:
- flag - if true, sends the cookie from the browser to the server using only when using a secure protocol; if false, sent on any protocol
See Also: HttpCookie.getSecure(),

  Assigns a new value to a cookie after the cookie is created.

  Assigns a new value to a cookie after the cookie is created. If you use a binary value, you may want to use BASE64 encoding.

With Version 0 cookies, values should not contain white space, brackets, parentheses, equals signs, commas, double quotes, slashes, question marks, at signs, colons, and semicolons. Empty values may not behave the same way on all browsers.
Parameters:
- newValue - a String specifying the new value
See Also: HttpCookie.getValue(),

  Sets the version of the cookie protocol this cookie complies with.

  Sets the version of the cookie protocol this cookie complies
with. Version 0 complies with the original Netscape cookie
specification. Version 1 complies with RFC 2965/2109.
Parameters:
- v - 0 if the cookie should comply with the original Netscape specification; 1 if the cookie should comply with RFC 2965/2109
Throws:
- IllegalArgumentException - if v is neither 0 nor 1
See Also: HttpCookie.getVersion(),

  Constructs a cookie header string representation of this cookie, which is in the format defined by corresponding cookie specification, but without the leading "Cookie:" token.

  Constructs a cookie header string representation of this cookie,
which is in the format defined by corresponding cookie specification,
but without the leading "Cookie:" token.
Returns: a string form of the cookie. The string has the defined format