Class BasicHttpCache

java.lang.Object

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

All Implemented Interfaces:

HttpCache

class BasicHttpCache
extends Object
implements HttpCache

Field Summary

Fields

Modifier and Type	Field	Description
private final HttpCacheEntryFactory	cacheEntryFactory
private final CacheKeyGenerator	cacheKeyGenerator
private static final org.slf4j.Logger	LOG
private final ResourceFactory	resourceFactory
private final HttpCacheStorage	storage

Constructor Summary

Constructors

Constructor	Description
BasicHttpCache()
BasicHttpCache(ResourceFactory resourceFactory, HttpCacheEntryFactory cacheEntryFactory, HttpCacheStorage storage, CacheKeyGenerator cacheKeyGenerator)
BasicHttpCache(ResourceFactory resourceFactory, HttpCacheStorage storage)
BasicHttpCache(ResourceFactory resourceFactory, HttpCacheStorage storage, CacheKeyGenerator cacheKeyGenerator)
BasicHttpCache(CacheConfig config)

Method Summary

Modifier and Type	Method	Description
private void	evict(String rootKey)
private void	evict(String rootKey, org.apache.hc.core5.http.HttpResponse response)
private void	evictAll(HttpCacheEntry root, String rootKey)
void	evictInvalidatedEntries(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request, org.apache.hc.core5.http.HttpResponse response)	Evicts HttpCacheEntrys invalidated by the given message exchange.
(package private) HttpCacheEntry	getInternal(String cacheKey)
List<CacheHit>	getVariants(CacheHit hit)	Retrieves variant HttpCacheEntrys for the given hit.
CacheMatch	match(org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request)	Returns a result with either a fully matching HttpCacheEntry a partial match with a list of known variants or null if no match could be found.
private void	removeInternal(String cacheKey)
(package private) CacheHit	store(String rootKey, String variantKey, HttpCacheEntry entry)
CacheHit	store(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)	Stores HttpRequest / HttpResponse exchange details in the cache.
CacheHit	storeFromNegotiated(CacheHit negotiated, org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request, org.apache.hc.core5.http.HttpResponse originResponse, Instant requestSent, Instant responseReceived)	Stores HttpRequest / HttpResponse exchange details in the cache from the negotiated HttpCacheEntry.
(package private) void	storeInternal(String cacheKey, HttpCacheEntry entry)
CacheHit	update(CacheHit stale, org.apache.hc.core5.http.HttpHost host, org.apache.hc.core5.http.HttpRequest request, org.apache.hc.core5.http.HttpResponse originResponse, Instant requestSent, Instant responseReceived)	Updates HttpCacheEntry using details from a 304 HttpResponse and updates the root entry if the given cache entry represents a variant.
(package private) void	updateInternal(String cacheKey, HttpCacheCASOperation casOperation)

Methods inherited from class Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

resourceFactory

private final ResourceFactory resourceFactory

cacheEntryFactory

private final HttpCacheEntryFactory cacheEntryFactory

cacheKeyGenerator

private final CacheKeyGenerator cacheKeyGenerator

storage

private final HttpCacheStorage storage

Constructor Details

BasicHttpCache

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

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 Details

storeInternal

void storeInternal(String cacheKey,
 HttpCacheEntry entry)

updateInternal

void updateInternal(String cacheKey,
 HttpCacheCASOperation casOperation)

getInternal

HttpCacheEntry getInternal(String cacheKey)

removeInternal

private void removeInternal(String cacheKey)

match

public CacheMatch match(org.apache.hc.core5.http.HttpHost host,
 org.apache.hc.core5.http.HttpRequest request)

Description copied from interface: HttpCache

Returns a result with either a fully matching HttpCacheEntry a partial match with a list of known variants or null if no match could be found.

Specified by:

match in interface HttpCache

getVariants

public List<CacheHit> getVariants(CacheHit hit)

Description copied from interface: HttpCache

Retrieves variant HttpCacheEntrys for the given hit.

Specified by:

getVariants in interface HttpCache

store

CacheHit store(String rootKey,
 String variantKey,
 HttpCacheEntry entry)

store

public CacheHit store(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)

Description copied from interface: HttpCache

Stores HttpRequest / HttpResponse exchange details in the cache.

Specified by:

store in interface HttpCache

update

public CacheHit update(CacheHit stale,
 org.apache.hc.core5.http.HttpHost host,
 org.apache.hc.core5.http.HttpRequest request,
 org.apache.hc.core5.http.HttpResponse originResponse,
 Instant requestSent,
 Instant responseReceived)

Description copied from interface: HttpCache

Updates HttpCacheEntry using details from a 304 HttpResponse and updates the root entry if the given cache entry represents a variant.

Specified by:

update in interface HttpCache

storeFromNegotiated

public CacheHit storeFromNegotiated(CacheHit negotiated,
 org.apache.hc.core5.http.HttpHost host,
 org.apache.hc.core5.http.HttpRequest request,
 org.apache.hc.core5.http.HttpResponse originResponse,
 Instant requestSent,
 Instant responseReceived)

Description copied from interface: HttpCache

Stores HttpRequest / HttpResponse exchange details in the cache from the negotiated HttpCacheEntry.

Specified by:

storeFromNegotiated in interface HttpCache

evictAll

private void evictAll(HttpCacheEntry root,
 String rootKey)

evict

private void evict(String rootKey)

evict

private void evict(String rootKey,
 org.apache.hc.core5.http.HttpResponse response)

evictInvalidatedEntries

public void evictInvalidatedEntries(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

Evicts HttpCacheEntrys invalidated by the given message exchange.

Specified by:

evictInvalidatedEntries in interface HttpCache