public final class BasicClientCookie extends Object implements SetCookie, Cloneable, Serializable
SetCookie
.DOMAIN_ATTR, EXPIRES_ATTR, MAX_AGE_ATTR, PATH_ATTR, SECURE_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) |
Date |
getCreationDate()
Returns creation time of the cookie.
|
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
|
String |
getValue()
Returns the value.
|
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 |
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
|
String |
toString() |
public String getName()
public String getValue()
public void setValue(String value)
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 void setPath(String path)
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 boolean isExpired(Date date)
public Date getCreationDate()
Cookie
getCreationDate
in interface Cookie
public void setCreationDate(Date creationDate)
public String getAttribute(String name)
getAttribute
in interface Cookie
public boolean containsAttribute(String name)
containsAttribute
in interface Cookie
public boolean removeAttribute(String name)
public Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
Copyright © 1999–2021 The Apache Software Foundation. All rights reserved.