public final class BasicClientCookie extends Object implements SetCookie, Cloneable, Serializable
SetCookie.DOMAIN_ATTR, EXPIRES_ATTR, HTTP_ONLY_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()
Deprecated.
Use
getCreationInstant(). |
Instant |
getCreationInstant()
Returns creation time of the cookie.
|
String |
getDomain()
Returns domain attribute of the cookie.
|
Date |
getExpiryDate()
Deprecated.
|
Instant |
getExpiryInstant()
Returns the expiration
Instant 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)
Deprecated.
|
boolean |
isExpired(Instant instant)
Returns true if this cookie has expired.
|
boolean |
isHttpOnly()
Checks whether this Cookie has been marked as
httpOnly. |
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)
Deprecated.
|
void |
setCreationDate(Instant creationDate) |
void |
setDomain(String domain)
Sets the domain attribute.
|
void |
setExpiryDate(Date expiryDate)
Deprecated.
Use {
setExpiryDate(Instant)} |
void |
setExpiryDate(Instant expiryInstant)
Sets expiration date.
|
void |
setHttpOnly(boolean httpOnly)
Sets the http-only attribute of the cookie.
|
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)
@Deprecated public Date getExpiryDate()
getExpiryInstant()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 Instant getExpiryInstant()
Instant 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.
getExpiryInstant in interface CookieInstant, or null.@Deprecated public void setExpiryDate(Date expiryDate)
setExpiryDate(Instant)}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.Cookie.getExpiryDate()public void setExpiryDate(Instant expiryInstant)
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 SetCookieexpiryInstant - the Instant after which this cookie is no longer valid.getExpiryInstant()public boolean isPersistent()
false if the cookie should be discarded at the end
of the "session"; true otherwise.isPersistent in interface Cookiefalse if the cookie should be discarded at the end
of the "session"; true otherwisepublic 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)
public boolean isSecure()
CookieisSecure 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 void setHttpOnly(boolean httpOnly)
setHttpOnly in interface SetCookiehttpOnly - true if this cookie is to be marked as
httpOnly, false otherwise@Deprecated public boolean isExpired(Date date)
isExpired(Instant)public boolean isExpired(Instant instant)
@Deprecated public Date getCreationDate()
getCreationInstant().CookiegetCreationDate in interface Cookiepublic Instant getCreationInstant()
CookiegetCreationInstant in interface Cookiepublic boolean isHttpOnly()
CookiehttpOnly.
The default implementation returns false.
isHttpOnly in interface CookiehttpOnly, false otherwisesetHttpOnly(boolean)@Deprecated public void setCreationDate(Date creationDate)
setCreationDate(Instant)public void setCreationDate(Instant creationDate)
public String getAttribute(String name)
getAttribute in interface Cookiepublic boolean containsAttribute(String name)
containsAttribute in interface Cookiepublic boolean removeAttribute(String name)
public Object clone() throws CloneNotSupportedException
clone in class ObjectCloneNotSupportedExceptionCopyright © 1999–2021 The Apache Software Foundation. All rights reserved.