net.groboclown.util.http.v1
Class Cookie

java.lang.Object
  |
  +--net.groboclown.util.http.v1.Cookie

All Implemented Interfaces:

IHttpClientState

public class Cookie

extends Object

implements IHttpClientState

Java implementation of RFC 2109 and the Netscape cookie specification.

Note that attributes (names and values) are case insensitive.

Since:

Alpha 0.9.1

Version:

Alpha 0.9.1

Author:

Matt Albrecht

Field Summary

private String	comment
private String	domain
private int	maxAge
private String	name
private String	path
private boolean	secure
private long	startTime
private static String	TSPECIALS
private String	value
private int	version

Constructor Summary

Cookie(String name, String value)
Constructs a cookie with a specified name and value.

Method Summary

String	getComment() Returns the comment describing the purpose of this cookie, or null if the cookie has no comment.
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.
String	getName() Returns the name of the cookie.
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.
String	getValue() Returns the value of the cookie.
int	getVersion() Returns the version of the protocol this cookie complies with.
boolean	isExpired() Checks if the cookie has expired, and hence needs to be removed from the server.
protected boolean	isToken(String value)
protected void	maybeQuote(int version, StringBuffer buf, String value) Quote the given value iff the version is not 0 and the value is not a token.
boolean	receiveSecurityCheck(IHttpResponseMessage msg) Checks if this cookie, which was loaded from the header of the given message, passes all security checks for the given set command by the server.
boolean	sendSecurityCheck(URL server) Checks if the given URL that this cookie is being passed to correctly passes all security checks.
void	setComment(String purpose) Specifies a comment that describes a cookie's purpose.
void	setDomain(String pattern) Specifies the domain within which this cookie should be presented.
void	setMaxAge(int expiry) Sets the maximum age of the cookie in seconds.
protected void	setName(String name)
void	setPath(String uri) Specifies a path for the cookie to which the client should return the cookie.
void	setSecure(boolean flag) Indicates to the browser whether the cookie should only be sent using a secure protocol, such as HTTPS or SSL.
void	setValue(String newValue) Assigns a new value to a cookie after the cookie is created.
void	setVersion(int v) Sets the version of the cookie protocol this cookie complies with.
String	toString()
String	toString(boolean append, boolean serverSet) Converts this cookie to a header-compatible string.

Methods inherited from class java.lang.Object

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

Field Detail

name

private String name

value

private String value

comment

private String comment

domain

private String domain

maxAge

private int maxAge

startTime

private long startTime

path

private String path

secure

private boolean secure

version

private int version

TSPECIALS

private static final String TSPECIALS

Constructor Detail

Cookie

public Cookie(String name,
              String value)

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 - a String specifying the name of the cookie

value - a String specifying the value of the cookie

Throws:

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(java.lang.String), setVersion(int)

Method Detail

sendSecurityCheck

public boolean sendSecurityCheck(URL server)

Checks if the given URL that this cookie is being passed to correctly passes all security checks. Expiration should be checked externally to this function.

Specified by:

sendSecurityCheck in interface IHttpClientState

Parameters:

server - the URL that this cookie is being sent to.

Returns:

true if the security considerations all check out, or false if the check fails verification.

See Also:

receiveSecurityCheck( IHttpResponseMessage ), isExpired()

receiveSecurityCheck

public boolean receiveSecurityCheck(IHttpResponseMessage msg)

Checks if this cookie, which was loaded from the header of the given message, passes all security checks for the given set command by the server. It may fill in any up-to-now unspecified security settings.

Specified by:

receiveSecurityCheck in interface IHttpClientState

isExpired

public boolean isExpired()

Checks if the cookie has expired, and hence needs to be removed from the server.

Specified by:

isExpired in interface IHttpClientState

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean append,
                       boolean serverSet)

Converts this cookie to a header-compatible string. It adds any necessary separator to the beginning of the string if append is true.

Specified by:

toString in interface IHttpClientState

Parameters:

append - true if this cookie is to be appended to the end of another cookie on the same header.

serverSet - true if this cookie is for the server to send to the client, or false if this cookie is being sent back to the server by the client.

setComment

public void setComment(String purpose)

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 - a String specifying the comment to display to the user

See Also:

getComment()

getComment

public 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

See Also:

setComment(java.lang.String)

setDomain

public void setDomain(String pattern)

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 - a String containing the domain name within which this cookie is visible; form is according to RFC 2109

See Also:

getDomain()

getDomain

public 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

See Also:

setDomain(java.lang.String)

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

See Also:

getMaxAge()

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

See Also:

setMaxAge(int)

setPath

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

Parameters:

uri - a String specifying a path

See Also:

getPath()

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

See Also:

setPath(java.lang.String)

setSecure

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

See Also:

getSecure()

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 can use any standard protocol; otherwise, false

See Also:

setSecure(boolean)

getName

public String getName()

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

Specified by:

getName in interface IHttpClientState

Returns:

a String specifying the cookie's name

setValue

public void setValue(String newValue)

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.

Specified by:

setValue in interface IHttpClientState

Parameters:

newValue - a String specifying the new value

See Also:

getValue(), Cookie

getValue

public String getValue()

Returns the value of the cookie.

Specified by:

getValue in interface IHttpClientState

Returns:

a String containing the cookie's present value

See Also:

setValue(java.lang.String), 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

See Also:

setVersion(int)

setVersion

public void setVersion(int v)

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 - 0 if the cookie should comply with the original Netscape specification; 1 if the cookie should comply with RFC 2109

See Also:

getVersion()

setName

protected void setName(String name)

maybeQuote

protected void maybeQuote(int version,
                          StringBuffer buf,
                          String value)

Quote the given value iff the version is not 0 and the value is not a token.

isToken

protected boolean isToken(String value)