Class DefaultCookieSpec

  • All Implemented Interfaces:
    CookieSpec
    Direct Known Subclasses:
    BestMatchSpec

    @Contract(threading=SAFE)
    public class DefaultCookieSpec
    extends java.lang.Object
    implements CookieSpec
    Default cookie specification that picks up the best matching cookie policy based on the format of cookies sent with the HTTP response.
    Since:
    4.4
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<Header> formatCookies​(java.util.List<Cookie> cookies)
      Create "Cookie" headers for an array of Cookies.
      int getVersion()
      Returns version of the state management this cookie specification conforms to.
      Header getVersionHeader()
      Returns a request header identifying what version of the state management specification is understood.
      boolean match​(Cookie cookie, CookieOrigin origin)
      Determines if a Cookie matches the target location.
      java.util.List<Cookie> parse​(Header header, CookieOrigin origin)
      Parse the "Set-Cookie" Header into an array of Cookies.
      java.lang.String toString()  
      void validate​(Cookie cookie, CookieOrigin origin)
      Validate the cookie according to validation rules defined by the cookie specification.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • DefaultCookieSpec

        public DefaultCookieSpec​(java.lang.String[] datepatterns,
                                 boolean oneHeader)
      • DefaultCookieSpec

        public DefaultCookieSpec()
    • Method Detail

      • match

        public 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 java.util.List<Header> formatCookies​(java.util.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 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 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
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object