EE4J 10.0.0 · jakarta.servlet.http.Cookie

Modifier and Type	Field and Description
private Map<String, String>	attributes
private static final String	DOMAIN
private static final String	HTTP_ONLY
private static final String	LSTRING_FILE
private static final ResourceBundle	lStrings
private static final String	MAX_AGE
private final String	name
private static final String	PATH
private static final String	SECURE
private static final long	serialVersionUID
private static final String	TSPECIALS
private String	value

Access	Constructor and Description
public	Cookie(String the name of the cookie name, String the value of the cookie value) Constructs a cookie with the specified name and value.

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides java.lang.Object.clone. Overrides the standard `java.lang.Object.clone` method to return a copy of this Cookie.
private static String	createErrorMessage(String key, Object... arguments)
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	Returns: the value of the cookie attribute associated with the given name getAttribute(String the name of the cookie attribute to get the value of, case insensitive name) Gets the value of the cookie attribute associated with the given name.
public Map<String, String>	Returns: an unmodifiable mapping of all cookie attributes set via `setAttribute(String, String)` as well as any predefined setter method, except for `version` getAttributes() Returns an unmodifiable mapping of all cookie attributes set via `setAttribute(String, String)` as well as any predefined setter method, except for `version`.
public String	Returns: Always `null` getComment() Deprecated for removal since Servlet 6.0. This is no longer required with RFC 6265 With the adoption of support for RFC 6265, this method should no longer be used.
public String	Returns: the domain name of this Cookie getDomain() Gets the domain name of this Cookie.
public int	Returns: an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie persists until browser shutdown getMaxAge() Gets the maximum age in seconds of this Cookie.
public String	Returns: the name of the cookie getName() Returns the name of the cookie.
public String	Returns: a `String` specifying a path that contains a servlet name, for example, /catalog getPath() Returns the path on the server to which the browser returns this cookie.
public boolean	Returns: `true` if the browser uses a secure protocol, `false` otherwise getSecure() Returns `true` if the browser is sending cookies only over a secure protocol, or `false` if the browser can send cookies using any protocol.
public String	Returns: the current value of this Cookie getValue() Gets the current value of this Cookie.
public int	Returns: Always 0 getVersion() Deprecated for removal since Servlet 6.0. This is no longer required with RFC 6265 With the adoption of support for RFC 6265, this method should no longer be used.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
private static boolean	hasReservedCharacters(String value)
public boolean	Returns: true if this Cookie has been marked as HttpOnly, false otherwise isHttpOnly() Checks whether this Cookie has been marked as HttpOnly.
private void	putAttribute(String name, String value)
public void	setAttribute(String the name of the cookie attribute to set the value for, case insensitive name, String the value of the cookie attribute associated with the given name, can be `null` value) Sets the value of the cookie attribute associated with the given name.
public void	setComment(String This parameter is ignored purpose) Deprecated for removal since Servlet 6.0. This is no longer required with RFC 6265 With the adoption of support for RFC 6265, this method should no longer be used.
public void	setDomain(String the domain name within which this cookie is visible; form is according to RFC 6265 domain) Specifies the domain within which this cookie should be presented.
public void	setHttpOnly(boolean true if this cookie is to be marked as HttpOnly, false otherwise httpOnly) Marks or unmarks this Cookie as HttpOnly.
public void	setMaxAge(int an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes the cookie expiry) Sets the maximum age in seconds for this Cookie.
public void	setPath(String a `String` specifying a path uri) Specifies a path for the cookie to which the client should return the cookie.
public void	setSecure(boolean if `true`, sends the cookie from the browser to the server only when using a secure protocol; if `false`, sent on any protocol flag) Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
public void	setValue(String the new value of the cookie newValue) Assigns a new value to this Cookie.
public void	setVersion(int This parameter is ignored v) Deprecated for removal since Servlet 6.0. This is no longer required with RFC 6265 With the adoption of support for RFC 6265, this method should no longer be used.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: finalize getClass notify notifyAll wait wait wait

