|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.http.impl.cookie.BasicClientCookie
@NotThreadSafe public class BasicClientCookie
Default implementation of SetCookie.
| Field Summary |
|---|
| Fields inherited from interface org.apache.http.cookie.ClientCookie |
|---|
COMMENT_ATTR, COMMENTURL_ATTR, DISCARD_ATTR, DOMAIN_ATTR, EXPIRES_ATTR, MAX_AGE_ATTR, PATH_ATTR, PORT_ATTR, SECURE_ATTR, VERSION_ATTR |
| Constructor Summary | |
|---|---|
BasicClientCookie(String name,
String value)
Default Constructor taking a name and a value. |
|
| Method Summary | |
|---|---|
Object |
clone()
|
boolean |
containsAttribute(String name)
|
String |
getAttribute(String name)
|
String |
getComment()
Returns the comment describing the purpose of this cookie, or null if no such comment has been defined. |
String |
getCommentURL()
Returns null. |
String |
getDomain()
Returns domain attribute of the cookie. |
Date |
getExpiryDate()
Returns the expiration Date of the cookie, or null
if none exists. |
String |
getName()
Returns the name. |
String |
getPath()
Returns the path attribute of the cookie |
int[] |
getPorts()
Returns null. |
String |
getValue()
Returns the value. |
int |
getVersion()
Returns the version of the cookie specification to which this cookie conforms. |
boolean |
isExpired(Date date)
Returns true if this cookie has expired. |
boolean |
isPersistent()
Returns false if the cookie should be discarded at the end of the "session"; true otherwise. |
boolean |
isSecure()
Indicates whether this cookie requires a secure connection. |
void |
setAttribute(String name,
String value)
|
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 |
setExpiryDate(Date expiryDate)
Sets expiration date. |
void |
setPath(String path)
Sets the path attribute. |
void |
setSecure(boolean secure)
Sets the secure attribute of the cookie. |
void |
setValue(String value)
Sets the value |
void |
setVersion(int version)
Sets the version of the cookie specification to which this cookie conforms. |
String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public BasicClientCookie(String name,
String value)
name - The name.value - The value.| Method Detail |
|---|
public String getName()
getName in interface Cookiepublic String getValue()
getValue in interface Cookiepublic void setValue(String value)
setValue in interface SetCookievalue - public String getComment()
getComment in interface CookiesetComment(String)public void setComment(String comment)
setComment in interface SetCookiecomment - getComment()public String getCommentURL()
getCommentURL in interface Cookiepublic Date getExpiryDate()
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.
getExpiryDate in interface CookieDate, or null.setExpiryDate(java.util.Date)public void setExpiryDate(Date expiryDate)
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.
setExpiryDate in interface SetCookieexpiryDate - the Date after which this cookie is no longer valid.getExpiryDate()public boolean isPersistent()
isPersistent in interface Cookiepublic String getDomain()
getDomain in interface CookiesetDomain(java.lang.String)public void setDomain(String domain)
setDomain in interface SetCookiedomain - The value of the domain attributegetDomain()public String getPath()
getPath in interface CookiesetPath(java.lang.String)public void setPath(String path)
setPath in interface SetCookiepath - The value of the path attributegetPath()public boolean isSecure()
Cookie
isSecure in interface Cookietrue if this cookie should only be sent over secure connections.setSecure(boolean)public void setSecure(boolean secure)
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.
setSecure in interface SetCookiesecure - The value of the secure attributeisSecure()public int[] getPorts()
getPorts in interface Cookiepublic int getVersion()
getVersion in interface CookiesetVersion(int)public void setVersion(int version)
setVersion in interface SetCookieversion - the version of the cookie.getVersion()public boolean isExpired(Date date)
isExpired in interface Cookiedate - Current time
public void setAttribute(String name,
String value)
public String getAttribute(String name)
getAttribute in interface ClientCookiepublic boolean containsAttribute(String name)
containsAttribute in interface ClientCookie
public Object clone()
throws CloneNotSupportedException
clone in class ObjectCloneNotSupportedExceptionpublic String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||