com.elasticpath.xpf.connectivity.entity

Class XPFHttpCookie

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFHttpCookie

public class XPFHttpCookie
extends Object

Represents an HTTP cookie, which is a small piece of data that a server sends to a user's web browser. The browser may store the cookie and send it back to the same server with subsequent requests.

Constructor Summary

Constructors

Constructor and Description
XPFHttpCookie(String comment, String domain, int maxAge, String name, String path, boolean secure, boolean httpOnly, String value, int version)

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getComment() Returns the comment describing the purpose of this cookie, or null if the cookie has no comment.
String	getDomain() Gets the domain name of this Cookie.
int	getMaxAge() Gets the maximum age in seconds of this Cookie.
String	getName() Returns the name of the cookie.
String	getPath() Returns the path on the server to which the browser returns this cookie.
String	getValue() Gets the current value of this Cookie.
int	getVersion() Returns the version of the protocol this cookie complies with.
int	hashCode()
boolean	isHttpOnly() Marks or unmarks this Cookie as HttpOnly.
boolean	isSecure() Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XPFHttpCookie

public XPFHttpCookie(String comment,
                     String domain,
                     int maxAge,
                     String name,
                     String path,
                     boolean secure,
                     boolean httpOnly,
                     String value,
                     int version)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getComment

public String getComment()

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

Returns:

the comment of the cookie, or null if unspecified

getDomain

public String getDomain()

Gets the domain name of this Cookie.

Domain names are formatted according to RFC 2109.

Returns:

the domain name of this Cookie

getMaxAge

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:

an integer specifying the maximum age of the cookie in seconds; if negative, means the cookie persists until browser shutdown

getName

public String getName()

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

Returns:

the name of the cookie

getPath

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:

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

isSecure

public boolean isSecure()

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 uses a secure protocol, false otherwise

isHttpOnly

public boolean isHttpOnly()

Marks or unmarks this Cookie as HttpOnly.

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

Since:

Servlet 3.0

getValue

public String getValue()

Gets the current value of this Cookie.

Returns:

the current value of this Cookie

getVersion

public int getVersion()

Returns the version of the protocol this cookie complies with. Version 1 complies with RFC 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 2109