public Class CookieWrapper

Constructs a cookie with a 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 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 Netscape 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

IllegalArgumentException:

if the cookie name contains illegal characters (for example, a comma, space, or semicolon) or it is one of the tokens reserved for use by the cookie protocol

See Also

setValue, setVersion

Annotations

@SuppressWarnings:UnusedDeclaration

Overrides org.glassfish.grizzly.http.Cookie.getComment.

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

Returns:String

a String containing the comment, or null if none

Annotations

@Override

See Also

setComment

Overrides org.glassfish.grizzly.http.Cookie.getDomain.

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

Returns:String

a String containing the domain name

Annotations

@Override

See Also

setDomain

Overrides org.glassfish.grizzly.http.Cookie.getMaxAge.

Returns the maximum age of the cookie, specified in seconds, By default, -1 indicating 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

Annotations

@Override

See Also

setMaxAge

Overrides org.glassfish.grizzly.http.Cookie.getName.

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

Returns:String

a String specifying the cookie's name

Annotations

@Override

Overrides org.glassfish.grizzly.http.Cookie.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

Annotations

@Override

See Also

setPath

Overrides org.glassfish.grizzly.http.Cookie.getValue.

Returns the value of the cookie.

Returns:String

a String containing the cookie's present value

Annotations

@Override

See Also

setValue, Cookie

Overrides org.glassfish.grizzly.http.Cookie.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:int

0 if the cookie complies with the original Netscape specification; 1 if the cookie complies with RFC 2109

Annotations

@Override

See Also

setVersion

Overrides org.glassfish.grizzly.http.Cookie.isHttpOnly.

Doc from org.glassfish.grizzly.http.Cookie.isHttpOnly.

HttpOnly feature is used in server->client communication only to let client know, that the cookie can not be accessed on the client-side (script etc). Returns true if this cookie is HTTP only, or false otherwise.

Annotations

@Override

Overrides org.glassfish.grizzly.http.Cookie.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:boolean

true if the browser uses a secure protocol; otherwise, true

Annotations

@Override

See Also

setSecure

Overrides org.glassfish.grizzly.http.Cookie.setComment.

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

Annotations

@Override

See Also

getComment

Overrides org.glassfish.grizzly.http.Cookie.setDomain.

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.

Parameters

pattern:String

a String containing the domain name within which this cookie is visible; form is according to RFC 2109

Annotations

@Override

See Also

getDomain

Overrides org.glassfish.grizzly.http.Cookie.setHttpOnly.

Doc from org.glassfish.grizzly.http.Cookie.setHttpOnly.

HttpOnly feature is used in server->client communication only to let client know, that the cookie can not be accessed on the client-side (script etc).

Annotations

@Override

Overrides org.glassfish.grizzly.http.Cookie.setMaxAge.

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

Annotations

@Override

See Also

getMaxAge

Overrides org.glassfish.grizzly.http.Cookie.setPath.

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.

Parameters

uri:String

a String specifying a path

Annotations

@Override

See Also

getPath

Overrides org.glassfish.grizzly.http.Cookie.setSecure.

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

Annotations

@Override

See Also

isSecure()

Overrides org.glassfish.grizzly.http.Cookie.setValue.

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

Annotations

@Override

See Also

getValue, Cookie

Overrides org.glassfish.grizzly.http.Cookie.setVersion.

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.

Since RFC 2109 is still somewhat new, consider version 1 as experimental; do not use it yet on production sites.

Parameters

v:int

0 if the cookie should comply with the original Netscape specification; 1 if the cookie should comply with RFC 2109

Annotations

@Override

See Also

getVersion