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

Interface HttpCache

All Known Implementing Classes:
BasicHttpCache
interface HttpCache

  • Method Summary

    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, Instant requestSent, 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
    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.
    Map<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, Instant requestSent, 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, Instant requestSent, Instant responseReceived)
    Update a specific HttpCacheEntry representing a cached variant using a 304 HttpResponse.

  • Method Details

    • generateKey

      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

      Map<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, Instant requestSent, 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, Instant requestSent, 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, Instant requestSent, 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.