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 Modifier and Type Field Description static java.lang.String
DOMAIN_ATTR
static java.lang.String
EXPIRES_ATTR
static java.lang.String
HTTP_ONLY_ATTR
static java.lang.String
MAX_AGE_ATTR
static java.lang.String
PATH_ATTR
static java.lang.String
SECURE_ATTR
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description boolean
containsAttribute(java.lang.String name)
java.lang.String
getAttribute(java.lang.String name)
java.util.Date
getCreationDate()
Deprecated.default java.time.Instant
getCreationInstant()
Returns creation time of the cookie.java.lang.String
getDomain()
Returns domain attribute of the cookie.java.util.Date
getExpiryDate()
Deprecated.Use {getExpiryInstant()
}default java.time.Instant
getExpiryInstant()
Returns the expirationInstant
of the cookie, ornull
if none exists.java.lang.String
getName()
Returns the name.java.lang.String
getPath()
Returns the path attribute of the cookie.java.lang.String
getValue()
Returns the value.default boolean
isExpired(java.time.Instant date)
Returns true if this cookie has expired.boolean
isExpired(java.util.Date date)
Deprecated.Use {isExpired(Instant)
}default boolean
isHttpOnly()
Checks whether this Cookie has been marked ashttpOnly
.boolean
isPersistent()
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 Detail
-
PATH_ATTR
static final java.lang.String PATH_ATTR
- See Also:
- Constant Field Values
-
DOMAIN_ATTR
static final java.lang.String DOMAIN_ATTR
- See Also:
- Constant Field Values
-
MAX_AGE_ATTR
static final java.lang.String MAX_AGE_ATTR
- See Also:
- Constant Field Values
-
SECURE_ATTR
static final java.lang.String SECURE_ATTR
- See Also:
- Constant Field Values
-
EXPIRES_ATTR
static final java.lang.String EXPIRES_ATTR
- See Also:
- Constant Field Values
-
HTTP_ONLY_ATTR
static final java.lang.String HTTP_ONLY_ATTR
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAttribute
java.lang.String getAttribute(java.lang.String name)
- Since:
- 5.0
-
containsAttribute
boolean containsAttribute(java.lang.String name)
- Since:
- 5.0
-
getName
java.lang.String getName()
Returns the name.- Returns:
- String name The name
-
getValue
java.lang.String getValue()
Returns the value.- Returns:
- String value The current value.
-
getExpiryDate
@Deprecated java.util.Date 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
default java.time.Instant 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
java.lang.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
java.lang.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 boolean isExpired(java.util.Date date)
Deprecated.Use {isExpired(Instant)
}Returns true if this cookie has expired.- Parameters:
date
- Current time- Returns:
true
if the cookie has expired.
-
isExpired
default boolean isExpired(java.time.Instant date)
Returns true if this cookie has expired.- Parameters:
date
- Current time- Returns:
true
if the cookie has expired.- Since:
- 5.2
-
getCreationDate
@Deprecated java.util.Date getCreationDate()
Deprecated.Returns creation time of the cookie.
-
getCreationInstant
default java.time.Instant 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
-
-