org.apache.http.cookie.SetCookie
org.apache.http.cookie.SetCookie |
Cookie
|
This interface represents a SetCookie
response header sent by the
origin server to the HTTP agent in order to maintain a conversational state.
Known Indirect Subclasses
SetCookie2 |
This interface represents a SetCookie2 response header sent by the
origin server to the HTTP agent in order to maintain a conversational state. |
Summary
Public Methods
getComment,
getCommentURL,
getDomain,
getExpiryDate,
getName,
getPath,
getPorts,
getValue,
getVersion,
isExpired,
isPersistent,
isSecure
Details
Public Methods
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.
Parameters
domain
| The value of the domain attribute |
public
void
setExpiryDate(Date expiryDate)
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. |
public
void
setPath(String path)
Sets the path attribute.
Parameters
path
| The value of the path attribute |
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). 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 |
public
void
setValue(String value)
public
void
setVersion(int version)
Sets the version of the cookie specification to which this
cookie conforms.
Parameters
version
| the version of the cookie. |