public class BasicClientCookie extends Object implements SetCookie, ClientCookie, Cloneable, Serializable
SetCookie
.Modifier and Type | Field and Description |
---|---|
private Map<String,String> |
attribs
Cookie attributes as specified by the origin server
|
private String |
cookieComment
Comment attribute.
|
private String |
cookieDomain
Domain attribute.
|
private Date |
cookieExpiryDate
Expiration
Date . |
private String |
cookiePath
Path attribute.
|
private int |
cookieVersion
The version of the cookie specification I was created from.
|
private Date |
creationDate |
private boolean |
isSecure
My secure flag.
|
private String |
name
Cookie name
|
private static long |
serialVersionUID |
private String |
value
Cookie value
|
COMMENT_ATTR, COMMENTURL_ATTR, DISCARD_ATTR, DOMAIN_ATTR, EXPIRES_ATTR, MAX_AGE_ATTR, PATH_ATTR, PORT_ATTR, SECURE_ATTR, VERSION_ATTR
Constructor and Description |
---|
BasicClientCookie(String name,
String value)
Default Constructor taking a name and a value.
|
Modifier and Type | Method and Description |
---|---|
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.
|
Date |
getCreationDate() |
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.
|
boolean |
removeAttribute(String name) |
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 |
setCreationDate(Date creationDate) |
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() |
private static final long serialVersionUID
private String cookieComment
private String cookieDomain
private Date cookieExpiryDate
Date
.private String cookiePath
private boolean isSecure
private int cookieVersion
private Date creationDate
public BasicClientCookie(String name, String value)
name
- The name.value
- The value.public String getComment()
null
if no such comment has been defined.getComment
in interface Cookie
setComment(String)
public void setComment(String comment)
setComment
in interface SetCookie
comment
- getComment()
public String getCommentURL()
getCommentURL
in interface Cookie
public 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 Cookie
Date
, 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 SetCookie
expiryDate
- the Date
after which this cookie is no longer valid.getExpiryDate()
public boolean isPersistent()
false
if the cookie should be discarded at the end
of the "session"; true
otherwise.isPersistent
in interface Cookie
false
if the cookie should be discarded at the end
of the "session"; true
otherwisepublic String getDomain()
getDomain
in interface Cookie
setDomain(java.lang.String)
public void setDomain(String domain)
setDomain
in interface SetCookie
domain
- The value of the domain attributegetDomain()
public String getPath()
getPath
in interface Cookie
setPath(java.lang.String)
public boolean isSecure()
Cookie
isSecure
in interface Cookie
true
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 SetCookie
secure
- The value of the secure attributeisSecure()
public int[] getPorts()
public int getVersion()
getVersion
in interface Cookie
setVersion(int)
public void setVersion(int version)
setVersion
in interface SetCookie
version
- the version of the cookie.getVersion()
public Date getCreationDate()
public void setCreationDate(Date creationDate)
public void setAttribute(String name, String value)
public String getAttribute(String name)
getAttribute
in interface ClientCookie
public boolean containsAttribute(String name)
containsAttribute
in interface ClientCookie
public boolean removeAttribute(String name)
public Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
WebARTS Library Licensed Under the GNU - General Public License. Other Libraries licensed under their respective Open Source Licenses