Summary: Ctors | Methods | Inherited Methods | [Expand All]

public final class

HttpCookie

extends Object
implements Cloneable

java.lang.Object
↳	java.net.HttpCookie

Class Overview

An opaque key-value value pair held by an HTTP client to permit a stateful session with an HTTP server. This class parses cookie headers for all three commonly used HTTP cookie specifications:

The Netscape cookie spec is officially obsolete but widely used in practice. Each cookie contains one key-value pair and the following attributes: Domain, Expires, Path, and Secure. The version of cookies in this format is 0.
There are no accessors for the Expires attribute. When parsed, expires attributes are assigned to the Max-Age attribute as an offset from now.
RFC 2109 formalizes the Netscape cookie spec. It replaces the Expires timestamp with a Max-Age duration and adds Comment and Version attributes. The version of cookies in this format is 1.
RFC 2965 refines RFC 2109. It adds Discard, Port, and CommentURL attributes and renames the header from Set-Cookie to Set-Cookie2. The version of cookies in this format is 1.

This implementation silently discards unrecognized attributes. In particular, the HttpOnly attribute is widely served but isn't in any of the above specs. It was introduced by Internet Explorer to prevent server cookies from being exposed in the DOM to JavaScript, etc.

Summary

Public Constructors
	HttpCookie(String name, String value) Creates a new cookie.

Public Methods
Object	clone() Creates and returns a copy of this `Object`.
static boolean	domainMatches(String domainPattern, String host) Returns true if `host` matches the domain pattern `domain`.
boolean	equals(Object object) Returns true if `object` is a cookie with the same domain, name and path.
String	getComment() Returns the `Comment` attribute.
String	getCommentURL() Returns the value of `CommentURL` attribute.
boolean	getDiscard() Returns the `Discard` attribute.
String	getDomain() Returns the `Domain` attribute.
long	getMaxAge() Returns the `Max-Age` attribute, in delta-seconds.
String	getName() Returns the name of this cookie.
String	getPath() Returns the `Path` attribute.
String	getPortlist() Returns the `Port` attribute, usually containing comma-separated port numbers.
boolean	getSecure() Returns the `Secure` attribute.
String	getValue() Returns the value of this cookie.
int	getVersion() Returns the version of this cookie.
boolean	hasExpired() Returns true if this cookie's Max-Age is 0.
int	hashCode() Returns the hash code of this HTTP cookie: `name.toLowerCase(Locale.US).hashCode() + (domain == null ? 0 : domain.toLowerCase(Locale.US).hashCode()) + (path == null ? 0 : path.hashCode())`
static List<HttpCookie>	parse(String header) Constructs a cookie from a string.
void	setComment(String comment) Set the `Comment` attribute of this cookie.
void	setCommentURL(String commentURL) Set the `CommentURL` attribute of this cookie.
void	setDiscard(boolean discard) Set the `Discard` attribute of this cookie.
void	setDomain(String pattern) Set the `Domain` attribute of this cookie.
void	setMaxAge(long deltaSeconds) Sets the `Max-Age` attribute of this cookie.
void	setPath(String path) Set the `Path` attribute of this cookie.
void	setPortlist(String portList) Set the `Port` attribute of this cookie.
void	setSecure(boolean secure) Sets the `Secure` attribute of this cookie.
void	setValue(String value) Sets the opaque value of this cookie.
void	setVersion(int v) Sets the `Version` attribute of the cookie.
String	toString() Returns a string representing this cookie in the format used by the `Cookie` header line in an HTTP request.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

name	a non-empty string that contains only printable ASCII, no commas or semicolons, and is not prefixed with `$`. May not be an HTTP attribute name.
value	an opaque value from the HTTP server.

domainPattern	a host name (like `android.com` or `localhost`), or a pattern to match subdomains of a domain name (like `.android.com`). A special case pattern is `.local`, which matches all hosts without a TLD (like `localhost`).
host	the host name or IP address from an HTTP request.

IllegalArgumentException	if the string does not comply with cookie specification, or the cookie name contains illegal characters, or reserved tokens of cookie specification appears
NullPointerException	if header is null

Interfaces

Classes

Enums

Exceptions

HttpCookie

Class Overview

Summary

Public Constructors

public HttpCookie (String name, String value)

Parameters

Throws

Public Methods

public Object clone ()

Returns

public static boolean domainMatches (String domainPattern, String host)

Parameters

public boolean equals (Object object)

Parameters

Returns

public String getComment ()

public String getCommentURL ()

public boolean getDiscard ()

public String getDomain ()

public long getMaxAge ()

public String getName ()

public String getPath ()

public String getPortlist ()

public boolean getSecure ()

public String getValue ()

public int getVersion ()

public boolean hasExpired ()

public int hashCode ()

Returns

public static List<HttpCookie> parse (String header)

Parameters

Returns

Throws

public void setComment (String comment)

public void setCommentURL (String commentURL)

public void setDiscard (boolean discard)

public void setDomain (String pattern)

public void setMaxAge (long deltaSeconds)

public void setPath (String path)

public void setPortlist (String portList)

public void setSecure (boolean secure)

public void setValue (String value)

public void setVersion (int v)

Throws

public String toString ()

Returns