| org.apache.http.cookie.Cookie |
 Known Indirect Subclasses
| BasicClientCookie |
HTTP "magic-cookie" represents a piece of state information
that the HTTP agent and the target server can exchange to maintain
a session. |
| BasicClientCookie2 |
HTTP "magic-cookie" represents a piece of state information
that the HTTP agent and the target server can exchange to maintain
a session as specified by RFC2965. |
| ClientCookie |
ClientCookie extends the standard Cookie interface with
additional client specific functionality such ability to retrieve
original cookie attributes exactly as they were specified by the
origin server. |
| SetCookie |
This interface represents a SetCookie response header sent by the
origin server to the HTTP agent in order to maintain a conversational state. |
| SetCookie2 |
This interface represents a SetCookie2 response header sent by the
origin server to the HTTP agent in order to maintain a conversational state. |
|
Class Overview
HTTP "magic-cookie" represents a piece of state information
that the HTTP agent and the target server can exchange to maintain
a session.
Summary
| Public Methods |
|---|
|
abstract
String
|
getComment()
Returns the comment describing the purpose of this cookie, or
null if no such comment has been defined.
|
|
abstract
String
|
getCommentURL()
If a user agent (web browser) presents this cookie to a user, the
cookie's purpose will be described by the information at this URL.
|
|
abstract
String
|
getDomain()
Returns domain attribute of the cookie.
|
|
abstract
Date
|
getExpiryDate()
Returns the expiration Date of the cookie, or null
if none exists. |
|
abstract
String
|
getName()
Returns the name.
|
|
abstract
String
|
getPath()
Returns the path attribute of the cookie
|
|
abstract
int[]
|
getPorts()
Get the Port attribute.
|
|
abstract
String
|
getValue()
Returns the value.
|
|
abstract
int
|
getVersion()
Returns the version of the cookie specification to which this
cookie conforms.
|
|
abstract
boolean
|
isExpired(Date date)
Returns true if this cookie has expired.
|
|
abstract
boolean
|
isPersistent()
Returns false if the cookie should be discarded at the end
of the "session"; true otherwise.
|
|
abstract
boolean
|
isSecure()
Indicates whether this cookie requires a secure connection.
|
Public Methods
public
abstract
String
getComment
()
Returns the comment describing the purpose of this cookie, or
null if no such comment has been defined.
public
abstract
String
getCommentURL
()
If a user agent (web browser) presents this cookie to a user, the
cookie's purpose will be described by the information at this URL.
public
abstract
String
getDomain
()
Returns domain attribute of the cookie.
Returns
- the value of the domain attribute
public
abstract
Date
getExpiryDate
()
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.
Returns
- Expiration Date, or null.
public
abstract
String
getName
()
public
abstract
String
getPath
()
Returns the path attribute of the cookie
Returns
- The value of the path attribute.
public
abstract
int[]
getPorts
()
Get the Port attribute. It restricts the ports to which a cookie
may be returned in a Cookie request header.
public
abstract
String
getValue
()
Returns
- String value The current value.
public
abstract
int
getVersion
()
Returns the version of the cookie specification to which this
cookie conforms.
Returns
- the version of the cookie.
public
abstract
boolean
isExpired
(Date date)
Returns true if this cookie has expired.
Returns
- true if the cookie has expired.
public
abstract
boolean
isPersistent
()
Returns false if the cookie should be discarded at the end
of the "session"; true otherwise.
Returns
- false if the cookie should be discarded at the end
of the "session"; true otherwise
public
abstract
boolean
isSecure
()
Indicates whether this cookie requires a secure connection.
Returns
true if this cookie should only be sent
over secure connections, false otherwise.
