Package org.apache.http.cookie

Interface SetCookie

All Superinterfaces:
Cookie
All Known Subinterfaces:
SetCookie2
All Known Implementing Classes:
BasicClientCookie, BasicClientCookie2
public interface SetCookie
extends Cookie
This interface represents a SetCookie response header sent by the origin server to the HTTP agent in order to maintain a conversational state.
Since:
4.0
Author:
Oleg Kalnichevski

  • Method Details

    • setValue

      void setValue​(String value)

    • setComment

      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.
      Parameters:
      comment -
      See Also:
      Cookie.getComment()

    • setExpiryDate

      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.

      Parameters:
      expiryDate - the Date after which this cookie is no longer valid.
      See Also:
      Cookie.getExpiryDate()

    • setDomain

      void setDomain​(String domain)
      Sets the domain attribute.
      Parameters:
      domain - The value of the domain attribute
      See Also:
      Cookie.getDomain()

    • setPath

      void setPath​(String path)
      Sets the path attribute.
      Parameters:
      path - The value of the path attribute
      See Also:
      Cookie.getPath()

    • setSecure

      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.

      Parameters:
      secure - The value of the secure attribute
      See Also:
      Cookie.isSecure()

    • setVersion

      void setVersion​(int version)
      Sets the version of the cookie specification to which this cookie conforms.
      Parameters:
      version - the version of the cookie.
      See Also:
      Cookie.getVersion()