Class Cookie2

  • All Implemented Interfaces:
    java.io.Serializable, java.util.Comparator

    @Deprecated
    public class Cookie2
    extends Cookie
    Deprecated.
    Jakarta Commons HttpClient 3.x is deprecated in the Jenkins project. It is not recommended to use it in any new code. Instead, use HTTP client API plugins as a dependency in your code. E.g. Apache HttpComponents Client API 4.x Plugin or Async HTTP Client Plugin.

    Cookie class for RFC2965Spec cookie specification. It extends Cookie class and adds newer cookie attributes and functions required for this specification.

    Since:
    3.1
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String COMMENT
      Deprecated.
       
      static java.lang.String COMMENTURL
      Deprecated.
       
      static java.lang.String DISCARD
      Deprecated.
       
      static java.lang.String DOMAIN
      Deprecated.
       
      static java.lang.String MAXAGE
      Deprecated.
       
      static java.lang.String PATH
      Deprecated.
       
      static java.lang.String PORT
      Deprecated.
       
      static java.lang.String SECURE
      Deprecated.
       
      static java.lang.String VERSION
      Deprecated.
       
    • Constructor Summary

      Constructors 
      Constructor Description
      Cookie2()
      Deprecated.
      Default constructor.
      Cookie2​(java.lang.String domain, java.lang.String name, java.lang.String value)
      Deprecated.
      Creates a cookie with the given name, value and domain attribute.
      Cookie2​(java.lang.String domain, java.lang.String name, java.lang.String value, java.lang.String path, java.util.Date expires, boolean secure)
      Deprecated.
      Creates a cookie with the given name, value, domain attribute, path attribute, expiration attribute, and secure attribute
      Cookie2​(java.lang.String domain, java.lang.String name, java.lang.String value, java.lang.String path, java.util.Date expires, boolean secure, int[] ports)
      Deprecated.
      Creates a cookie with the given name, value, domain attribute, path attribute, expiration attribute, secure attribute, and ports attribute.
    • Constructor Detail

      • Cookie2

        public Cookie2()
        Deprecated.
        Default constructor. Creates a blank cookie
      • Cookie2

        public Cookie2​(java.lang.String domain,
                       java.lang.String name,
                       java.lang.String value)
        Deprecated.
        Creates a cookie with the given name, value and domain attribute.
        Parameters:
        name - the cookie name
        value - the cookie value
        domain - the domain this cookie can be sent to
      • Cookie2

        public Cookie2​(java.lang.String domain,
                       java.lang.String name,
                       java.lang.String value,
                       java.lang.String path,
                       java.util.Date expires,
                       boolean secure)
        Deprecated.
        Creates a cookie with the given name, value, domain attribute, path attribute, expiration attribute, and secure attribute
        Parameters:
        name - the cookie name
        value - the cookie value
        domain - the domain this cookie can be sent to
        path - the path prefix for which this cookie can be sent
        expires - the Date at which this cookie expires, or null if the cookie expires at the end of the session
        secure - if true this cookie can only be sent over secure connections
        Throws:
        java.lang.IllegalArgumentException - If cookie name is null or blank, cookie name contains a blank, or cookie name starts with character $
      • Cookie2

        public Cookie2​(java.lang.String domain,
                       java.lang.String name,
                       java.lang.String value,
                       java.lang.String path,
                       java.util.Date expires,
                       boolean secure,
                       int[] ports)
        Deprecated.
        Creates a cookie with the given name, value, domain attribute, path attribute, expiration attribute, secure attribute, and ports attribute.
        Parameters:
        name - the cookie name
        value - the cookie value
        domain - the domain this cookie can be sent to
        path - the path prefix for which this cookie can be sent
        expires - the Date at which this cookie expires, or null if the cookie expires at the end of the session
        secure - if true this cookie can only be sent over secure connections
        ports - the ports for which this cookie can be sent
        Throws:
        java.lang.IllegalArgumentException - If cookie name is null or blank, cookie name contains a blank, or cookie name starts with character $
    • Method Detail

      • getCommentURL

        public java.lang.String getCommentURL()
        Deprecated.
        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.
        See Also:
        setCommentURL(String)
      • setCommentURL

        public void setCommentURL​(java.lang.String commentURL)
        Deprecated.
        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.
        Parameters:
        commentURL -
        See Also:
        getCommentURL()
      • getPorts

        public int[] getPorts()
        Deprecated.
        Get the Port attribute. It restricts the ports to which a cookie may be returned in a Cookie request header.
        See Also:
        setPorts(int[])
      • setPorts

        public void setPorts​(int[] ports)
        Deprecated.
        Set the Port attribute. It restricts the ports to which a cookie may be returned in a Cookie request header.
        Parameters:
        ports -
        See Also:
        getPorts()
      • setDiscard

        public void setDiscard​(boolean toDiscard)
        Deprecated.
        Set the Discard attribute. Note: Discard attribute overrides Max-age.
        See Also:
        isPersistent()
      • isPersistent

        public boolean isPersistent()
        Deprecated.
        Returns false if the cookie should be discarded at the end of the "session"; true otherwise.
        Overrides:
        isPersistent in class Cookie
        Returns:
        false if the cookie should be discarded at the end of the "session"; true otherwise
      • setPortAttributeSpecified

        public void setPortAttributeSpecified​(boolean value)
        Deprecated.
        Indicates whether the cookie had a port attribute specified in the Set-Cookie2 response header.
        Parameters:
        value - true if port attribute is specified in response header.
        See Also:
        isPortAttributeSpecified()
      • isPortAttributeSpecified

        public boolean isPortAttributeSpecified()
        Deprecated.
        Returns:
        true if cookie port attribute was specified in the Set-Cookie2 header.
        See Also:
        setPortAttributeSpecified(boolean)
      • setPortAttributeBlank

        public void setPortAttributeBlank​(boolean value)
        Deprecated.
        Indicates whether the Port attribute in Set-Cookie2 header contains no value (is of the form Port="").

        This value is required for generating the Cookie request header because the specification requires that if Set-Cookie2 header contains a blank value for port attribute, the Cookie header should also contain a port attribute with no value.

        Parameters:
        value - true if port attribute is specified as blank in response header.
        See Also:
        isPortAttributeBlank
      • isPortAttributeBlank

        public boolean isPortAttributeBlank()
        Deprecated.
        Returns:
        true if the port attribute in Set-Cookie2 header had no value (was of the form Port="").
        See Also:
        setPortAttributeBlank(boolean)
      • setVersionAttributeSpecified

        public void setVersionAttributeSpecified​(boolean value)
        Deprecated.
        Indicates whether the cookie had a version attribute specified in the Set-Cookie2 response header.
        Parameters:
        value - true if version attribute is specified in response header.
        See Also:
        isVersionAttributeSpecified()
      • isVersionAttributeSpecified

        public boolean isVersionAttributeSpecified()
        Deprecated.
        Returns:
        true if cookie version attribute was specified in the Set-Cookie2 header.
        See Also:
        setVersionAttributeSpecified(boolean)
      • toExternalForm

        public java.lang.String toExternalForm()
        Deprecated.
        Return a textual representation of the cookie.
        Overrides:
        toExternalForm in class Cookie
        Returns:
        string.