Added in API level 9

HttpCookie

class HttpCookie : Cloneable

kotlin.Any
↳	java.net.HttpCookie

An HttpCookie object represents an HTTP cookie, which carries state information between server and user agent. Cookie is widely adopted to create stateful sessions.

There are 3 HTTP cookie specifications:

Netscape draft
RFC 2109 - http://www.ietf.org/rfc/rfc2109.txt
RFC 2965 - http://www.ietf.org/rfc/rfc2965.txt

HttpCookie class can accept all these 3 forms of syntax.

Summary

Public constructors
HttpCookie(name: String!, value: String!) Constructs a cookie with a specified name and value.

Public methods
Any	clone() Create and return a copy of this object.
static Boolean	domainMatches(domain: String!, host: String!) The utility method to check whether a host name is in a domain or not.
Boolean	equals(other: Any?) Test the equality of two HTTP cookies.
String!	getComment() Returns the comment describing the purpose of this cookie, or null if the cookie has no comment.
String!	getCommentURL() Returns the comment URL describing the purpose of this cookie, or null if the cookie has no comment URL.
Boolean	getDiscard() Returns the discard attribute of the cookie
String!	getDomain() Returns the domain name set for this cookie.
Long	getMaxAge() Returns the maximum age of the cookie, specified in seconds.
String!	getName() Returns the name of the cookie.
String!	getPath() Returns the path on the server to which the browser returns this cookie.
String!	getPortlist() Returns the port list attribute of the cookie
Boolean	getSecure() Returns true if sending this cookie should be restricted to a secure protocol, or false if the it can be sent using any protocol.
String!	getValue() Returns the value of the cookie.
Int	getVersion() Returns the version of the protocol this cookie complies with.
Boolean	hasExpired() Reports whether this HTTP cookie has expired or not.
Int	hashCode() Returns the hash code of this HTTP cookie.
Boolean	isHttpOnly() Returns true if this cookie contains the HttpOnly attribute.
static MutableList<HttpCookie!>!	parse(header: String!) Constructs cookies from set-cookie or set-cookie2 header string.
Unit	setComment(purpose: String!) Specifies a comment that describes a cookie's purpose.
Unit	setCommentURL(purpose: String!) Specifies a comment URL that describes a cookie's purpose.
Unit	setDiscard(discard: Boolean) Specify whether user agent should discard the cookie unconditionally.
Unit	setDomain(pattern: String!) Specifies the domain within which this cookie should be presented.
Unit	setHttpOnly(httpOnly: Boolean) Indicates whether the cookie should be considered HTTP Only.
Unit	setMaxAge(expiry: Long) Sets the maximum age of the cookie in seconds.
Unit	setPath(uri: String!) Specifies a path for the cookie to which the client should return the cookie.
Unit	setPortlist(ports: String!) Specify the portlist of the cookie, which restricts the port(s) to which a cookie may be sent back in a Cookie header.
Unit	setSecure(flag: Boolean) Indicates whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
Unit	setValue(newValue: String!) Assigns a new value to a cookie after the cookie is created.
Unit	setVersion(v: Int) Sets the version of the cookie protocol this cookie complies with.
String	toString() 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.

Public constructors

HttpCookie

Added in API level 9

HttpCookie(
    name: String!, 
    value: String!)

Constructs a cookie with a specified name and value.

The name must conform to RFC 2965. That means it can contain only ASCII alphanumeric characters and cannot contain commas, semicolons, or white space or begin with a $ character. The cookie's name cannot be changed after creation.

The value can be anything the server chooses to send. Its value is probably of interest only to the server. The cookie's value can be changed after creation with the setValue method.

By default, cookies are created according to the RFC 2965 cookie specification. The version can be changed with the setVersion method.

Parameters
name	String!: a String specifying the name of the cookie
value	String!: a String specifying the value of the cookie

Exceptions
java.lang.IllegalArgumentException	if the cookie name contains illegal characters
java.lang.NullPointerException	if name is null

See Also

• #setValue
• #setVersion

Public methods

clone

Added in API level 9

fun clone(): Any

Create and return a copy of this object.

Return
Any	a clone of this HTTP cookie

Exceptions
java.lang.CloneNotSupportedException	if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

domainMatches

Added in API level 9

static fun domainMatches(
    domain: String!, 
    host: String!
): Boolean

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

Parameters
domain	String!: the domain name to check host name with
host	String!: the host name in question

Return
Boolean	true if they domain-matches; false if not

equals

Added in API level 9

fun equals(other: Any?): Boolean

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

Parameters
obj	the reference object with which to compare.

Return
Boolean	true if two HTTP cookies equal to each other; otherwise, false

getComment

Added in API level 9

fun getComment(): String!

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

Return
String!	a String containing the comment, or null if none

See Also

• #setComment

getCommentURL

Added in API level 9

fun getCommentURL(): String!

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

Return
String!	a String containing the comment URL, or null if none

See Also

• #setCommentURL

getDiscard

Added in API level 9

fun getDiscard(): Boolean

Returns the discard attribute of the cookie

Return
Boolean	a boolean to represent this cookie's discard attribute

See Also

• #setDiscard

getDomain

