Interface CookieJar



  • public interface CookieJar
    Provides policy and persistence for HTTP cookies.

    As policy, implementations of this interface are responsible for selecting which cookies to accept and which to reject. A reasonable policy is to reject all cookies, though that may be interfere with session-based authentication schemes that require cookies.

    As persistence, implementations of this interface must also provide storage of cookies. Simple implementations may store cookies in memory; sophisticated ones may use the file system or database to hold accepted cookies. The cookie storage model specifies policies for updating and expiring cookies.

    • Field Summary

      Fields

      Modifier and Type Field and Description
      static CookieJar NO_COOKIES
      A cookie jar that never accepts any cookies.
    • Method Summary

      Modifier and Type Method and Description
      List<Cookie> loadForRequest(HttpUrl url)
      Load cookies from the jar for an HTTP request to url.
      void saveFromResponse(HttpUrl url, List<Cookie> cookies)
      Saves cookies from an HTTP response to this store according to this jar's policy.
    • Field Detail

      • NO_COOKIES

        static final CookieJar NO_COOKIES
        A cookie jar that never accepts any cookies.
    • Method Detail

      • saveFromResponse

        void saveFromResponse(HttpUrl url,
                              List<Cookie> cookies)
        Saves cookies from an HTTP response to this store according to this jar's policy.

        Note that this method may be called a second time for a single HTTP response if the response includes a trailer. For this obscure HTTP feature, cookies contains only the trailer's cookies.

      • loadForRequest

        List<Cookie> loadForRequest(HttpUrl url)
        Load cookies from the jar for an HTTP request to url. This method returns a possibly empty list of cookies for the network request.

        Simple implementations will return the accepted cookies that have not yet expired and that match url.