javax.ws.rs.core

Class Cookie

Contents
  • Direct Known Subclasses:
    NewCookie

    public class Cookie
extends 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
    Author:
    Paul Sandoz, Marc Hadley
    See Also:
    IETF RFC 2109

    • Field Detail

      • DEFAULT_VERSION

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

    • Constructor Detail

      • public Cookie(String name,
              String value,
              String path,
              String domain,
              int version)
       throws IllegalArgumentException
        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:
        IllegalArgumentException - if name is null.
      • public Cookie(String name,
              String value,
              String path,
              String domain)
       throws IllegalArgumentException
        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:
        IllegalArgumentException - if name is null.

    • Method Detail

      • valueOf

        public static Cookie valueOf(String value)
        Creates a new instance of Cookie by parsing the supplied string.
        Parameters:
        value - the cookie string.
        Returns:
        the newly created Cookie.
        Throws:
        IllegalArgumentException - if the supplied string cannot be parsed or is null.

      • getName

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

      • getValue

        public 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 String getDomain()
        Get the domain of the cookie.
        Returns:
        the cookie domain.

      • getPath

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

      • toString

        public String toString()
        Convert the cookie to a string suitable for use as the value of the corresponding HTTP header.
        Overrides:
        toString in class Object
        Returns:
        a stringified cookie.

      • hashCode

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

      • equals

        public boolean equals(Object obj)
        Compare for equality.
        Overrides:
        equals in class 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.

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/ws/rs/core/cookie.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.