Added in API level 9

fun getDomain(): String!

Returns the domain name set for this cookie. The form of the domain name is set by RFC 2965.

Return
String!	a String containing the domain name

See Also

• #setDomain

getMaxAge

Added in API level 9

fun getMaxAge(): Long

Returns the maximum age of the cookie, specified in seconds. By default, -1 indicating the cookie will persist until browser shutdown.

Return
Long	an integer specifying the maximum age of the cookie in seconds

See Also

• #setMaxAge

getName

Added in API level 9

fun getName(): String!

Returns the name of the cookie. The name cannot be changed after creation.

Return
String!	a String specifying the cookie's name

getPath

Added in API level 9

fun getPath(): String!

Returns the path on the server to which the browser returns this cookie. The cookie is visible to all subpaths on the server.

Return
String!	a String specifying a path that contains a servlet name, for example, /catalog

See Also

• #setPath

getPortlist

Added in API level 9

fun getPortlist(): String!

Returns the port list attribute of the cookie

Return
String!	a String contains the port list or null if none

See Also

• #setPortlist

getSecure

Added in API level 9

fun getSecure(): Boolean

Returns true if sending this cookie should be restricted to a secure protocol, or false if the it can be sent using any protocol.

Return
Boolean	false if the cookie can be sent over any standard protocol; otherwise, true

See Also

• #setSecure

getValue

Added in API level 9

fun getValue(): String!

Returns the value of the cookie.

Return
String!	a String containing the cookie's present value

See Also

• #setValue

getVersion

Added in API level 9

fun getVersion(): Int

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.

Return
Int	0 if the cookie complies with the original Netscape specification; 1 if the cookie complies with RFC 2965/2109

See Also

• #setVersion

hasExpired

Added in API level 9

fun hasExpired(): Boolean

Reports whether this HTTP cookie has expired or not.

Return
Boolean	true to indicate this HTTP cookie has expired; otherwise, false

hashCode

Added in API level 9

fun hashCode(): Int

Returns the 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()

Return
Int	this HTTP cookie's hash code

isHttpOnly

Added in API level 24

fun isHttpOnly(): Boolean

Returns true if this cookie contains the HttpOnly attribute. This means that the cookie should not be accessible to scripting engines, like javascript.

Return
Boolean	true if this cookie should be considered HTTPOnly

See Also

• #setHttpOnly(boolean)

parse

Added in API level 9

static fun parse(header: String!): MutableList<HttpCookie!>!

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.

Parameters
header	String!: 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.

Return
MutableList<HttpCookie!>!	a List of cookie parsed from header line string

Exceptions
java.lang.IllegalArgumentException	if header string violates the cookie specification's syntax or the cookie name contains illegal characters.
java.lang.NullPointerException	if the header string is null

setComment

Added in API level 9

fun setComment(purpose: String!): Unit

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	String!: a String specifying the comment to display to the user

See Also

• #getComment

setCommentURL

Added in API level 9

fun setCommentURL(purpose: String!): Unit

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	String!: a String specifying the comment URL to display to the user

See Also

• #getCommentURL

setDiscard

Added in API level 9

fun setDiscard(discard: Boolean): Unit

Specify whether user agent should discard the cookie unconditionally. This is RFC 2965 only attribute.

Parameters
discard	Boolean: true indicates to discard cookie unconditionally

See Also

• #getDiscard

setDomain

Added in API level 9

fun setDomain(pattern: String!): Unit

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	String!: a String containing the domain name within which this cookie is visible; form is according to RFC 2965

See Also

• #getDomain

setHttpOnly

Added in API level 24

fun setHttpOnly(httpOnly: Boolean): Unit

Indicates whether the cookie should be considered HTTP Only. If set to true it means the cookie should not be accessible to scripting engines like javascript.

Parameters
httpOnly	Boolean: if true make the cookie HTTP only, i.e. only visible as part of an HTTP request.

See Also

• #isHttpOnly()

setMaxAge

Added in API level 9

fun setMaxAge(expiry: Long): Unit

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	Long: 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

• #getMaxAge

setPath

Added in API level 9

fun setPath(uri: String!): Unit

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	String!: a String specifying a path

See Also

• #getPath

setPortlist

Added in API level 9

fun setPortlist(ports: String!): Unit

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	String!: a String specify the port list, which is comma separated series of digits

See Also

• #getPortlist

setSecure

Added in API level 9

fun setSecure(flag: Boolean): Unit

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

The default value is false.

Parameters
flag	Boolean: If true, the cookie can only be sent over a secure protocol like HTTPS. If false, it can be sent over any protocol.

See Also

• #getSecure

setValue

Added in API level 9

fun setValue(newValue: String!): Unit

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	String!: a String specifying the new value

See Also

• #getValue

setVersion

Added in API level 9

fun setVersion(v: Int): Unit

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	Int: 0 if the cookie should comply with the original Netscape specification; 1 if the cookie should comply with RFC 2965/2109

Exceptions
java.lang.IllegalArgumentException	if v is neither 0 nor 1

See Also

• #getVersion

toString

Added in API level 9

fun toString(): String

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.

Return
String	a string form of the cookie. The string has the defined format