org.apache.commons.httpclient
public class Cookie extends NameValuePair implements Serializable, Comparator
HTTP "magic-cookie" represents a piece of state information that the HTTP agent and the target server can exchange to maintain a session.
Version: $Revision: 157457 $ $Date: 2005-03-14 15:23:16 -0500 (Mon, 14 Mar 2005) $
Constructor Summary | |
---|---|
Cookie()
Default constructor. | |
Cookie(String domain, String name, String value)
Creates a cookie with the given name, value and domain attribute.
| |
Cookie(String domain, String name, String value, String path, Date expires, boolean secure)
Creates a cookie with the given name, value, domain attribute,
path attribute, expiration attribute, and secure attribute
| |
Cookie(String domain, String name, String value, String path, int maxAge, boolean secure)
Creates a cookie with the given name, value, domain attribute,
path attribute, maximum age attribute, and secure attribute
|
Method Summary | |
---|---|
int | compare(Object o1, Object o2) Compares two cookies to determine order for cookie header. Most specific should be first. |
boolean | equals(Object obj)
Two cookies are equal if the name, path and domain match. |
String | getComment()
Returns the comment describing the purpose of this cookie, or
null if no such comment has been defined.
|
String | getDomain()
Returns domain attribute of the cookie.
|
Date | getExpiryDate()
Returns the expiration Date of the cookie, or null
if none exists.
|
String | getPath()
Returns the path attribute of the cookie
|
boolean | getSecure() |
int | getVersion()
Returns the version of the cookie specification to which this
cookie conforms.
|
int | hashCode()
Returns a hash code in keeping with the
Object#hashCode general hashCode contract. |
boolean | isDomainAttributeSpecified()
Returns true if cookie's domain was set via a domain
attribute in the Set-Cookie header.
|
boolean | isExpired()
Returns true if this cookie has expired.
|
boolean | isExpired(Date now)
Returns true if this cookie has expired according to the time passed in.
|
boolean | isPathAttributeSpecified()
Returns true if cookie's path was set via a path attribute
in the Set-Cookie header.
|
boolean | isPersistent()
Returns false if the cookie should be discarded at the end
of the "session"; true otherwise.
|
void | setComment(String comment)
If a user agent (web browser) presents this cookie to a user, the
cookie's purpose will be described using this comment.
|
void | setDomain(String domain)
Sets the domain attribute.
|
void | setDomainAttributeSpecified(boolean value)
Indicates whether the cookie had a domain specified in a
domain attribute of the Set-Cookie header. |
void | setExpiryDate(Date expiryDate)
Sets expiration date.
|
void | setPath(String path)
Sets the path attribute.
|
void | setPathAttributeSpecified(boolean value)
Indicates whether the cookie had a path specified in a
path attribute of the Set-Cookie header. |
void | setSecure(boolean secure)
Sets the secure attribute of the cookie.
|
void | setVersion(int version)
Sets the version of the cookie specification to which this
cookie conforms.
|
String | toExternalForm()
Return a textual representation of the cookie.
|
String | toString()
Return a textual representation of the cookie.
|
Parameters: name the cookie name value the cookie value domain the domain this cookie can be sent to
Parameters: name the cookie name value the cookie value domain the domain this cookie can be sent to path the path prefix for which this cookie can be sent expires the Date at which this cookie expires, or null if the cookie expires at the end of the session secure if true this cookie can only be sent over secure connections
Throws: IllegalArgumentException If cookie name is null or blank, cookie name contains a blank, or cookie name starts with character $
Parameters: name the cookie name value the cookie value domain the domain this cookie can be sent to path the path prefix for which this cookie can be sent maxAge the number of seconds for which this cookie is valid. maxAge is expected to be a non-negative number. -1 signifies that the cookie should never expire. secure if true this cookie can only be sent over secure connections
Compares two cookies to determine order for cookie header.
Most specific should be first.
This method is implemented so a cookie can be used as a comparator for a SortedSet of cookies. Specifically it's used above in the createCookieHeader method.
Parameters: o1 The first object to be compared o2 The second object to be compared
Returns: See java.util.Comparator#compare(Object,Object)
Parameters: obj The object to compare against.
Returns: true if the two objects are equal.
Returns: comment
See Also: setComment
Returns: the value of the domain attribute
See Also: Cookie
Note: the object returned by this method is considered immutable. Changing it (e.g. using setTime()) could result in undefined behaviour. Do so at your peril.
Returns: Expiration Date, or null.
Returns: The value of the path attribute.
See Also: Cookie
Returns: true
if this cookie should only be sent over secure connections.
See Also: Cookie
Returns: the version of the cookie.
Returns: A hash code
Returns: value true if the cookie's domain was explicitly set, false otherwise.
See Also: Cookie
Returns: true if the cookie has expired.
Parameters: now The current time.
Returns: true if the cookie expired.
Returns: value true if the cookie's path was explicitly set, false otherwise.
See Also: Cookie
Returns: false if the cookie should be discarded at the end of the "session"; true otherwise
Parameters: comment
See Also: getComment
Parameters: domain The value of the domain attribute
See Also: Cookie
Parameters: value true if the cookie's domain was explicitly set, false otherwise.
See Also: Cookie
Note: the object returned by this method is considered immutable. Changing it (e.g. using setTime()) could result in undefined behaviour. Do so at your peril.
Parameters: expiryDate the Date after which this cookie is no longer valid.
See Also: Cookie
Parameters: path The value of the path attribute
See Also: Cookie
Parameters: value true if the cookie's path was explicitly set, false otherwise.
See Also: Cookie
When true the cookie should only be sent using a secure protocol (https). This should only be set when the cookie's originating server used a secure protocol to set the cookie's value.
Parameters: secure The value of the secure attribute
See Also: getSecure
Parameters: version the version of the cookie.
See Also: Cookie
Returns: string.
Returns: string.
See Also: Cookie