Summary: Methods | [Expand All]
Also: HttpClient
public interface

Cookie

org.apache.http.cookie.Cookie
Known Indirect Subclasses

Class Overview

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.

Summary

Public Methods
abstract String getComment()
Returns the comment describing the purpose of this cookie, or null if no such comment has been defined.
abstract String getCommentURL()
If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described by the information at this URL.
abstract String getDomain()
Returns domain attribute of the cookie.
abstract Date getExpiryDate()
Returns the expiration Date of the cookie, or null if none exists.
abstract String getName()
Returns the name.
abstract String getPath()
Returns the path attribute of the cookie.
abstract int[] getPorts()
Get the Port attribute.
abstract String getValue()
Returns the value.
abstract int getVersion()
Returns the version of the cookie specification to which this cookie conforms.
abstract boolean isExpired(Date date)
Returns true if this cookie has expired.
abstract boolean isPersistent()
Returns false if the cookie should be discarded at the end of the "session"; true otherwise.
abstract boolean isSecure()
Indicates whether this cookie requires a secure connection.

Public Methods

public abstract String getComment ()

Also: HttpClient

Returns the comment describing the purpose of this cookie, or null if no such comment has been defined.

Returns
  • comment

public abstract String getCommentURL ()

Also: HttpClient

If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described by the information at this URL.

public abstract String getDomain ()

Also: HttpClient

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.

public abstract Date getExpiryDate ()

Also: HttpClient

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.

public abstract String getName ()

Also: HttpClient

Returns the name.

Returns
  • String name The name

public abstract String getPath ()

Also: HttpClient

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.

public abstract int[] getPorts ()

Also: HttpClient

Get the Port attribute. It restricts the ports to which a cookie may be returned in a Cookie request header.

public abstract String getValue ()

Also: HttpClient

Returns the value.

Returns
  • String value The current value.

public abstract int getVersion ()

Also: HttpClient

Returns the version of the cookie specification to which this cookie conforms.

Returns
  • the version of the cookie.

public abstract boolean isExpired (Date date)

Also: HttpClient

Returns true if this cookie has expired.

Parameters
date Current time
Returns
  • true if the cookie has expired.

public abstract boolean isPersistent ()

Also: HttpClient

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

public abstract boolean isSecure ()

Also: HttpClient

Indicates whether this cookie requires a secure connection.

Returns
  • true if this cookie should only be sent over secure connections, false otherwise.