attributes	back to summary
private Map<String, String> attributes

DOMAIN	back to summary
private static final String DOMAIN

HTTP_ONLY	back to summary
private static final String HTTP_ONLY

LSTRING_FILE	back to summary
private static final String LSTRING_FILE

lStrings	back to summary
private static final ResourceBundle lStrings

MAX_AGE	back to summary
private static final String MAX_AGE

name	back to summary
private final String name

PATH	back to summary
private static final String PATH

SECURE	back to summary
private static final String SECURE

serialVersionUID	back to summary
private static final long serialVersionUID

TSPECIALS	back to summary
private static final String TSPECIALS

value	back to summary
private String value

Method Detail

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Overrides the standard `java.lang.Object.clone` method to return a copy of this Cookie. Returns:Object Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

public Object clone()

Overrides java.lang.Object.clone.

Overrides the standard java.lang.Object.clone method to return a copy of this Cookie.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

createErrorMessage	back to summary
private static String createErrorMessage(String key, Object... arguments)

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAttribute back to summary

getAttribute	back to summary
public String getAttribute(String name) Gets the value of the cookie attribute associated with the given name. This should sync to any predefined attribute for which already a getter/setter pair exist in the current version, except for `version`. E.g. when `cookie.setAttribute("domain", domain)` is invoked, then `cookie.getDomain()` should return exactly that value, and vice versa. Parameters name:String the name of the cookie attribute to get the value of, case insensitive Returns:String the value of the cookie attribute associated with the given name Since Servlet 6.0

public String getAttribute(String name)

Gets the value of the cookie attribute associated with the given name.

This should sync to any predefined attribute for which already a getter/setter pair exist in the current version, except for version. E.g. when cookie.setAttribute("domain", domain) is invoked, then cookie.getDomain() should return exactly that value, and vice versa.

Parameters

name:String: the name of the cookie attribute to get the value of, case insensitive

Returns:String

the value of the cookie attribute associated with the given name

Since

Servlet 6.0

getAttributes back to summary

getAttributes	back to summary
public Map<String, String> getAttributes() Returns an unmodifiable mapping of all cookie attributes set via `setAttribute(String, String)` as well as any predefined setter method, except for `version`. Returns:Map<String, String> an unmodifiable mapping of all cookie attributes set via `setAttribute(String, String)` as well as any predefined setter method, except for `version` Since Servlet 6.0

public Map<String, String> getAttributes()

Returns an unmodifiable mapping of all cookie attributes set via setAttribute(String, String) as well as any predefined setter method, except for version.

Returns:Map<String, String>: an unmodifiable mapping of all cookie attributes set via setAttribute(String, String) as well as any predefined setter method, except for version
Since: Servlet 6.0

getComment back to summary

getComment	back to summary
public String getComment() Deprecated for removal since Servlet 6.0. This is no longer required with RFC 6265 With the adoption of support for RFC 6265, this method should no longer be used. Returns:String Always `null` Annotations @Deprecated since:Servlet 6.0 forRemoval:true See Also `setComment`

public String getComment()

Deprecated

for removal since Servlet 6.0.

This is no longer required with RFC 6265

With the adoption of support for RFC 6265, this method should no longer be used.

Returns:String

Always null

Annotations

@Deprecated
since:Servlet 6.0
forRemoval:true

See Also

setComment

getDomain back to summary

getDomain	back to summary
public String getDomain() Gets the domain name of this Cookie. Domain names are formatted according to RFC 6265. Returns:String the domain name of this Cookie See Also `setDomain`

public String getDomain()

Gets the domain name of this Cookie.

Domain names are formatted according to RFC 6265.

Returns:String: the domain name of this Cookie
See Also: setDomain

getMaxAge back to summary

getMaxAge	back to summary
public int getMaxAge() Gets the maximum age in seconds of this Cookie. By default, `-1` is returned, which indicates that the cookie will persist until browser shutdown. Returns:int an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie persists until browser shutdown See Also `setMaxAge`

public int getMaxAge()

Gets the maximum age in seconds of this Cookie.

