| org.apache.commons.httpclient.Cookie
| Cookie | | public class Cookie extends NameValuePair implements Serializable,Comparator(Code) | |
HTTP "magic-cookie" represents a piece of state information
that the HTTP agent and the target server can exchange to maintain
a session.
author:
B.C. Holmes
author:
Park, Sung-Gu
author:
Doug Sale
author:
Rod Waldhoff
author:
dIon Gillard
author:
Sean C. Sullivan
author:
John Evans
author:
Marc A. Saegesser
author:
Oleg Kalnichevski
author:
Mike Bowler
version:
$Revision: 4672 $ $Date: 2006-09-27 00:03:16 +0000 (Wed, 27 Sep 2006) $ |
| Field Summary | |
| final public static char | DOMAIN_OVERBOUNDS
Character which, if appended to end of a domain, will give a
boundary key that sorts past all Cookie sortKeys for the same
domain. |
| Constructor Summary | |
| public | Cookie()
Default constructor. | | public | Cookie(String domain, String name, String value)
Creates a cookie with the given name, value and domain attribute. | | public | Cookie(String domain, String name, String value, String path, Date expires, boolean secure)
| | public | 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
Parameters:
name - the cookie name
Parameters:
value - the cookie value
Parameters:
domain - the domain this cookie can be sent to
Parameters:
path - the path prefix for which this cookie can be sent
Parameters:
maxAge - the number of seconds for which this cookie is valid.maxAge is expected to be a non-negative number. |
| Method Summary | |
| public int | compare(Object o1, Object o2)
Compares two cookies to determine order for cookie header.
Most specific should be first. | | public boolean | equals(Object obj)
Two cookies are equal if the name, path and domain match.
Parameters:
obj - The object to compare against. | | public String | getComment()
Returns the comment describing the purpose of this cookie, or
null if no such comment has been defined. | | public String | getDomain()
Returns domain attribute of the cookie. | | public Date | getExpiryDate()
Returns the expiration
Date of the cookie, or null
if none exists.
Note: the object returned by this method is
considered immutable. | | public String | getPath()
| | public boolean | getSecure()
| | public String | getSortKey()
Create a 'sort key' for this Cookie that will cause it to sort
alongside other Cookies of the same domain (with or without leading
'.'). | | public int | getVersion()
Returns the version of the cookie specification to which this
cookie conforms. | | public int | hashCode()
Returns a hash code in keeping with the
Object.hashCode general hashCode contract. | | public boolean | isDomainAttributeSpecified()
Returns true if cookie's domain was set via a domain
attribute in the Set-Cookie header. | | public boolean | isExpired()
Returns true if this cookie has expired. | | public boolean | isExpired(Date now)
Returns true if this cookie has expired according to the time passed in.
Parameters:
now - The current time. | | public boolean | isPathAttributeSpecified()
Returns true if cookie's path was set via a path attribute
in the Set-Cookie header. | | public boolean | isPersistent()
Returns false if the cookie should be discarded at the end
of the "session"; true otherwise. | | public 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. | | public void | setDomain(String domain)
Sets the domain attribute. | | public void | setDomainAttributeSpecified(boolean value)
Indicates whether the cookie had a domain specified in a
domain attribute of the Set-Cookie header. | | public void | setExpiryDate(Date expiryDate)
Sets expiration date.
Note: the object returned by this method is considered
immutable. | | public void | setPath(String path)
Sets the path attribute. | | public void | setPathAttributeSpecified(boolean value)
Indicates whether the cookie had a path specified in a
path attribute of the Set-Cookie header. | | public void | setSecure(boolean secure)
Sets the secure attribute of the cookie.
When true the cookie should only be sent
using a secure protocol (https). | | public void | setVersion(int version)
Sets the version of the cookie specification to which this
cookie conforms. | | public String | toExternalForm()
Return a textual representation of the cookie. | | public String | toString()
Return a textual representation of the cookie. |
| DOMAIN_OVERBOUNDS | | final public static char DOMAIN_OVERBOUNDS(Code) | | Character which, if appended to end of a domain, will give a
boundary key that sorts past all Cookie sortKeys for the same
domain.
|
| Cookie | | public Cookie()(Code) | | Default constructor. Creates a blank cookie
|
| Cookie | | public Cookie(String domain, String name, String value)(Code) | | Creates a cookie with the given name, value and domain attribute.
Parameters:
name - the cookie name
Parameters:
value - the cookie value
Parameters:
domain - the domain this cookie can be sent to |
| Cookie | | public Cookie(String domain, String name, String value, String path, Date expires, boolean secure)(Code) | | Creates a cookie with the given name, value, domain attribute,
path attribute, expiration attribute, and secure attribute
Parameters:
name - the cookie name
Parameters:
value - the cookie value
Parameters:
domain - the domain this cookie can be sent to
Parameters:
path - the path prefix for which this cookie can be sent
Parameters:
expires - the Date at which this cookie expires,or null if the cookie expires at the endof the session
Parameters:
secure - if true this cookie can only be sent over secureconnections
throws:
IllegalArgumentException - If cookie name is null or blank,cookie name contains a blank, or cookie name starts with character $ |
| Cookie | | public Cookie(String domain, String name, String value, String path, int maxAge, boolean secure)(Code) | | Creates a cookie with the given name, value, domain attribute,
path attribute, maximum age attribute, and secure attribute
Parameters:
name - the cookie name
Parameters:
value - the cookie value
Parameters:
domain - the domain this cookie can be sent to
Parameters:
path - the path prefix for which this cookie can be sent
Parameters:
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.
Parameters:
secure - if true this cookie can only be sent over secureconnections |
| compare | | public int compare(Object o1, Object o2)(Code) | | 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
Parameters:
o2 - The second object to be compared See java.util.Comparator.compare(ObjectObject) |
| equals | | public boolean equals(Object obj)(Code) | | Two cookies are equal if the name, path and domain match.
Parameters:
obj - The object to compare against. true if the two objects are equal. |
| getComment | | public String getComment()(Code) | | Returns the comment describing the purpose of this cookie, or
null if no such comment has been defined.
comment
See Also: Cookie.setComment(String) |
| getExpiryDate | | public Date getExpiryDate()(Code) | | Returns the expiration
Date of the cookie, or null
if none exists.
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.
Expiration Date, or null.
See Also: Cookie.setExpiryDate(java.util.Date) |
| getSortKey | | public String getSortKey()(Code) | | Create a 'sort key' for this Cookie that will cause it to sort
alongside other Cookies of the same domain (with or without leading
'.'). This helps cookie-match checks consider only narrow set of
possible matches, rather than all cookies.
Only two cookies that are equals() (same domain, path, name) will have
the same sort key. The '\1' separator character is important in
conjunction with Cookie.DOMAIN+OVERBOUNDS, allowing keys based on the
domain plus an extension to define the relevant range in a SortedMap.
String sort key for this cookie |
| getVersion | | public int getVersion()(Code) | | Returns the version of the cookie specification to which this
cookie conforms.
the version of the cookie.
See Also: Cookie.setVersion(int) |
| hashCode | | public int hashCode()(Code) | | Returns a hash code in keeping with the
Object.hashCode general hashCode contract.
A hash code |
| isDomainAttributeSpecified | | public boolean isDomainAttributeSpecified()(Code) | | Returns true if cookie's domain was set via a domain
attribute in the Set-Cookie header.
value true if the cookie's domain was explicitly set, false otherwise.
See Also: Cookie.setDomainAttributeSpecified |
| isExpired | | public boolean isExpired()(Code) | | Returns true if this cookie has expired.
true if the cookie has expired. |
| isExpired | | public boolean isExpired(Date now)(Code) | | Returns true if this cookie has expired according to the time passed in.
Parameters:
now - The current time. true if the cookie expired. |
| isPathAttributeSpecified | | public boolean isPathAttributeSpecified()(Code) | | Returns true if cookie's path was set via a path attribute
in the Set-Cookie header.
value true if the cookie's path was explicitly set, false otherwise.
See Also: Cookie.setPathAttributeSpecified |
| isPersistent | | public boolean isPersistent()(Code) | | Returns false if the cookie should be discarded at the end
of the "session"; true otherwise.
false if the cookie should be discarded at the endof the "session"; true otherwise |
| setComment | | public void setComment(String comment)(Code) | | If a user agent (web browser) presents this cookie to a user, the
cookie's purpose will be described using this comment.
Parameters:
comment -
See Also: Cookie.getComment() |
| setDomain | | public void setDomain(String domain)(Code) | | Sets the domain attribute.
Parameters:
domain - The value of the domain attribute
See Also: Cookie.getDomain |
| setDomainAttributeSpecified | | public void setDomainAttributeSpecified(boolean value)(Code) | | Indicates whether the cookie had a domain specified in a
domain attribute of the Set-Cookie header. This value
is important for generating the Cookie header because
some cookie specifications require that the Cookie header
should only include a domain attribute if the cookie's domain
was specified in the Set-Cookie header.
Parameters:
value - true if the cookie's domain was explicitly set, false otherwise.
See Also: Cookie.isDomainAttributeSpecified |
| setExpiryDate | | public void setExpiryDate(Date expiryDate)(Code) | | Sets expiration date.
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.getExpiryDate |
| setPath | | public void setPath(String path)(Code) | | Sets the path attribute.
Parameters:
path - The value of the path attribute
See Also: Cookie.getPath |
| setPathAttributeSpecified | | public void setPathAttributeSpecified(boolean value)(Code) | | Indicates whether the cookie had a path specified in a
path attribute of the Set-Cookie header. This value
is important for generating the Cookie header because
some cookie specifications require that the Cookie header
should only include a path attribute if the cookie's path
was specified in the Set-Cookie header.
Parameters:
value - true if the cookie's path was explicitly set, false otherwise.
See Also: Cookie.isPathAttributeSpecified |
| setSecure | | public void setSecure(boolean secure)(Code) | | Sets the secure attribute of the 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: Cookie.getSecure() |
| setVersion | | public void setVersion(int version)(Code) | | Sets the version of the cookie specification to which this
cookie conforms.
Parameters:
version - the version of the cookie.
See Also: Cookie.getVersion |
| toExternalForm | | public String toExternalForm()(Code) | | Return a textual representation of the cookie.
string. |
|
|