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 Details

  • Method Details

    • 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