Class RFC6265CookieSpec

java.lang.Object
org.apache.http.impl.cookie.RFC6265CookieSpec
All Implemented Interfaces:
CookieSpec
Direct Known Subclasses:
RFC6265LaxSpec, RFC6265StrictSpec

@Contract(threading=SAFE) public class RFC6265CookieSpec extends Object implements CookieSpec
Cookie management functions shared by RFC C6265 compliant specification.
Since:
4.5
  • Constructor Details

  • Method Details

    • parse

      public final List<Cookie> parse(org.apache.http.Header header, CookieOrigin origin) throws MalformedCookieException
      Description copied from interface: CookieSpec
      Parse the "Set-Cookie" Header into an array of Cookies.

      This method will not perform the validation of the resultant Cookies

      Specified by:
      parse in interface CookieSpec
      Parameters:
      header - the Set-Cookie received from the server
      origin - details of the cookie origin
      Returns:
      an array of Cookies parsed from the header
      Throws:
      MalformedCookieException - if an exception occurs during parsing
      See Also:
    • validate

      public final void validate(Cookie cookie, CookieOrigin origin) throws MalformedCookieException
      Description copied from interface: CookieSpec
      Validate the cookie according to validation rules defined by the cookie specification.
      Specified by:
      validate in interface CookieSpec
      Parameters:
      cookie - the Cookie to validate
      origin - details of the cookie origin
      Throws:
      MalformedCookieException - if the cookie is invalid
    • match

      public final boolean match(Cookie cookie, CookieOrigin origin)
      Description copied from interface: CookieSpec
      Determines if a Cookie matches the target location.
      Specified by:
      match in interface CookieSpec
      Parameters:
      cookie - the Cookie to be matched
      origin - the target to test against
      Returns:
      true if the cookie should be submitted with a request with given attributes, false otherwise.
    • formatCookies

      public List<org.apache.http.Header> formatCookies(List<Cookie> cookies)
      Description copied from interface: CookieSpec
      Create "Cookie" headers for an array of Cookies.
      Specified by:
      formatCookies in interface CookieSpec
      Parameters:
      cookies - the Cookies format into a Cookie header
      Returns:
      a Header for the given Cookies.
    • getVersion

      public final int getVersion()
      Description copied from interface: CookieSpec
      Returns version of the state management this cookie specification conforms to.
      Specified by:
      getVersion in interface CookieSpec
      Returns:
      version of the state management specification
    • getVersionHeader

      public final org.apache.http.Header getVersionHeader()
      Description copied from interface: CookieSpec
      Returns a request header identifying what version of the state management specification is understood. May be null if the cookie specification does not support Cookie2 header.
      Specified by:
      getVersionHeader in interface CookieSpec