de.oio.bugkilla.protocol
Class Cookie

java.lang.Object
  |
  +--de.oio.bugkilla.protocol.Cookie

All Implemented Interfaces:

java.io.Serializable

public class Cookie

extends java.lang.Object

implements java.io.Serializable

The Cookie store all Informations for one Cookie

Author:

swinkler, cdedek

See Also:

Serialized Form

Constructor Summary

Cookie()
Construct a new Cookie

Cookie(java.lang.String name)
Construct a new Cookie with a specified Name

Method Summary

java.lang.String	getComment() Returns the comment describing the purpose of this cookie, or null if the cookie has no comment.
java.lang.String	getDomain() Returns the domain name set for this cookie.
int	getMaxAge() Returns the maximum age of the cookie, specified in seconds, By default, -1 indicating the cookie will persist until browser shutdown.
java.lang.String	getName() Returns the name of the Cookie
java.lang.String	getPath() Returns the path on the server to which the browser returns this cookie.
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.
java.lang.String	getValue() Returns the value of the cookie
int	getVersion() Returns the version of the protocol this cookie complies with.
void	setComment(java.lang.String comment) Specifies a comment that describes a cookie's purpose.
void	setDomain(java.lang.String domain) Specifies the domain within which this cookie should be presented.
void	setMaxAge(int expiry) Sets the maximum age of the cookie in seconds.
void	setName(java.lang.String name) Sets the name of the Cookie
void	setPath(java.lang.String path) Specifies a path for the cookie to which the client should return the cookie.
void	setSecure(boolean isSecure) Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
void	setValue(java.lang.String value) Assigns a new value to a cookie after the cookie is created.
void	setVersion(int 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

public Cookie(java.lang.String name)

Construct a new Cookie with a specified Name

Parameters:

name - name of the Cookie

Cookie

public Cookie()

Construct a new Cookie

Method Detail

getComment

public java.lang.String getComment()

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

Returns:

a String containing the comment, or null if none

setComment

public void setComment(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. Comments are not supported by Netscape Version 0 cookies.

Parameters:

comment - a String specifying the comment to display to the user

getDomain

public java.lang.String getDomain()

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

Returns:

a String containing the domain name

setDomain

public void setDomain(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.

Parameters:

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

getMaxAge

public int getMaxAge()

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

setMaxAge

public void setMaxAge(int expiry)

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

getPath

public java.lang.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

setPath

public void setPath(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.

Parameters:

path - - a String specifying a path

getSecure

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:

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

setSecure

public void setSecure(boolean isSecure)

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:

isSecure - if true, sends the cookie from the browser to the server using only when using a secure protocol; if false, sent on any protocol

getValue

public java.lang.String getValue()

Returns the value of the cookie

Returns:

a String containing the cookie's present value

setValue

public void setValue(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.
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:

value - - a String specifying the new value

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

setVersion

public void setVersion(int 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.
Since RFC 2109 is still somewhat new, consider version 1 as experimental; do not use it yet on production sites.

Parameters:

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

getName

public java.lang.String getName()

Returns the name of the Cookie

Returns:

the name of the Cookie

setName

public void setName(java.lang.String name)

Sets the name of the Cookie

Parameters:

name - the name of the Cookie