Cookie (Apache HttpComponents Client Parent 5.4.1 API)

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 and Description
`static String`	`DOMAIN_ATTR`
`static String`	`EXPIRES_ATTR`
`static String`	`HTTP_ONLY_ATTR`
`static String`	`MAX_AGE_ATTR`
`static String`	`PATH_ATTR`
`static String`	`SECURE_ATTR`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsAttribute(String name)`
`String`	`getAttribute(String name)`
`Date`	`getCreationDate()` Deprecated. Use `getCreationInstant()`
`default Instant`	`getCreationInstant()` Returns creation time of the cookie.
`String`	`getDomain()` Returns domain attribute of the cookie.
`Date`	`getExpiryDate()` Deprecated. Use {`getExpiryInstant()`}
`default 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. Use {`isExpired(Instant)`}
`default boolean`	`isExpired(Instant date)` Returns true if this cookie has expired.
`default 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.

- Field Detail
  - PATH_ATTR
```
static final String PATH_ATTR
```
    See Also:
    
    Constant Field Values
  - DOMAIN_ATTR
```
static final String DOMAIN_ATTR
```
    See Also:
    
    Constant Field Values
  - MAX_AGE_ATTR
```
static final String MAX_AGE_ATTR
```
    See Also:
    
    Constant Field Values
  - SECURE_ATTR
```
static final String SECURE_ATTR
```
    See Also:
    
    Constant Field Values
  - EXPIRES_ATTR
```
static final String EXPIRES_ATTR
```
    See Also:
    
    Constant Field Values
  - HTTP_ONLY_ATTR
```
static final String HTTP_ONLY_ATTR
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getAttribute
```
String getAttribute(String name)
```
    Since:
    
    5.0
  - containsAttribute
```
boolean containsAttribute(String name)
```
    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
Date getExpiryDate()
```
    Deprecated. Use {getExpiryInstant()}
    
    Returns the expiration 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.
    
    Returns:
    
    Expiration Date, or null.
  - getExpiryInstant
```
default Instant getExpiryInstant()
```
    Returns the expiration 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.
    
    Returns:
    
    Expiration Instant, or null.
    
    Since:
    
    5.2
  - isPersistent
```
boolean isPersistent()
```
    Returns false 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
boolean isExpired(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(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
Date getCreationDate()
```
    Deprecated. Use getCreationInstant()
    
    Returns creation time of the cookie.
  - getCreationInstant
```
default Instant getCreationInstant()
```
    Returns creation time of the cookie.
  - isHttpOnly
```
default boolean isHttpOnly()
```
    Checks whether this Cookie has been marked as httpOnly.
    The default implementation returns false.
    
    Returns:
    
    true if this Cookie has been marked as httpOnly, false otherwise
    
    Since:
    
    5.2

Interface Cookie

Field Summary

Method Summary

Field Detail

PATH_ATTR

DOMAIN_ATTR

MAX_AGE_ATTR

SECURE_ATTR

EXPIRES_ATTR

HTTP_ONLY_ATTR

Method Detail

getAttribute

containsAttribute

getName

getValue

getExpiryDate

getExpiryInstant

isPersistent

getDomain

getPath

isSecure

isExpired

isExpired

getCreationDate

getCreationInstant

isHttpOnly