Interface Cookie
- All Known Subinterfaces:
SetCookie
- All Known Implementing Classes:
BasicClientCookie
public interface Cookie
Cookie interface represents a token or short packet of state information
(also referred to as "magic-cookie") that the HTTP agent and the target
server can exchange to maintain a session. In its simples form an HTTP
cookie is merely a name / value pair.
- Since:
- 4.0
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionboolean
containsAttribute
(String name) getAttribute
(String name) Deprecated.default Instant
Returns creation time of the cookie.Returns domain attribute of the cookie.Deprecated.Use {getExpiryInstant()
}default Instant
Returns the expirationInstant
of the cookie, ornull
if none exists.getName()
Returns the name.getPath()
Returns the path attribute of the cookie.getValue()
Returns the value.default boolean
Returns true if this cookie has expired.boolean
Deprecated.Use {isExpired(Instant)
}default boolean
Checks whether this Cookie has been marked ashttpOnly
.boolean
Returnsfalse
if the cookie should be discarded at the end of the "session";true
otherwise.boolean
isSecure()
Indicates whether this cookie requires a secure connection.
-
Field Details
-
PATH_ATTR
- See Also:
-
DOMAIN_ATTR
- See Also:
-
MAX_AGE_ATTR
- See Also:
-
SECURE_ATTR
- See Also:
-
EXPIRES_ATTR
- See Also:
-
HTTP_ONLY_ATTR
- See Also:
-
-
Method Details
-
getAttribute
- Since:
- 5.0
-
containsAttribute
- Since:
- 5.0
-
getName
String getName()Returns the name.- Returns:
- String name The name
-
getValue
String getValue()Returns the value.- Returns:
- String value The current value.
-
getExpiryDate
Deprecated.Use {getExpiryInstant()
}Returns the expirationDate
of the cookie, ornull
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.
- Returns:
- Expiration
Date
, ornull
.
-
getExpiryInstant
Returns the expirationInstant
of the cookie, ornull
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.
- Returns:
- Expiration
Instant
, ornull
. - Since:
- 5.2
-
isPersistent
boolean isPersistent()Returnsfalse
if the cookie should be discarded at the end of the "session";true
otherwise.- Returns:
false
if the cookie should be discarded at the end of the "session";true
otherwise
-
getDomain
String getDomain()Returns domain attribute of the cookie. The value of the Domain attribute specifies the domain for which the cookie is valid.- Returns:
- the value of the domain attribute.
-
getPath
String getPath()Returns the path attribute of the cookie. The value of the Path attribute specifies the subset of URLs on the origin server to which this cookie applies.- Returns:
- The value of the path attribute.
-
isSecure
boolean isSecure()Indicates whether this cookie requires a secure connection.- Returns:
true
if this cookie should only be sent over secure connections,false
otherwise.
-
isExpired
Deprecated.Use {isExpired(Instant)
}Returns true if this cookie has expired.- Parameters:
date
- Current time- Returns:
true
if the cookie has expired.
-
isExpired
Returns true if this cookie has expired.- Parameters:
date
- Current time- Returns:
true
if the cookie has expired.- Since:
- 5.2
-
getCreationDate
Deprecated.Returns creation time of the cookie. -
getCreationInstant
Returns creation time of the cookie. -
isHttpOnly
default boolean isHttpOnly()Checks whether this Cookie has been marked ashttpOnly
.The default implementation returns
false
.- Returns:
- true if this Cookie has been marked as
httpOnly
, false otherwise - Since:
- 5.2
-
getCreationInstant()