Module jakarta.ws.rs
Package jakarta.ws.rs.core

Class Cookie

  • Direct Known Subclasses:
    NewCookie
    public class Cookie
extends java.lang.Object
    Represents the value of a HTTP cookie, transferred in a request. RFC 2109 specifies the legal characters for name, value, path and domain. The default version of 1 corresponds to RFC 2109.
    Since:
    1.0
    See Also:
    IETF RFC 2109

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected Cookie​(Cookie.AbstractCookieBuilder<?> builder)
      Create a new instance from the supplied Cookie.AbstractCookieBuilder instance.
        Cookie​(java.lang.String name, java.lang.String value)
      Deprecated.
      This constructor will be removed in a future version.
        Cookie​(java.lang.String name, java.lang.String value, java.lang.String path, java.lang.String domain)
      Deprecated.
      This constructor will be removed in a future version.
        Cookie​(java.lang.String name, java.lang.String value, java.lang.String path, java.lang.String domain, int version)
      Deprecated.
      This constructor will be removed in a future version.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      Compare for equality.
      java.lang.String getDomain()
      Get the domain of the cookie.
      java.lang.String getName()
      Get the name of the cookie.
      java.lang.String getPath()
      Get the path of the cookie.
      java.lang.String getValue()
      Get the value of the cookie.
      int getVersion()
      Get the version of the cookie.
      int hashCode()
      Generate a hash code by hashing all of the cookies properties.
      java.lang.String toString()
      Deprecated.
      The format of the toString() method is subject to change in a future version.
      static Cookie valueOf​(java.lang.String value)
      Deprecated.
      This method will be removed in a future version.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • DEFAULT_VERSION

        public static final int DEFAULT_VERSION
        Cookies using the default version correspond to RFC 2109.
        See Also:
        Constant Field Values

      • HEADER_DELEGATE

        @Deprecated
private static final RuntimeDelegate.HeaderDelegate<Cookie> HEADER_DELEGATE
        Deprecated.
        This field will be removed in a future version. See https://github.com/jakartaee/rest/issues/607

      • name

        private final java.lang.String name

      • value

        private final java.lang.String value

      • version

        private final int version

      • path

        private final java.lang.String path

      • domain

        private final java.lang.String domain

    • Constructor Detail

      • Cookie

        @Deprecated
public Cookie​(java.lang.String name,
              java.lang.String value,
              java.lang.String path,
              java.lang.String domain,
              int version)
       throws java.lang.IllegalArgumentException
        Deprecated.
        This constructor will be removed in a future version. Please use Cookie.Builder instead.
        Create a new instance.
        Parameters:
        name - the name of the cookie.
        value - the value of the cookie.
        path - the URI path for which the cookie is valid.
        domain - the host domain for which the cookie is valid.
        version - the version of the specification to which the cookie complies.
        Throws:
        java.lang.IllegalArgumentException - if name is null.

      • Cookie

        @Deprecated
public Cookie​(java.lang.String name,
              java.lang.String value,
              java.lang.String path,
              java.lang.String domain)
       throws java.lang.IllegalArgumentException
        Deprecated.
        This constructor will be removed in a future version. Please use Cookie.Builder instead.
        Create a new instance.
        Parameters:
        name - the name of the cookie.
        value - the value of the cookie.
        path - the URI path for which the cookie is valid.
        domain - the host domain for which the cookie is valid.
        Throws:
        java.lang.IllegalArgumentException - if name is null.

      • Cookie

        @Deprecated
public Cookie​(java.lang.String name,
              java.lang.String value)
       throws java.lang.IllegalArgumentException
        Deprecated.
        This constructor will be removed in a future version. Please use Cookie.Builder instead.
        Create a new instance.
        Parameters:
        name - the name of the cookie.
        value - the value of the cookie.
        Throws:
        java.lang.IllegalArgumentException - if name is null.

      • Cookie

        protected Cookie​(Cookie.AbstractCookieBuilder<?> builder)
          throws java.lang.IllegalArgumentException
        Create a new instance from the supplied Cookie.AbstractCookieBuilder instance.
        Parameters:
        builder - the builder.
        Throws:
        java.lang.IllegalArgumentException - if builder.name is null.
        Since:
        3.1

    • Method Detail

      • valueOf

        @Deprecated
public static Cookie valueOf​(java.lang.String value)
        Deprecated.
        This method will be removed in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(Cookie.class).fromString(value) instead.
        Creates a new instance of Cookie by parsing the supplied string.
        Parameters:
        value - the cookie string.
        Returns:
        the newly created Cookie.
        Throws:
        java.lang.IllegalArgumentException - if the supplied string cannot be parsed or is null.

      • getName

        public java.lang.String getName()
        Get the name of the cookie.
        Returns:
        the cookie name.

      • getValue

        public java.lang.String getValue()
        Get the value of the cookie.
        Returns:
        the cookie value.

      • getVersion

        public int getVersion()
        Get the version of the cookie.
        Returns:
        the cookie version.

      • getDomain

        public java.lang.String getDomain()
        Get the domain of the cookie.
        Returns:
        the cookie domain.

      • getPath

        public java.lang.String getPath()
        Get the path of the cookie.
        Returns:
        the cookie path.

      • toString

        @Deprecated
public java.lang.String toString()
        Deprecated.
        The format of the toString() method is subject to change in a future version. Please use RuntimeDelegate.getInstance().createHeaderDelegate(Cookie.class).toString(value) instead if you rely on the format of this method.
        Convert the cookie to a string suitable for use as the value of the corresponding HTTP header.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a stringified cookie.

      • hashCode

        public int hashCode()
        Generate a hash code by hashing all of the cookies properties.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the cookie hash code.

      • equals

        public boolean equals​(java.lang.Object obj)
        Compare for equality.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the object to compare to.
        Returns:
        true, if the object is a Cookie with the same value for all properties, false otherwise.