Interface Cookie

All Superinterfaces:
Comparable<Cookie>, Serializable
All Known Implementing Classes:
NettyCookie, SimpleCookie

public interface Cookie extends Comparable<Cookie>, Serializable
An interface representing a Cookie. See https://tools.ietf.org/html/rfc6265.
Since:
1.0
Author:
Graeme Rocher
  • Method Details

    • getName

      Returns:
      The name of the cookie
    • getValue

      Returns:
      The value of the cookie
    • getDomain

      Gets the domain name of this Cookie.

      Domain names are formatted according to RFC 2109.

      Returns:
      the domain name of this Cookie
    • getPath

      The path of the cookie. The cookie is visible to all paths below the request path on the server.
      Returns:
      The cookie path
    • isHttpOnly

      boolean isHttpOnly()
      Checks to see if this Cookie can only be accessed via HTTP. If this returns true, the Cookie cannot be accessed through client side script - But only if the browser supports it.

      See here for reference

      Returns:
      True if this Cookie is HTTP-only or false if it isn't
    • isSecure

      boolean isSecure()
      Returns:
      True if the cookie is secure
    • getMaxAge

      long getMaxAge()
      Returns:
      The maximum age of the cookie in seconds
    • getSameSite

      default Optional<SameSite> getSameSite()
      Checks to see if this Cookie can be sent along cross-site requests. For more information, please look here
      Returns:
      The SameSite attribute of the cookie
    • sameSite

      @NonNull default @NonNull Cookie sameSite(@Nullable @Nullable SameSite sameSite)
      Determines if this Cookie can be sent along cross-site requests. For more information, please look here
      Parameters:
      sameSite - SameSite value
      Returns:
      This cookie
    • maxAge

      @NonNull @NonNull Cookie maxAge(long maxAge)
      Sets the max age of the cookie in seconds.
      Parameters:
      maxAge - The max age
      Returns:
      This cookie
    • value

      Sets the value.
      Parameters:
      value - The value of the cookie
      Returns:
      This cookie
    • domain

      Sets the domain of the cookie.
      Parameters:
      domain - The domain of the cookie
      Returns:
      This cookie
    • path

      Sets the path of the cookie.
      Parameters:
      path - The path of the cookie
      Returns:
      This cookie
    • secure

      @NonNull @NonNull Cookie secure(boolean secure)
      Sets whether the cookie is secure.
      Parameters:
      secure - Is the cookie secure
      Returns:
      This cookie
    • httpOnly

      @NonNull @NonNull Cookie httpOnly(boolean httpOnly)
      Sets whether the cookie is HTTP-Only.
      Parameters:
      httpOnly - Is the cookie HTTP-Only
      Returns:
      This cookie
    • configure

      @NonNull default @NonNull Cookie configure(@NonNull @NonNull CookieConfiguration configuration)
      Configure the Cookie with the given configuration.
      Parameters:
      configuration - The configuration
      Returns:
      The cookie
    • configure

      @NonNull default @NonNull Cookie configure(@NonNull @NonNull CookieConfiguration configuration, boolean isSecure)
      Configure the Cookie with the given configuration.
      Parameters:
      configuration - The configuration
      isSecure - Is the request secure
      Returns:
      The cookie
    • maxAge

      Sets the max age of the cookie.
      Parameters:
      maxAge - The max age
      Returns:
      This cookie
    • of

      Construct a new Cookie for the given name and value.
      Parameters:
      name - The name
      value - The value
      Returns:
      The Cookie