HTTPClient
Class Cookie2

java.lang.Object
  |
  +--HTTPClient.Cookie
        |
        +--HTTPClient.Cookie2

All Implemented Interfaces:

java.io.Serializable

public class Cookie2

extends Cookie

This class represents an http cookie as specified in the HTTP State Management Mechanism spec (also known as a version 1 cookie).

Since:

V0.3

See Also:

Serialized Form

Constructor Summary

Cookie2(java.lang.String name, java.lang.String value, java.lang.String domain, int[] port_list, java.lang.String path, java.util.Date expires, boolean discard, boolean secure, java.lang.String comment, URI comment_url)
Create a cookie.

Method Summary

boolean	discard()
java.lang.String	getComment()
URI	getCommentURL()
int[]	getPorts()
int	getVersion()
java.lang.String	toString() Create a string containing all the cookie fields.

Methods inherited from class HTTPClient.Cookie

equals, expires, getDomain, getName, getPath, getValue, hasExpired, hashCode, isSecure

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Cookie2

public Cookie2(java.lang.String name,
               java.lang.String value,
               java.lang.String domain,
               int[] port_list,
               java.lang.String path,
               java.util.Date expires,
               boolean discard,
               boolean secure,
               java.lang.String comment,
URI comment_url)

Create a cookie.

Parameters:

name - the cookie name

value - the cookie value

domain - the host this cookie will be sent to

port_list - an array of allowed server ports for this cookie, or null if the the cookie may be sent to any port

path - the path prefix for which this cookie will be sent

expires - the Date this cookie expires, or null if never

discard - if true then the cookie will be discarded at the end of the session regardless of expiry

secure - if true this cookie will only be over secure connections

comment - the comment associated with this cookie, or null if none

comment_url - the comment URL associated with this cookie, or null if none

Throws:

java.lang.NullPointerException - if name, value, domain, or path is null

Method Detail

getVersion

public int getVersion()

Returns:

the version as an int

getComment

public java.lang.String getComment()

Returns:

the comment string, or null if none was set

getCommentURL

public URI getCommentURL()

Returns:

the comment url

getPorts

public int[] getPorts()

Returns:

the array of ports

discard

public boolean discard()

Overrides:

discard in class Cookie

Returns:

true if the cookie should be discarded at the end of the session; false otherwise

toString

public java.lang.String toString()

Create a string containing all the cookie fields. The format is that used in the Set-Cookie header.

Overrides:

toString in class Cookie