Class BasicClientCookie

java.lang.Object
org.apache.http.impl.cookie.BasicClientCookie
All Implemented Interfaces:
Serializable, Cloneable, ClientCookie, Cookie, SetCookie
Direct Known Subclasses:
BasicClientCookie2
@NotThreadSafe public class BasicClientCookie extends Object implements SetCookie, ClientCookie, Cloneable, Serializable
Default implementation of SetCookie.
Since:
4.0
See Also:

  • Constructor Details

    • BasicClientCookie

      public BasicClientCookie(String name, String value)
      Default Constructor taking a name and a value. The value may be null.
      Parameters:
      name - The name.
      value - The value.

  • Method Details

    • getName

      public String getName()
      Returns the name.
      Specified by:
      getName in interface Cookie
      Returns:
      String name The name

    • getValue

      public String getValue()
      Returns the value.
      Specified by:
      getValue in interface Cookie
      Returns:
      String value The current value.

    • setValue

      public void setValue(String value)
      Sets the value
      Specified by:
      setValue in interface SetCookie
      Parameters:
      value -

    • getComment

      public String getComment()
      Returns the comment describing the purpose of this cookie, or null if no such comment has been defined.
      Specified by:
      getComment in interface Cookie
      Returns:
      comment
      See Also:

    • setComment

      public void setComment(String comment)
      If a user agent (web browser) presents this cookie to a user, the cookie's purpose will be described using this comment.
      Specified by:
      setComment in interface SetCookie
      Parameters:
      comment -
      See Also:

    • getCommentURL

      public String getCommentURL()
      Returns null. Cookies prior to RFC2965 do not set this attribute
      Specified by:
      getCommentURL in interface Cookie

    • getExpiryDate

      public Date getExpiryDate()
      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.

      Specified by:
      getExpiryDate in interface Cookie
      Returns:
      Expiration Date, or null.
      See Also:

    • setExpiryDate

      public void setExpiryDate(Date expiryDate)
      Sets expiration date.

      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.

      Specified by:
      setExpiryDate in interface SetCookie
      Parameters:
      expiryDate - the Date after which this cookie is no longer valid.
      See Also:

    • isPersistent

      public boolean isPersistent()
      Returns false if the cookie should be discarded at the end of the "session"; true otherwise.
      Specified by:
      isPersistent in interface Cookie
      Returns:
      false if the cookie should be discarded at the end of the "session"; true otherwise

    • getDomain

      public String getDomain()
      Returns domain attribute of the cookie.
      Specified by:
      getDomain in interface Cookie
      Returns:
      the value of the domain attribute
      See Also:

    • setDomain

      public void setDomain(String domain)
      Sets the domain attribute.
      Specified by:
      setDomain in interface SetCookie
      Parameters:
      domain - The value of the domain attribute
      See Also:

    • getPath

      public String getPath()
      Returns the path attribute of the cookie
      Specified by:
      getPath in interface Cookie
      Returns:
      The value of the path attribute.
      See Also:

    • setPath

      public void setPath(String path)
      Sets the path attribute.
      Specified by:
      setPath in interface SetCookie
      Parameters:
      path - The value of the path attribute
      See Also:

    • isSecure

      public boolean isSecure()
      Description copied from interface: Cookie
      Indicates whether this cookie requires a secure connection.
      Specified by:
      isSecure in interface Cookie
      Returns:
      true if this cookie should only be sent over secure connections.
      See Also:

    • setSecure

      public void setSecure(boolean secure)
      Sets the secure attribute of the cookie.

      When true the cookie should only be sent using a secure protocol (https). This should only be set when the cookie's originating server used a secure protocol to set the cookie's value.

      Specified by:
      setSecure in interface SetCookie
      Parameters:
      secure - The value of the secure attribute
      See Also:

    • getPorts

      public int[] getPorts()
      Returns null. Cookies prior to RFC2965 do not set this attribute
      Specified by:
      getPorts in interface Cookie

    • getVersion

      public int getVersion()
      Returns the version of the cookie specification to which this cookie conforms.
      Specified by:
      getVersion in interface Cookie
      Returns:
      the version of the cookie.
      See Also:

    • setVersion

      public void setVersion(int version)
      Sets the version of the cookie specification to which this cookie conforms.
      Specified by:
      setVersion in interface SetCookie
      Parameters:
      version - the version of the cookie.
      See Also:

    • isExpired

      public boolean isExpired(Date date)
      Returns true if this cookie has expired.
      Specified by:
      isExpired in interface Cookie
      Parameters:
      date - Current time
      Returns:
      true if the cookie has expired.

    • setAttribute

      public void setAttribute(String name, String value)

    • getAttribute

      public String getAttribute(String name)
      Specified by:
      getAttribute in interface ClientCookie

    • containsAttribute

      public boolean containsAttribute(String name)
      Specified by:
      containsAttribute in interface ClientCookie

    • clone

      public Object clone() throws CloneNotSupportedException
      Overrides:
      clone in class Object
      Throws:
      CloneNotSupportedException

    • toString

      public String toString()
      Overrides:
      toString in class Object