Package org.apache.hc.client5.http.impl.cache

Interface HttpCache

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      HttpCacheEntry createCacheEntry​(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request, org.apache.hc.core5.http.HttpResponse originResponse, org.apache.hc.core5.util.ByteArrayBuffer content, java.time.Instant requestSent, java.time.Instant responseReceived)
      Store a HttpResponse in the cache if possible, and return
      void flushCacheEntriesFor​(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request)
      Clear all matching HttpCacheEntrys.
      void flushCacheEntriesInvalidatedByExchange​(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request, org.apache.hc.core5.http.HttpResponse response)
      Flush HttpCacheEntrys invalidated by the given message exchange.
      void flushCacheEntriesInvalidatedByRequest​(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request)
      Flush HttpCacheEntrys invalidated by the given request
      java.lang.String generateKey​(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request, HttpCacheEntry cacheEntry)  
      HttpCacheEntry getCacheEntry​(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request)
      Retrieve matching HttpCacheEntry from the cache if it exists.
      java.util.Map<java.lang.String,​Variant> getVariantCacheEntriesWithEtags​(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request)
      Retrieve all variants from the cache, if there are no variants then an empty Map is returned
      void reuseVariantEntryFor​(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request, Variant variant)
      Specifies cache should reuse the given cached variant to satisfy requests whose varying headers match those of the given client request.
      HttpCacheEntry updateCacheEntry​(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request, HttpCacheEntry stale, org.apache.hc.core5.http.HttpResponse originResponse, java.time.Instant requestSent, java.time.Instant responseReceived)
      Update a HttpCacheEntry using a 304 HttpResponse.
      HttpCacheEntry updateVariantCacheEntry​(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request, org.apache.hc.core5.http.HttpResponse originResponse, Variant variant, java.time.Instant requestSent, java.time.Instant responseReceived)
      Update a specific HttpCacheEntry representing a cached variant using a 304 HttpResponse.

    • Method Detail

      • generateKey

        java.lang.String generateKey​(org.apache.hc.core5.http.HttpHost host,
                             org.apache.hc.core5.http.HttpRequest request,
                             HttpCacheEntry cacheEntry)

      • flushCacheEntriesFor

        void flushCacheEntriesFor​(org.apache.hc.core5.http.HttpHost host,
                          org.apache.hc.core5.http.HttpRequest request)
        Clear all matching HttpCacheEntrys.

      • flushCacheEntriesInvalidatedByRequest

        void flushCacheEntriesInvalidatedByRequest​(org.apache.hc.core5.http.HttpHost host,
                                           org.apache.hc.core5.http.HttpRequest request)
        Flush HttpCacheEntrys invalidated by the given request

      • flushCacheEntriesInvalidatedByExchange

        void flushCacheEntriesInvalidatedByExchange​(org.apache.hc.core5.http.HttpHost host,
                                            org.apache.hc.core5.http.HttpRequest request,
                                            org.apache.hc.core5.http.HttpResponse response)
        Flush HttpCacheEntrys invalidated by the given message exchange.

      • getCacheEntry

        HttpCacheEntry getCacheEntry​(org.apache.hc.core5.http.HttpHost host,
                             org.apache.hc.core5.http.HttpRequest request)
        Retrieve matching HttpCacheEntry from the cache if it exists.

      • getVariantCacheEntriesWithEtags

        java.util.Map<java.lang.String,​Variant> getVariantCacheEntriesWithEtags​(org.apache.hc.core5.http.HttpHost host,
                                                                              org.apache.hc.core5.http.HttpRequest request)
        Retrieve all variants from the cache, if there are no variants then an empty Map is returned

      • createCacheEntry

        HttpCacheEntry createCacheEntry​(org.apache.hc.core5.http.HttpHost host,
                                org.apache.hc.core5.http.HttpRequest request,
                                org.apache.hc.core5.http.HttpResponse originResponse,
                                org.apache.hc.core5.util.ByteArrayBuffer content,
                                java.time.Instant requestSent,
                                java.time.Instant responseReceived)
        Store a HttpResponse in the cache if possible, and return

      • updateCacheEntry

        HttpCacheEntry updateCacheEntry​(org.apache.hc.core5.http.HttpHost host,
                                org.apache.hc.core5.http.HttpRequest request,
                                HttpCacheEntry stale,
                                org.apache.hc.core5.http.HttpResponse originResponse,
                                java.time.Instant requestSent,
                                java.time.Instant responseReceived)
        Update a HttpCacheEntry using a 304 HttpResponse.

      • updateVariantCacheEntry

        HttpCacheEntry updateVariantCacheEntry​(org.apache.hc.core5.http.HttpHost host,
                                       org.apache.hc.core5.http.HttpRequest request,
                                       org.apache.hc.core5.http.HttpResponse originResponse,
                                       Variant variant,
                                       java.time.Instant requestSent,
                                       java.time.Instant responseReceived)
        Update a specific HttpCacheEntry representing a cached variant using a 304 HttpResponse.

      • reuseVariantEntryFor

        void reuseVariantEntryFor​(org.apache.hc.core5.http.HttpHost host,
                          org.apache.hc.core5.http.HttpRequest request,
                          Variant variant)
        Specifies cache should reuse the given cached variant to satisfy requests whose varying headers match those of the given client request.