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

Class BasicHttpCache

java.lang.Object

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

All Implemented Interfaces:

HttpCache

class BasicHttpCache
extends java.lang.Object
implements HttpCache

Field Summary

Fields

Modifier and Type	Field	Description
private HttpCacheInvalidator	cacheInvalidator
private CacheKeyGenerator	cacheKeyGenerator
private CacheUpdateHandler	cacheUpdateHandler
private static org.slf4j.Logger	LOG
private HttpCacheStorage	storage

Constructor Summary

Constructors

Constructor	Description
BasicHttpCache()
BasicHttpCache(ResourceFactory resourceFactory, HttpCacheStorage storage)
BasicHttpCache(ResourceFactory resourceFactory, HttpCacheStorage storage, CacheKeyGenerator cacheKeyGenerator)
BasicHttpCache(ResourceFactory resourceFactory, HttpCacheStorage storage, CacheKeyGenerator cacheKeyGenerator, HttpCacheInvalidator cacheInvalidator)
BasicHttpCache(CacheConfig config)

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, 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.
(package private) void	storeEntry(java.lang.String cacheKey, HttpCacheEntry entry)
(package private) void	storeInCache(java.lang.String cacheKey, org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request, HttpCacheEntry entry)
(package private) void	storeVariantEntry(java.lang.String cacheKey, org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest req, HttpCacheEntry entry)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.slf4j.Logger LOG

cacheUpdateHandler

private final CacheUpdateHandler cacheUpdateHandler

cacheKeyGenerator

private final CacheKeyGenerator cacheKeyGenerator

cacheInvalidator

private final HttpCacheInvalidator cacheInvalidator

storage

private final HttpCacheStorage storage

Constructor Detail

BasicHttpCache

public BasicHttpCache(ResourceFactory resourceFactory,
                      HttpCacheStorage storage,
                      CacheKeyGenerator cacheKeyGenerator,
                      HttpCacheInvalidator cacheInvalidator)

BasicHttpCache

public BasicHttpCache(ResourceFactory resourceFactory,
                      HttpCacheStorage storage,
                      CacheKeyGenerator cacheKeyGenerator)

BasicHttpCache

public BasicHttpCache(ResourceFactory resourceFactory,
                      HttpCacheStorage storage)

BasicHttpCache

public BasicHttpCache(CacheConfig config)

BasicHttpCache

public BasicHttpCache()

Method Detail

generateKey

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

Specified by:

generateKey in interface HttpCache

flushCacheEntriesFor

public void flushCacheEntriesFor(org.apache.hc.core5.http.HttpHost host,
                                 org.apache.hc.core5.http.HttpRequest request)

Description copied from interface: HttpCache

Clear all matching HttpCacheEntrys.

Specified by:

flushCacheEntriesFor in interface HttpCache

flushCacheEntriesInvalidatedByRequest

public void flushCacheEntriesInvalidatedByRequest(org.apache.hc.core5.http.HttpHost host,
                                                  org.apache.hc.core5.http.HttpRequest request)

Description copied from interface: HttpCache

Flush HttpCacheEntrys invalidated by the given request

Specified by:

flushCacheEntriesInvalidatedByRequest in interface HttpCache

flushCacheEntriesInvalidatedByExchange

public void flushCacheEntriesInvalidatedByExchange(org.apache.hc.core5.http.HttpHost host,
                                                   org.apache.hc.core5.http.HttpRequest request,
                                                   org.apache.hc.core5.http.HttpResponse response)

Description copied from interface: HttpCache

Flush HttpCacheEntrys invalidated by the given message exchange.

Specified by:

flushCacheEntriesInvalidatedByExchange in interface HttpCache

storeInCache

void storeInCache(java.lang.String cacheKey,
                  org.apache.hc.core5.http.HttpHost host,
                  org.apache.hc.core5.http.HttpRequest request,
                  HttpCacheEntry entry)

storeEntry

void storeEntry(java.lang.String cacheKey,
                HttpCacheEntry entry)

storeVariantEntry

void storeVariantEntry(java.lang.String cacheKey,
                       org.apache.hc.core5.http.HttpHost host,
                       org.apache.hc.core5.http.HttpRequest req,
                       HttpCacheEntry entry)

reuseVariantEntryFor

public void reuseVariantEntryFor(org.apache.hc.core5.http.HttpHost host,
                                 org.apache.hc.core5.http.HttpRequest request,
                                 Variant variant)

Description copied from interface: HttpCache

Specifies cache should reuse the given cached variant to satisfy requests whose varying headers match those of the given client request.

Specified by:

reuseVariantEntryFor in interface HttpCache

updateCacheEntry

public 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)

Description copied from interface: HttpCache

Update a HttpCacheEntry using a 304 HttpResponse.

Specified by:

updateCacheEntry in interface HttpCache

updateVariantCacheEntry

public 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)

Description copied from interface: HttpCache

Update a specific HttpCacheEntry representing a cached variant using a 304 HttpResponse.

Specified by:

updateVariantCacheEntry in interface HttpCache

createCacheEntry

public 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)

Description copied from interface: HttpCache

Store a HttpResponse in the cache if possible, and return

Specified by:

createCacheEntry in interface HttpCache

getCacheEntry

public HttpCacheEntry getCacheEntry(org.apache.hc.core5.http.HttpHost host,
                                    org.apache.hc.core5.http.HttpRequest request)

Description copied from interface: HttpCache

Retrieve matching HttpCacheEntry from the cache if it exists.

Specified by:

getCacheEntry in interface HttpCache

getVariantCacheEntriesWithEtags

public java.util.Map<java.lang.String,Variant> getVariantCacheEntriesWithEtags(org.apache.hc.core5.http.HttpHost host,
                                                                                     org.apache.hc.core5.http.HttpRequest request)

Description copied from interface: HttpCache

Retrieve all variants from the cache, if there are no variants then an empty Map is returned

Specified by:

getVariantCacheEntriesWithEtags in interface HttpCache