com.wedeploy.api.sdk

Class Cookie

java.lang.Object

com.wedeploy.api.sdk.Cookie

public class Cookie
extends java.lang.Object

Cookie object. Simple cookie data holder, cookie header parser and generator.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Cookie(java.lang.String cookie) Parses cookie data from given user-agent string.
protected	Cookie(java.lang.String name, java.lang.String value) Creates cookie with specified name and value.

Method Summary

Modifier and Type	Method and Description
java.lang.String	comment() Returns the comment describing the purpose of this cookie, or null if the cookie has no comment.
Cookie	comment(java.lang.String comment) Specifies a comment that describes a cookie's purpose.
static Cookie	cookie(java.lang.String cookie) Create a new cookie.
static Cookie	cookie(java.lang.String name, java.lang.String value) Create a new cookie.
java.lang.String	domain() Returns the domain name set for this cookie.
Cookie	domain(java.lang.String domain) Specifies the domain within which this cookie should be presented.
java.lang.String	encode() Encode the cookie to a string.
java.lang.String	expires() Gets expires date.
Cookie	expires(java.lang.String expires) Sets expires date.
boolean	httpOnly() If this cookie is HTTP only.
Cookie	httpOnly(boolean httpOnly) Determines if this cookie is HTTP only.
java.lang.Long	maxAge() Returns the maximum age of the cookie, specified in seconds, By default, -1 indicating the cookie will persist until browser shutdown.
Cookie	maxAge(java.lang.Long maxAge) Sets the maximum age of the cookie in seconds.
java.lang.String	name() Returns the name of the cookie.
Cookie	name(java.lang.String name) Sets the cookie name and checks for validity.
java.lang.String	path() Returns the path on the server to which the browser returns this cookie.
Cookie	path(java.lang.String path) Specifies a path for the cookie to which the client should return the cookie.
boolean	secure() Returns true if the browser is sending cookies only over a secure protocol, or false if the browser can send cookies using any protocol.
Cookie	secure(boolean secure) Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
java.lang.String	value() Returns the value of the cookie.
Cookie	value(java.lang.String value) Assigns a new value to a cookie after the cookie is created.
java.lang.Integer	version() Returns the version of the protocol this cookie complies with.
Cookie	version(java.lang.Integer version) Sets the version of the cookie protocol this cookie complies with.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Cookie

protected Cookie(java.lang.String cookie)

Parses cookie data from given user-agent string.

Cookie

protected Cookie(java.lang.String name,
                 java.lang.String value)

Creates cookie with specified name and value.

The name must conform to RFC 2109. That means it can contain only ASCII alphanumeric characters and cannot contain commas, semicolons, or white space or begin with a $ character.

The value can be anything the server chooses to send.

Method Detail

cookie

public static Cookie cookie(java.lang.String cookie)

Create a new cookie.

Parameters:

cookie - The encoded string of the cookie.

Returns:

The cookie.

cookie

public static Cookie cookie(java.lang.String name,
                            java.lang.String value)

Create a new cookie.

Parameters:

name - The name of the cookie.

value - The cookie value.

Returns:

The cookie.

comment

public java.lang.String comment()

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

comment

public Cookie comment(java.lang.String comment)

Specifies a comment that describes a cookie's purpose. The comment is useful if the browser presents the cookie to the user.

domain

public java.lang.String domain()

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

domain

public Cookie domain(java.lang.String domain)

Specifies the domain within which this cookie should be presented.

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

encode

public java.lang.String encode()

Encode the cookie to a string. This is what is used in the Set-Cookie header.

expires

public java.lang.String expires()

Gets expires date.

expires

public Cookie expires(java.lang.String expires)

Sets expires date. Indicates when the cookie should no longer be sent to the server and therefore may be deleted by the browser.

httpOnly

public boolean httpOnly()

If this cookie is HTTP only.

httpOnly

public Cookie httpOnly(boolean httpOnly)

Determines if this cookie is HTTP only. If set to true, this cookie cannot be accessed by a client side script. However, this works only if the browser supports it. For for information, please look here.

Parameters:

httpOnly - True if the cookie is HTTP only, otherwise false.

maxAge

public java.lang.Long maxAge()

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

maxAge

public Cookie maxAge(java.lang.Long maxAge)

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.

name

public java.lang.String name()

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

name

public Cookie name(java.lang.String name)

Sets the cookie name and checks for validity.

path

public java.lang.String path()

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

path

public Cookie path(java.lang.String path)

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 2109 (available on the Internet) for more information on setting path names for cookies.

secure

public boolean secure()

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

secure

public Cookie secure(boolean secure)

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

value

public java.lang.String value()

Returns the value of the cookie.

value

public Cookie value(java.lang.String value)

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.

version

public java.lang.Integer version()

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.

version

public Cookie version(java.lang.Integer version)

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