Class CachingExecBase

java.lang.Object

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

Direct Known Subclasses:

AsyncCachingExec, CachingExec

public class CachingExecBase
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final CacheableRequestPolicy	cacheableRequestPolicy
(package private) final CacheConfig	cacheConfig
(package private) final AtomicLong	cacheHits
(package private) final AtomicLong	cacheMisses
(package private) final AtomicLong	cacheUpdates
(package private) final ResponseCachingPolicy	responseCachingPolicy
(package private) final CachedHttpResponseGenerator	responseGenerator
(package private) final CachedResponseSuitabilityChecker	suitabilityChecker
(package private) final CacheValidityPolicy	validityPolicy

Constructor Summary

Constructors

Constructor	Description
CachingExecBase(CacheConfig config)
CachingExecBase(CacheValidityPolicy validityPolicy, ResponseCachingPolicy responseCachingPolicy, CachedHttpResponseGenerator responseGenerator, CacheableRequestPolicy cacheableRequestPolicy, CachedResponseSuitabilityChecker suitabilityChecker, CacheConfig config)

Method Summary

Modifier and Type	Method	Description
(package private) boolean	clientRequestsOurOptions(org.apache.hc.core5.http.HttpRequest request)
(package private) SimpleHttpResponse	generateCachedResponse(org.apache.hc.core5.http.HttpRequest request, HttpCacheEntry entry, Instant now)
(package private) SimpleHttpResponse	generateGatewayTimeout()
long	getCacheHits()	Reports the number of times that the cache successfully responded to an HttpRequest without contacting the origin server.
long	getCacheMisses()	Reports the number of times that the cache contacted the origin server because it had no appropriate response cached.
long	getCacheUpdates()	Reports the number of times that the cache was able to satisfy a response by revalidating an existing but stale cache entry.
(package private) Instant	getCurrentDate()
(package private) boolean	isResponseTooBig(org.apache.hc.core5.http.EntityDetails entityDetails)
(package private) boolean	shouldSendNotModifiedResponse(org.apache.hc.core5.http.HttpRequest request, HttpCacheEntry responseEntry, Instant now)
(package private) boolean	staleIfErrorAppliesTo(int statusCode)
(package private) void	storeRequestIfModifiedSinceFor304Response(org.apache.hc.core5.http.HttpRequest request, org.apache.hc.core5.http.HttpResponse backendResponse)	For 304 Not modified responses, adds a "Last-Modified" header with the value of the "If-Modified-Since" header passed in the request.

Methods inherited from class Object

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

Field Details

cacheHits

final AtomicLong cacheHits

cacheMisses

final AtomicLong cacheMisses

cacheUpdates

final AtomicLong cacheUpdates

responseCachingPolicy

final ResponseCachingPolicy responseCachingPolicy

validityPolicy

final CacheValidityPolicy validityPolicy

responseGenerator

final CachedHttpResponseGenerator responseGenerator

cacheableRequestPolicy

final CacheableRequestPolicy cacheableRequestPolicy

suitabilityChecker

final CachedResponseSuitabilityChecker suitabilityChecker

cacheConfig

final CacheConfig cacheConfig

Constructor Details

CachingExecBase

CachingExecBase(CacheValidityPolicy validityPolicy,
 ResponseCachingPolicy responseCachingPolicy,
 CachedHttpResponseGenerator responseGenerator,
 CacheableRequestPolicy cacheableRequestPolicy,
 CachedResponseSuitabilityChecker suitabilityChecker,
 CacheConfig config)

CachingExecBase

CachingExecBase(CacheConfig config)

Method Details

getCacheHits

public long getCacheHits()

Reports the number of times that the cache successfully responded to an HttpRequest without contacting the origin server.

Returns:

the number of cache hits

getCacheMisses

public long getCacheMisses()

Reports the number of times that the cache contacted the origin server because it had no appropriate response cached.

Returns:

the number of cache misses

getCacheUpdates

public long getCacheUpdates()

Reports the number of times that the cache was able to satisfy a response by revalidating an existing but stale cache entry.

Returns:

the number of cache revalidations

generateCachedResponse

SimpleHttpResponse generateCachedResponse(org.apache.hc.core5.http.HttpRequest request,
 HttpCacheEntry entry,
 Instant now)
                                   throws ResourceIOException

Throws:

ResourceIOException

generateGatewayTimeout

SimpleHttpResponse generateGatewayTimeout()

getCurrentDate

Instant getCurrentDate()

clientRequestsOurOptions

boolean clientRequestsOurOptions(org.apache.hc.core5.http.HttpRequest request)

shouldSendNotModifiedResponse

boolean shouldSendNotModifiedResponse(org.apache.hc.core5.http.HttpRequest request,
 HttpCacheEntry responseEntry,
 Instant now)

staleIfErrorAppliesTo

boolean staleIfErrorAppliesTo(int statusCode)

storeRequestIfModifiedSinceFor304Response

void storeRequestIfModifiedSinceFor304Response(org.apache.hc.core5.http.HttpRequest request,
 org.apache.hc.core5.http.HttpResponse backendResponse)

For 304 Not modified responses, adds a "Last-Modified" header with the value of the "If-Modified-Since" header passed in the request. This header is required to be able to reuse match the cache entry for subsequent requests but as defined in http specifications it is not included in 304 responses by backend servers. This header will not be included in the resulting response.

isResponseTooBig

boolean isResponseTooBig(org.apache.hc.core5.http.EntityDetails entityDetails)