By default, -1 is returned, which indicates that the cookie will persist until browser shutdown.

Returns:int: an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie persists until browser shutdown
See Also: setMaxAge

getName	back to summary
public String getName() Returns the name of the cookie. The name cannot be changed after creation. Returns:String the name of the cookie

getName

back to summary

public String getName()

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

Returns:String: the name of the cookie

getPath back to summary

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

public String getPath()

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

Returns:String: a String specifying a path that contains a servlet name, for example, /catalog
See Also: setPath

getSecure back to summary

getSecure	back to summary
public boolean getSecure() 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:boolean `true` if the browser uses a secure protocol, `false` otherwise See Also `setSecure`

public boolean getSecure()

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:boolean: true if the browser uses a secure protocol, false otherwise
See Also: setSecure

getValue back to summary

getValue	back to summary
public String getValue() Gets the current value of this Cookie. Returns:String the current value of this Cookie See Also `setValue`

public String getValue()

Gets the current value of this Cookie.

Returns:String: the current value of this Cookie
See Also: setValue

getVersion back to summary

getVersion	back to summary
public int getVersion() Deprecated for removal since Servlet 6.0. This is no longer required with RFC 6265 With the adoption of support for RFC 6265, this method should no longer be used. Returns:int Always 0 Annotations @Deprecated since:Servlet 6.0 forRemoval:true See Also `setVersion`

public int getVersion()

Deprecated

for removal since Servlet 6.0.

This is no longer required with RFC 6265

With the adoption of support for RFC 6265, this method should no longer be used.

Returns:int

Always 0

Annotations

@Deprecated
since:Servlet 6.0
forRemoval:true

See Also

setVersion

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

hasReservedCharacters	back to summary
private static boolean hasReservedCharacters(String value)

isHttpOnly	back to summary
public boolean isHttpOnly() Checks whether this Cookie has been marked as HttpOnly. Returns:boolean true if this Cookie has been marked as HttpOnly, false otherwise Since Servlet 3.0

isHttpOnly

back to summary

public boolean isHttpOnly()

Checks whether this Cookie has been marked as HttpOnly.

Returns:boolean: true if this Cookie has been marked as HttpOnly, false otherwise
Since: Servlet 3.0

putAttribute	back to summary
private void putAttribute(String name, String value)

setAttribute back to summary

setAttribute	back to summary
public void setAttribute(String name, String value) Sets the value of the cookie attribute associated with the given name. This should sync to any predefined attribute for which already a getter/setter pair exist in the current version, except for `version`. E.g. when `cookie.setAttribute("domain", domain)` is invoked, then `cookie.getDomain()` should return exactly that value, and vice versa. Parameters name:String the name of the cookie attribute to set the value for, case insensitive value:String the value of the cookie attribute associated with the given name, can be `null` Exceptions IllegalArgumentException: if the cookie name is null or empty or contains any illegal characters (for example, a comma, space, or semicolon) or matches a token reserved for use by the cookie protocol. NumberFormatException: if the cookie is a known field with a numerical value (eg Max-Age), but the value is not able to be parsed. Since Servlet 6.0

public void setAttribute(String name, String value)

Sets the value of the cookie attribute associated with the given name.

Parameters

name:String: the name of the cookie attribute to set the value for, case insensitive
value:String: the value of the cookie attribute associated with the given name, can be null

Exceptions

IllegalArgumentException:: if the cookie name is null or empty or contains any illegal characters (for example, a comma, space, or semicolon) or matches a token reserved for use by the cookie protocol.
NumberFormatException:: if the cookie is a known field with a numerical value (eg Max-Age), but the value is not able to be parsed.

Since

Servlet 6.0

setComment back to summary

setComment	back to summary
public void setComment(String purpose) Deprecated for removal since Servlet 6.0. This is no longer required with RFC 6265 With the adoption of support for RFC 6265, this method should no longer be used. If called, this method has no effect. Parameters purpose:String This parameter is ignored Annotations @Deprecated since:Servlet 6.0 forRemoval:true See Also `getComment`

public void setComment(String purpose)

Deprecated

for removal since Servlet 6.0.

This is no longer required with RFC 6265

With the adoption of support for RFC 6265, this method should no longer be used.

If called, this method has no effect.

Parameters

purpose:String: This parameter is ignored

Annotations

@Deprecated
since:Servlet 6.0
forRemoval:true

See Also

getComment

setDomain back to summary

setDomain	back to summary
public void setDomain(String domain) Specifies the domain within which this cookie should be presented. The form of the domain name is specified by RFC 6265. 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 domain:String the domain name within which this cookie is visible; form is according to RFC 6265 See Also `getDomain`

public void setDomain(String domain)

Specifies the domain within which this cookie should be presented.

The form of the domain name is specified by RFC 6265. 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

domain:String: the domain name within which this cookie is visible; form is according to RFC 6265

See Also

getDomain

setHttpOnly back to summary

setHttpOnly	back to summary
public void setHttpOnly(boolean httpOnly) Marks or unmarks this Cookie as HttpOnly. If `httpOnly` is set to `true`, this cookie is marked as HttpOnly, by adding the `HttpOnly` attribute to it. HttpOnly cookies are not supposed to be exposed to client-side scripting code, and may therefore help mitigate certain kinds of cross-site scripting attacks. Parameters httpOnly:boolean true if this cookie is to be marked as HttpOnly, false otherwise Since Servlet 3.0

public void setHttpOnly(boolean httpOnly)

Marks or unmarks this Cookie as HttpOnly.

If httpOnly is set to true, this cookie is marked as HttpOnly, by adding the HttpOnly attribute to it.

HttpOnly cookies are not supposed to be exposed to client-side scripting code, and may therefore help mitigate certain kinds of cross-site scripting attacks.

Parameters

httpOnly:boolean: true if this cookie is to be marked as HttpOnly, false otherwise

Since

Servlet 3.0

setMaxAge back to summary

setMaxAge	back to summary
public void setMaxAge(int expiry) Sets the maximum age in seconds for this Cookie. 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:int an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes the cookie See Also `getMaxAge`

public void setMaxAge(int expiry)

Sets the maximum age in seconds for this Cookie.

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:int: an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie is not stored; if zero, deletes the cookie

See Also

getMaxAge

setPath back to summary

setPath	back to summary
public void setPath(String uri) 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 6265 for more information on setting path names for cookies. Parameters uri:String a `String` specifying a path See Also `getPath`

public void setPath(String uri)

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 6265 for more information on setting path names for cookies.

Parameters

uri:String: a String specifying a path

See Also

getPath

setSecure back to summary

setSecure	back to summary
public void setSecure(boolean flag) 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:boolean if `true`, sends the cookie from the browser to the server only when using a secure protocol; if `false`, sent on any protocol See Also `getSecure`

public void setSecure(boolean flag)

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:boolean: if true, sends the cookie from the browser to the server only when using a secure protocol; if false, sent on any protocol

See Also

getSecure

setValue back to summary

setValue	back to summary
public void setValue(String newValue) Assigns a new value to this Cookie. 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 the new value of the cookie See Also `getValue`

public void setValue(String newValue)

Assigns a new value to this Cookie.

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: the new value of the cookie

See Also

getValue

setVersion back to summary

setVersion	back to summary
public void setVersion(int v) Deprecated for removal since Servlet 6.0. This is no longer required with RFC 6265 With the adoption of support for RFC 6265, this method should no longer be used. If called, this method has no effect. Parameters v:int This parameter is ignored Annotations @Deprecated since:Servlet 6.0 forRemoval:true See Also `getVersion`

public void setVersion(int v)

Deprecated

for removal since Servlet 6.0.

This is no longer required with RFC 6265

With the adoption of support for RFC 6265, this method should no longer be used.

If called, this method has no effect.

Parameters

v:int: This parameter is ignored

Annotations

@Deprecated
since:Servlet 6.0
forRemoval:true

See Also

getVersion

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations