Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- adapt(HttpContext) - Static method in class org.apache.http.client.cache.HttpCacheContext
- AGE - Static variable in class org.apache.http.client.cache.HeaderConstants
- ALLOW - Static variable in class org.apache.http.client.cache.HeaderConstants
- AsynchronousValidationRequest - Class in org.apache.http.impl.client.cache
-
Class used to represent an asynchronous revalidation event, such as with "stale-while-revalidate"
- AUTHORIZATION - Static variable in class org.apache.http.client.cache.HeaderConstants
B
- BasicHttpCacheStorage - Class in org.apache.http.impl.client.cache
-
Basic
HttpCacheStorage
implementation backed by an instance ofLinkedHashMap
. - BasicHttpCacheStorage(CacheConfig) - Constructor for class org.apache.http.impl.client.cache.BasicHttpCacheStorage
- build() - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
C
- CACHE_CONTROL - Static variable in class org.apache.http.client.cache.HeaderConstants
- CACHE_CONTROL_MAX_AGE - Static variable in class org.apache.http.client.cache.HeaderConstants
- CACHE_CONTROL_MAX_STALE - Static variable in class org.apache.http.client.cache.HeaderConstants
- CACHE_CONTROL_MIN_FRESH - Static variable in class org.apache.http.client.cache.HeaderConstants
- CACHE_CONTROL_MUST_REVALIDATE - Static variable in class org.apache.http.client.cache.HeaderConstants
- CACHE_CONTROL_NO_CACHE - Static variable in class org.apache.http.client.cache.HeaderConstants
- CACHE_CONTROL_NO_STORE - Static variable in class org.apache.http.client.cache.HeaderConstants
- CACHE_CONTROL_PROXY_REVALIDATE - Static variable in class org.apache.http.client.cache.HeaderConstants
- CACHE_HIT - Enum constant in enum org.apache.http.client.cache.CacheResponseStatus
-
A response was generated from the cache with no requests sent upstream.
- CACHE_MISS - Enum constant in enum org.apache.http.client.cache.CacheResponseStatus
-
The response came from an upstream server.
- CACHE_MODULE_RESPONSE - Enum constant in enum org.apache.http.client.cache.CacheResponseStatus
-
The response was generated directly by the caching module.
- CACHE_RESPONSE_STATUS - Static variable in class org.apache.http.client.cache.HttpCacheContext
-
This is the name under which the
CacheResponseStatus
of a request (for example, whether it resulted in a cache hit) will be recorded if anHttpContext
is provided during execution. - CACHE_RESPONSE_STATUS - Static variable in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.This is the name under which the
CacheResponseStatus
of a request (for example, whether it resulted in a cache hit) will be recorded if anHttpContext
is provided during execution. - CacheConfig - Class in org.apache.http.impl.client.cache
-
Java Beans-style configuration for a
CachingHttpClient
. - CacheConfig() - Constructor for class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.
- CacheConfig.Builder - Class in org.apache.http.impl.client.cache
- CacheResponseStatus - Enum in org.apache.http.client.cache
-
This enumeration represents the various ways a response can be generated by the
CachingHttpClient
; if a request is executed with anHttpContext
then a parameter with one of these values will be registered in the context under the keyCACHE_RESPONSE_STATUS
. - CachingExec - Class in org.apache.http.impl.client.cache
-
Request executor in the request execution chain that is responsible for transparent client-side caching.
- CachingExec(ClientExecChain) - Constructor for class org.apache.http.impl.client.cache.CachingExec
- CachingExec(ClientExecChain, ResourceFactory, HttpCacheStorage, CacheConfig) - Constructor for class org.apache.http.impl.client.cache.CachingExec
- CachingExec(ClientExecChain, HttpCache, CacheConfig) - Constructor for class org.apache.http.impl.client.cache.CachingExec
- CachingExec(ClientExecChain, HttpCache, CacheConfig, AsynchronousValidator) - Constructor for class org.apache.http.impl.client.cache.CachingExec
- CachingHttpClient - Class in org.apache.http.impl.client.cache
-
Deprecated.(4.3) use
CachingHttpClientBuilder
orCachingHttpClients
. - CachingHttpClient() - Constructor for class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.Constructs a
CachingHttpClient
with default caching settings that stores cache entries in memory and uses a vanillaDefaultHttpClient
for backend requests. - CachingHttpClient(HttpClient) - Constructor for class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.Constructs a
CachingHttpClient
with default caching settings that stores cache entries in memory and uses the givenHttpClient
for backend requests. - CachingHttpClient(HttpClient, HttpCacheStorage, CacheConfig) - Constructor for class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.Constructs a
CachingHttpClient
with the given caching options that stores cache entries in the provided storage backend and uses the givenHttpClient
for backend requests. - CachingHttpClient(HttpClient, ResourceFactory, HttpCacheStorage, CacheConfig) - Constructor for class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.Constructs a
CachingHttpClient
with the given caching options that stores cache entries in the provided storage backend and uses the givenHttpClient
for backend requests. - CachingHttpClient(HttpClient, CacheConfig) - Constructor for class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.Constructs a
CachingHttpClient
with the given caching options that stores cache entries in memory and uses the givenHttpClient
for backend requests. - CachingHttpClient(CacheConfig) - Constructor for class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.Constructs a
CachingHttpClient
with the given caching options that stores cache entries in memory and uses a vanillaDefaultHttpClient
for backend requests. - CachingHttpClientBuilder - Class in org.apache.http.impl.client.cache
-
Builder for
CloseableHttpClient
instances capable of client-side caching. - CachingHttpClientBuilder() - Constructor for class org.apache.http.impl.client.cache.CachingHttpClientBuilder
- CachingHttpClients - Class in org.apache.http.impl.client.cache
-
Factory methods for
CloseableHttpClient
instances capable of client-side caching. - calculateDelayInMillis(int) - Method in class org.apache.http.impl.client.cache.ExponentialBackOffSchedulingStrategy
- checkNotNegative(String, long) - Static method in class org.apache.http.impl.client.cache.ExponentialBackOffSchedulingStrategy
-
Deprecated.Use
Args.notNegative(long, String)
- checkNotNull(String, T) - Static method in class org.apache.http.impl.client.cache.ExponentialBackOffSchedulingStrategy
-
Deprecated.Use
Args.notNull(Object, String)
- cleanResources() - Method in class org.apache.http.impl.client.cache.ManagedHttpCacheStorage
- clone() - Method in class org.apache.http.impl.client.cache.CacheConfig
- close() - Method in class org.apache.http.impl.client.cache.ExponentialBackOffSchedulingStrategy
- close() - Method in class org.apache.http.impl.client.cache.ImmediateSchedulingStrategy
- close() - Method in class org.apache.http.impl.client.cache.ManagedHttpCacheStorage
- CONTENT_RANGE - Static variable in class org.apache.http.client.cache.HeaderConstants
- copy(String, Resource) - Method in interface org.apache.http.client.cache.ResourceFactory
-
Clones an existing
Resource
. - copy(String, Resource) - Method in class org.apache.http.impl.client.cache.FileResourceFactory
- copy(String, Resource) - Method in class org.apache.http.impl.client.cache.HeapResourceFactory
- copy(CacheConfig) - Static method in class org.apache.http.impl.client.cache.CacheConfig
- create() - Static method in class org.apache.http.client.cache.HttpCacheContext
- create() - Static method in class org.apache.http.impl.client.cache.CachingHttpClientBuilder
- createFileBound(File) - Static method in class org.apache.http.impl.client.cache.CachingHttpClients
-
Creates
CloseableHttpClient
instance that uses a file system bound response cache. - createMemoryBound() - Static method in class org.apache.http.impl.client.cache.CachingHttpClients
-
Creates
CloseableHttpClient
instance that uses a memory bound response cache. - custom() - Static method in class org.apache.http.impl.client.cache.CacheConfig
- custom() - Static method in class org.apache.http.impl.client.cache.CachingHttpClients
-
Creates builder object for construction of custom
CloseableHttpClient
instances.
D
- decorateMainExec(ClientExecChain) - Method in class org.apache.http.impl.client.cache.CachingHttpClientBuilder
- DEFAULT - Static variable in class org.apache.http.impl.client.cache.CacheConfig
- DEFAULT_303_CACHING_ENABLED - Static variable in class org.apache.http.impl.client.cache.CacheConfig
-
Default setting for 303 caching
- DEFAULT_ASYNCHRONOUS_WORKER_IDLE_LIFETIME_SECS - Static variable in class org.apache.http.impl.client.cache.CacheConfig
-
Default maximum idle lifetime for a background revalidation thread before it gets reclaimed.
- DEFAULT_ASYNCHRONOUS_WORKERS_CORE - Static variable in class org.apache.http.impl.client.cache.CacheConfig
-
Default minimum number of worker threads to allow for background revalidations resulting from the stale-while-revalidate directive.
- DEFAULT_ASYNCHRONOUS_WORKERS_MAX - Static variable in class org.apache.http.impl.client.cache.CacheConfig
-
Default number of worker threads to allow for background revalidations resulting from the stale-while-revalidate directive.
- DEFAULT_BACK_OFF_RATE - Static variable in class org.apache.http.impl.client.cache.ExponentialBackOffSchedulingStrategy
- DEFAULT_HEURISTIC_CACHING_ENABLED - Static variable in class org.apache.http.impl.client.cache.CacheConfig
-
Default setting for heuristic caching
- DEFAULT_HEURISTIC_COEFFICIENT - Static variable in class org.apache.http.impl.client.cache.CacheConfig
-
Default coefficient used to heuristically determine freshness lifetime from the Last-Modified time of a cache entry.
- DEFAULT_HEURISTIC_LIFETIME - Static variable in class org.apache.http.impl.client.cache.CacheConfig
-
Default lifetime in seconds to be assumed when we cannot calculate freshness heuristically.
- DEFAULT_INITIAL_EXPIRY_IN_MILLIS - Static variable in class org.apache.http.impl.client.cache.ExponentialBackOffSchedulingStrategy
- DEFAULT_MAX_CACHE_ENTRIES - Static variable in class org.apache.http.impl.client.cache.CacheConfig
-
Default setting for the maximum number of cache entries that will be retained.
- DEFAULT_MAX_EXPIRY_IN_MILLIS - Static variable in class org.apache.http.impl.client.cache.ExponentialBackOffSchedulingStrategy
- DEFAULT_MAX_OBJECT_SIZE_BYTES - Static variable in class org.apache.http.impl.client.cache.CacheConfig
-
Default setting for the maximum object size that will be cached, in bytes.
- DEFAULT_MAX_UPDATE_RETRIES - Static variable in class org.apache.http.impl.client.cache.CacheConfig
-
Default setting for the number of retries on a failed cache update
- DEFAULT_REVALIDATION_QUEUE_SIZE - Static variable in class org.apache.http.impl.client.cache.CacheConfig
-
Default maximum queue length for background revalidation requests.
- DEFAULT_WEAK_ETAG_ON_PUTDELETE_ALLOWED - Static variable in class org.apache.http.impl.client.cache.CacheConfig
-
Default setting to allow weak tags on PUT/DELETE methods
- DefaultFailureCache - Class in org.apache.http.impl.client.cache
-
Implements a bounded failure cache.
- DefaultFailureCache() - Constructor for class org.apache.http.impl.client.cache.DefaultFailureCache
-
Create a new failure cache with the maximum size of
DefaultFailureCache.DEFAULT_MAX_SIZE
. - DefaultFailureCache(int) - Constructor for class org.apache.http.impl.client.cache.DefaultFailureCache
-
Creates a new failure cache with the specified maximum size.
- DefaultHttpCacheEntrySerializer - Class in org.apache.http.impl.client.cache
-
HttpCacheEntrySerializer
implementation that uses the default (native) serialization. - DefaultHttpCacheEntrySerializer() - Constructor for class org.apache.http.impl.client.cache.DefaultHttpCacheEntrySerializer
- DELETE_METHOD - Static variable in class org.apache.http.client.cache.HeaderConstants
- dispose() - Method in interface org.apache.http.client.cache.Resource
-
Indicates the system no longer needs to keep this response body and any system resources associated with it may be reclaimed.
- dispose() - Method in class org.apache.http.impl.client.cache.FileResource
- dispose() - Method in class org.apache.http.impl.client.cache.HeapResource
E
- ETAG - Static variable in class org.apache.http.client.cache.HeaderConstants
- execute(HttpUriRequest) - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.
- execute(HttpUriRequest, ResponseHandler<? extends T>) - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.
- execute(HttpUriRequest, ResponseHandler<? extends T>, HttpContext) - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.
- execute(HttpUriRequest, HttpContext) - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.
- execute(HttpRoute, HttpRequestWrapper) - Method in class org.apache.http.impl.client.cache.CachingExec
- execute(HttpRoute, HttpRequestWrapper, HttpClientContext) - Method in class org.apache.http.impl.client.cache.CachingExec
- execute(HttpRoute, HttpRequestWrapper, HttpClientContext, HttpExecutionAware) - Method in class org.apache.http.impl.client.cache.CachingExec
- execute(HttpHost, HttpRequest) - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.
- execute(HttpHost, HttpRequest, ResponseHandler<? extends T>) - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.
- execute(HttpHost, HttpRequest, ResponseHandler<? extends T>, HttpContext) - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.
- execute(HttpHost, HttpRequest, HttpContext) - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.
- EXPIRES - Static variable in class org.apache.http.client.cache.HeaderConstants
- ExponentialBackOffSchedulingStrategy - Class in org.apache.http.impl.client.cache
-
An implementation that backs off exponentially based on the number of consecutive failed attempts stored in the
AsynchronousValidationRequest
. - ExponentialBackOffSchedulingStrategy(CacheConfig) - Constructor for class org.apache.http.impl.client.cache.ExponentialBackOffSchedulingStrategy
-
Create a new scheduling strategy using a fixed pool of worker threads.
- ExponentialBackOffSchedulingStrategy(CacheConfig, long, long, long) - Constructor for class org.apache.http.impl.client.cache.ExponentialBackOffSchedulingStrategy
-
Create a new scheduling strategy by using a fixed pool of worker threads and the given parameters to calculated the delay.
F
- FailureCache - Interface in org.apache.http.impl.client.cache
-
Increase and reset the number of errors associated with a specific identifier.
- FailureCacheValue - Class in org.apache.http.impl.client.cache
-
The error count with a creation timestamp and its associated key.
- FailureCacheValue(String, int) - Constructor for class org.apache.http.impl.client.cache.FailureCacheValue
- FileResource - Class in org.apache.http.impl.client.cache
-
Cache resource backed by a file.
- FileResource(File) - Constructor for class org.apache.http.impl.client.cache.FileResource
- FileResourceFactory - Class in org.apache.http.impl.client.cache
-
Generates
Resource
instances whose body is stored in a temporary file. - FileResourceFactory(File) - Constructor for class org.apache.http.impl.client.cache.FileResourceFactory
- flushInvalidatedCacheEntries(HttpHost, HttpRequest) - Method in interface org.apache.http.client.cache.HttpCacheInvalidator
-
Remove cache entries from the cache that are no longer fresh or have been invalidated in some way.
- flushInvalidatedCacheEntries(HttpHost, HttpRequest, HttpResponse) - Method in interface org.apache.http.client.cache.HttpCacheInvalidator
-
Flushes entries that were invalidated by the given response received for the given host/request pair.
G
- generate(String, InputStream, InputLimit) - Method in interface org.apache.http.client.cache.ResourceFactory
-
Creates a
Resource
from a given response body. - generate(String, InputStream, InputLimit) - Method in class org.apache.http.impl.client.cache.FileResourceFactory
- generate(String, InputStream, InputLimit) - Method in class org.apache.http.impl.client.cache.HeapResourceFactory
- GET_METHOD - Static variable in class org.apache.http.client.cache.HeaderConstants
- getAllHeaders() - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Returns all the headers that were on the origin response.
- getAsynchronousWorkerIdleLifetimeSecs() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Returns the current maximum idle lifetime in seconds for a background revalidation worker thread.
- getAsynchronousWorkersCore() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Returns the minimum number of threads to keep alive for background revalidations due to the
stale-while-revalidate
directive. - getAsynchronousWorkersMax() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Returns the maximum number of threads to allow for background revalidations due to the
stale-while-revalidate
directive. - getBackOffRate() - Method in class org.apache.http.impl.client.cache.ExponentialBackOffSchedulingStrategy
- getCacheHits() - Method in class org.apache.http.impl.client.cache.CachingExec
-
Reports the number of times that the cache successfully responded to an
HttpRequest
without contacting the origin server. - getCacheHits() - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.Reports the number of times that the cache successfully responded to an
HttpRequest
without contacting the origin server. - getCacheMisses() - Method in class org.apache.http.impl.client.cache.CachingExec
-
Reports the number of times that the cache contacted the origin server because it had no appropriate response cached.
- getCacheMisses() - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.Reports the number of times that the cache contacted the origin server because it had no appropriate response cached.
- getCacheResponseStatus() - Method in class org.apache.http.client.cache.HttpCacheContext
- getCacheUpdates() - Method in class org.apache.http.impl.client.cache.CachingExec
-
Reports the number of times that the cache was able to satisfy a response by revalidating an existing but stale cache entry.
- getCacheUpdates() - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.Reports the number of times that the cache was able to satisfy a response by revalidating an existing but stale cache entry.
- getConnectionManager() - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.
- getConsecutiveFailedAttempts() - Method in class org.apache.http.impl.client.cache.AsynchronousValidationRequest
-
The number of consecutively failed revalidation attempts.
- getCreationTimeInNanos() - Method in class org.apache.http.impl.client.cache.FailureCacheValue
- getDate() - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Gets the Date value of the "Date" header or null if the header is missing or cannot be parsed.
- getEntry(String) - Method in interface org.apache.http.client.cache.HttpCacheStorage
-
Retrieves the cache entry stored under the given key or null if no entry exists under that key.
- getEntry(String) - Method in class org.apache.http.impl.client.cache.BasicHttpCacheStorage
-
Gets an entry from the cache, if it exists
- getEntry(String) - Method in class org.apache.http.impl.client.cache.ManagedHttpCacheStorage
- getErrorCount() - Method in class org.apache.http.impl.client.cache.FailureCacheValue
- getErrorCount(String) - Method in class org.apache.http.impl.client.cache.DefaultFailureCache
- getErrorCount(String) - Method in interface org.apache.http.impl.client.cache.FailureCache
-
Get the current error count.
- getFirstHeader(String) - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Returns the first header from the origin response with the given name.
- getHeaders(String) - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Gets all the headers with the given name that were on the origin response.
- getHeuristicCoefficient() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Returns lifetime coefficient used in heuristic freshness caching.
- getHeuristicDefaultLifetime() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Get the default lifetime to be used if heuristic freshness calculation is not possible.
- getIdentifier() - Method in class org.apache.http.impl.client.cache.AsynchronousValidationRequest
- getInitialExpiryInMillis() - Method in class org.apache.http.impl.client.cache.ExponentialBackOffSchedulingStrategy
- getInputStream() - Method in interface org.apache.http.client.cache.Resource
-
Returns an
InputStream
from which the response body can be read. - getInputStream() - Method in class org.apache.http.impl.client.cache.FileResource
- getInputStream() - Method in class org.apache.http.impl.client.cache.HeapResource
- getKey() - Method in class org.apache.http.impl.client.cache.FailureCacheValue
- getMaxCacheEntries() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Returns the maximum number of cache entries the cache will retain.
- getMaxExpiryInMillis() - Method in class org.apache.http.impl.client.cache.ExponentialBackOffSchedulingStrategy
- getMaxObjectSize() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Returns the current maximum response body size that will be cached.
- getMaxObjectSizeBytes() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.(4.2) use
CacheConfig.getMaxObjectSize()
- getMaxUpdateRetries() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Returns the number of times to retry a cache update on failure
- getParams() - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.
- getProtocolVersion() - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Returns the
ProtocolVersion
from the originHttpResponse
. - getReasonPhrase() - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Gets the reason phrase from the origin
HttpResponse
, for example, "Not Modified". - getRequestDate() - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Returns the time the associated origin request was initiated by the caching module.
- getRequestMethod() - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Returns the HTTP request method that was used to create the cached response entry.
- getResource() - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Returns the
Resource
containing the origin response body. - getResponseDate() - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Returns the time the origin response was received by the caching module.
- getRevalidationQueueSize() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Returns the current maximum queue size for background revalidations.
- getStatusCode() - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Returns the HTTP response code from the origin
HttpResponse
. - getStatusLine() - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Returns the
StatusLine
from the originHttpResponse
. - getValue() - Method in class org.apache.http.client.cache.InputLimit
-
Returns the current maximum limit that was set on creation.
- getVariantMap() - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Returns an index about where in the cache different variants for a given resource are stored.
H
- hasVariants() - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Indicates whether the origin response indicated the associated resource had variants (i.e.
- HEAD_METHOD - Static variable in class org.apache.http.client.cache.HeaderConstants
- HeaderConstants - Class in org.apache.http.client.cache
-
Records static constants for various HTTP header names.
- HeaderConstants() - Constructor for class org.apache.http.client.cache.HeaderConstants
- HeapResource - Class in org.apache.http.impl.client.cache
-
Cache resource backed by a byte array on the heap.
- HeapResource(byte[]) - Constructor for class org.apache.http.impl.client.cache.HeapResource
- HeapResourceFactory - Class in org.apache.http.impl.client.cache
-
Generates
Resource
instances stored entirely in heap. - HeapResourceFactory() - Constructor for class org.apache.http.impl.client.cache.HeapResourceFactory
- HttpCacheContext - Class in org.apache.http.client.cache
- HttpCacheContext() - Constructor for class org.apache.http.client.cache.HttpCacheContext
- HttpCacheContext(HttpContext) - Constructor for class org.apache.http.client.cache.HttpCacheContext
- HttpCacheEntry - Class in org.apache.http.client.cache
-
Structure used to store an
HttpResponse
in a cache. - HttpCacheEntry(Date, Date, StatusLine, Header[], Resource) - Constructor for class org.apache.http.client.cache.HttpCacheEntry
-
Create a new
HttpCacheEntry
. - HttpCacheEntry(Date, Date, StatusLine, Header[], Resource, String) - Constructor for class org.apache.http.client.cache.HttpCacheEntry
-
Create a new
HttpCacheEntry
. - HttpCacheEntry(Date, Date, StatusLine, Header[], Resource, Map<String, String>) - Constructor for class org.apache.http.client.cache.HttpCacheEntry
-
Create a new
HttpCacheEntry
with variants. - HttpCacheEntry(Date, Date, StatusLine, Header[], Resource, Map<String, String>, String) - Constructor for class org.apache.http.client.cache.HttpCacheEntry
-
Create a new
HttpCacheEntry
with variants. - HttpCacheEntrySerializationException - Exception Class in org.apache.http.client.cache
-
Thrown if serialization or deserialization of an
HttpCacheEntry
fails. - HttpCacheEntrySerializationException(String) - Constructor for exception class org.apache.http.client.cache.HttpCacheEntrySerializationException
- HttpCacheEntrySerializationException(String, Throwable) - Constructor for exception class org.apache.http.client.cache.HttpCacheEntrySerializationException
- HttpCacheEntrySerializer - Interface in org.apache.http.client.cache
-
Used by some
HttpCacheStorage
implementations to serializeHttpCacheEntry
instances to a byte representation before storage. - HttpCacheInvalidator - Interface in org.apache.http.client.cache
-
Given a particular HttpRequest, flush any cache entries that this request would invalidate.
- HttpCacheStorage - Interface in org.apache.http.client.cache
-
New storage backends should implement this
HttpCacheStorage
interface. - HttpCacheUpdateCallback - Interface in org.apache.http.client.cache
-
Used for atomically updating entries in a
HttpCacheStorage
implementation. - HttpCacheUpdateException - Exception Class in org.apache.http.client.cache
-
Signals that
HttpCacheStorage
encountered an error performing an update operation. - HttpCacheUpdateException(String) - Constructor for exception class org.apache.http.client.cache.HttpCacheUpdateException
- HttpCacheUpdateException(String, Throwable) - Constructor for exception class org.apache.http.client.cache.HttpCacheUpdateException
I
- IF_MATCH - Static variable in class org.apache.http.client.cache.HeaderConstants
- IF_MODIFIED_SINCE - Static variable in class org.apache.http.client.cache.HeaderConstants
- IF_NONE_MATCH - Static variable in class org.apache.http.client.cache.HeaderConstants
- IF_RANGE - Static variable in class org.apache.http.client.cache.HeaderConstants
- IF_UNMODIFIED_SINCE - Static variable in class org.apache.http.client.cache.HeaderConstants
- ImmediateSchedulingStrategy - Class in org.apache.http.impl.client.cache
-
Immediately schedules any incoming validation request.
- ImmediateSchedulingStrategy(CacheConfig) - Constructor for class org.apache.http.impl.client.cache.ImmediateSchedulingStrategy
-
Uses a
ThreadPoolExecutor
which is configured according to the givenCacheConfig
. - increaseErrorCount(String) - Method in class org.apache.http.impl.client.cache.DefaultFailureCache
- increaseErrorCount(String) - Method in interface org.apache.http.impl.client.cache.FailureCache
-
Increases the error count by one.
- InputLimit - Class in org.apache.http.client.cache
-
Used to limiting the size of an incoming response body of unknown size that is optimistically being read in anticipation of caching it.
- InputLimit(long) - Constructor for class org.apache.http.client.cache.InputLimit
-
Create a limit for how many bytes of a response body to read.
- is303CachingEnabled() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Returns whether 303 caching is enabled.
- isHeuristicCachingEnabled() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Returns whether heuristic caching is enabled.
- isNeverCacheHTTP10ResponsesWithQuery() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Returns whether the cache will never cache HTTP 1.0 responses with a query string or not.
- isReached() - Method in class org.apache.http.client.cache.InputLimit
-
Returns
true
if the input limit has been reached. - isSharedCache() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Returns whether the cache will behave as a shared cache or not.
- isSharedCache() - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.Reports whether this
CachingHttpClient
is configured as a shared (public) or non-shared (private) cache. - isWeakETagOnPutDeleteAllowed() - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Returns whether weak etags is allowed with PUT/DELETE methods.
L
- LAST_MODIFIED - Static variable in class org.apache.http.client.cache.HeaderConstants
- length() - Method in interface org.apache.http.client.cache.Resource
-
Returns the length in bytes of the response body.
- length() - Method in class org.apache.http.impl.client.cache.FileResource
- length() - Method in class org.apache.http.impl.client.cache.HeapResource
M
- ManagedHttpCacheStorage - Class in org.apache.http.impl.client.cache
-
HttpCacheStorage
implementation capable of deallocating resources associated with the cache entries. - ManagedHttpCacheStorage(CacheConfig) - Constructor for class org.apache.http.impl.client.cache.ManagedHttpCacheStorage
- MAX_FORWARDS - Static variable in class org.apache.http.client.cache.HeaderConstants
O
- OPTIONS_METHOD - Static variable in class org.apache.http.client.cache.HeaderConstants
- org.apache.http.client.cache - package org.apache.http.client.cache
-
This package consists largely of constants and interfaces that are necessary for building new storage backends for the
CachingHttpClient
or for those clients wanting to get a little more behavioral information out of the cache module (for example, whether a particular response was a cache hit or not). - org.apache.http.impl.client.cache - package org.apache.http.impl.client.cache
-
This package contains a cache module that can be used for HTTP/1.1 client-side caching.
P
- PRAGMA - Static variable in class org.apache.http.client.cache.HeaderConstants
- PRIVATE - Static variable in class org.apache.http.client.cache.HeaderConstants
- PROXY_AUTHENTICATE - Static variable in class org.apache.http.client.cache.HeaderConstants
- PUBLIC - Static variable in class org.apache.http.client.cache.HeaderConstants
- PUT_METHOD - Static variable in class org.apache.http.client.cache.HeaderConstants
- putEntry(String, HttpCacheEntry) - Method in interface org.apache.http.client.cache.HttpCacheStorage
-
Store a given cache entry under the given key.
- putEntry(String, HttpCacheEntry) - Method in class org.apache.http.impl.client.cache.BasicHttpCacheStorage
-
Places a HttpCacheEntry in the cache
- putEntry(String, HttpCacheEntry) - Method in class org.apache.http.impl.client.cache.ManagedHttpCacheStorage
R
- RANGE - Static variable in class org.apache.http.client.cache.HeaderConstants
- reached() - Method in class org.apache.http.client.cache.InputLimit
-
Used to report that the limit has been reached.
- readFrom(InputStream) - Method in interface org.apache.http.client.cache.HttpCacheEntrySerializer
-
Deserializes a byte representation of a cache entry by reading from the given
InputStream
. - readFrom(InputStream) - Method in class org.apache.http.impl.client.cache.DefaultHttpCacheEntrySerializer
- removeEntry(String) - Method in interface org.apache.http.client.cache.HttpCacheStorage
-
Deletes/invalidates/removes any cache entries currently stored under the given key.
- removeEntry(String) - Method in class org.apache.http.impl.client.cache.BasicHttpCacheStorage
-
Removes a HttpCacheEntry from the cache
- removeEntry(String) - Method in class org.apache.http.impl.client.cache.ManagedHttpCacheStorage
- resetErrorCount(String) - Method in class org.apache.http.impl.client.cache.DefaultFailureCache
- resetErrorCount(String) - Method in interface org.apache.http.impl.client.cache.FailureCache
-
Reset the error count back to zero.
- Resource - Interface in org.apache.http.client.cache
-
Represents a disposable system resource used for handling cached response bodies.
- ResourceFactory - Interface in org.apache.http.client.cache
-
Generates
Resource
instances for handling cached HTTP response bodies. - run() - Method in class org.apache.http.impl.client.cache.AsynchronousValidationRequest
S
- schedule(AsynchronousValidationRequest) - Method in class org.apache.http.impl.client.cache.ExponentialBackOffSchedulingStrategy
- schedule(AsynchronousValidationRequest) - Method in class org.apache.http.impl.client.cache.ImmediateSchedulingStrategy
- schedule(AsynchronousValidationRequest) - Method in interface org.apache.http.impl.client.cache.SchedulingStrategy
-
Schedule an
AsynchronousValidationRequest
to be executed. - SchedulingStrategy - Interface in org.apache.http.impl.client.cache
-
Specifies when revalidation requests are scheduled.
- setAllow303Caching(boolean) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Enables or disables 303 caching.
- setAsynchronousWorkerIdleLifetimeSecs(int) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Sets the current maximum idle lifetime in seconds for a background revalidation worker thread.
- setAsynchronousWorkerIdleLifetimeSecs(int) - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.(4.3) use
CacheConfig.Builder
. - setAsynchronousWorkersCore(int) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Sets the minimum number of threads to keep alive for background revalidations due to the
stale-while-revalidate
directive. - setAsynchronousWorkersCore(int) - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.(4.3) use
CacheConfig.Builder
. - setAsynchronousWorkersMax(int) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Sets the maximum number of threads to allow for background revalidations due to the
stale-while-revalidate
directive. - setAsynchronousWorkersMax(int) - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.(4.3) use
CacheConfig.Builder
. - setCacheConfig(CacheConfig) - Method in class org.apache.http.impl.client.cache.CachingHttpClientBuilder
- setCacheDir(File) - Method in class org.apache.http.impl.client.cache.CachingHttpClientBuilder
- setDeleteCache(boolean) - Method in class org.apache.http.impl.client.cache.CachingHttpClientBuilder
- setHeuristicCachingEnabled(boolean) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Enables or disables heuristic caching.
- setHeuristicCachingEnabled(boolean) - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.(4.3) use
CacheConfig.Builder
. - setHeuristicCoefficient(float) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Sets coefficient to be used in heuristic freshness caching.
- setHeuristicCoefficient(float) - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.(4.3) use
CacheConfig.Builder
. - setHeuristicDefaultLifetime(long) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Sets default lifetime in seconds to be used if heuristic freshness calculation is not possible.
- setHeuristicDefaultLifetime(long) - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.(4.3) use
CacheConfig.Builder
. - setHttpCacheInvalidator(HttpCacheInvalidator) - Method in class org.apache.http.impl.client.cache.CachingHttpClientBuilder
- setHttpCacheStorage(HttpCacheStorage) - Method in class org.apache.http.impl.client.cache.CachingHttpClientBuilder
- setMaxCacheEntries(int) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Sets the maximum number of cache entries the cache will retain.
- setMaxCacheEntries(int) - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.(4.3) use
CacheConfig.Builder
. - setMaxObjectSize(long) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Specifies the maximum response body size that will be eligible for caching.
- setMaxObjectSize(long) - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.(4.3) use
CacheConfig.Builder
. - setMaxObjectSizeBytes(int) - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.(4.2) use
CacheConfig.Builder
. - setMaxUpdateRetries(int) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Sets the number of times to retry a cache update on failure
- setMaxUpdateRetries(int) - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.(4.3) use
CacheConfig.Builder
. - setNeverCacheHTTP10ResponsesWithQueryString(boolean) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Sets whether the cache should never cache HTTP 1.0 responses with a query string or not.
- setResourceFactory(ResourceFactory) - Method in class org.apache.http.impl.client.cache.CachingHttpClientBuilder
- setRevalidationQueueSize(int) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Sets the current maximum queue size for background revalidations.
- setRevalidationQueueSize(int) - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.(4.3) use
CacheConfig.Builder
. - setSchedulingStrategy(SchedulingStrategy) - Method in class org.apache.http.impl.client.cache.CachingHttpClientBuilder
- setSharedCache(boolean) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Sets whether the cache should behave as a shared cache or not.
- setSharedCache(boolean) - Method in class org.apache.http.impl.client.cache.CacheConfig
-
Deprecated.(4.3) use
CacheConfig.Builder
. - setWeakETagOnPutDeleteAllowed(boolean) - Method in class org.apache.http.impl.client.cache.CacheConfig.Builder
-
Allows or disallows weak etags to be used with PUT/DELETE If-Match requests.
- shutdown() - Method in class org.apache.http.impl.client.cache.ManagedHttpCacheStorage
- STALE_IF_ERROR - Static variable in class org.apache.http.client.cache.HeaderConstants
- STALE_WHILE_REVALIDATE - Static variable in class org.apache.http.client.cache.HeaderConstants
- supportsRangeAndContentRangeHeaders() - Method in class org.apache.http.impl.client.cache.CachingExec
-
Reports whether this
CachingHttpClient
implementation supports byte-range requests as specified by theRange
andContent-Range
headers. - supportsRangeAndContentRangeHeaders() - Method in class org.apache.http.impl.client.cache.CachingHttpClient
-
Deprecated.Reports whether this
CachingHttpClient
implementation supports byte-range requests as specified by theRange
andContent-Range
headers.
T
- toString() - Method in class org.apache.http.client.cache.HttpCacheEntry
-
Provides a string representation of this instance suitable for human consumption.
- toString() - Method in class org.apache.http.impl.client.cache.CacheConfig
- toString() - Method in class org.apache.http.impl.client.cache.FailureCacheValue
- TRACE_METHOD - Static variable in class org.apache.http.client.cache.HeaderConstants
U
- update(HttpCacheEntry) - Method in interface org.apache.http.client.cache.HttpCacheUpdateCallback
-
Returns the new cache entry that should replace an existing one.
- updateEntry(String, HttpCacheUpdateCallback) - Method in interface org.apache.http.client.cache.HttpCacheStorage
-
Atomically applies the given callback to update an existing cache entry under a given key.
- updateEntry(String, HttpCacheUpdateCallback) - Method in class org.apache.http.impl.client.cache.BasicHttpCacheStorage
- updateEntry(String, HttpCacheUpdateCallback) - Method in class org.apache.http.impl.client.cache.ManagedHttpCacheStorage
V
- VALIDATED - Enum constant in enum org.apache.http.client.cache.CacheResponseStatus
-
The response was generated from the cache after validating the entry with the origin server.
- valueOf(String) - Static method in enum org.apache.http.client.cache.CacheResponseStatus
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.apache.http.client.cache.CacheResponseStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- VARY - Static variable in class org.apache.http.client.cache.HeaderConstants
- VIA - Static variable in class org.apache.http.client.cache.HeaderConstants
W
- WARNING - Static variable in class org.apache.http.client.cache.HeaderConstants
- writeTo(HttpCacheEntry, OutputStream) - Method in interface org.apache.http.client.cache.HttpCacheEntrySerializer
-
Serializes the given entry to a byte representation on the given
OutputStream
. - writeTo(HttpCacheEntry, OutputStream) - Method in class org.apache.http.impl.client.cache.DefaultHttpCacheEntrySerializer
- WWW_AUTHENTICATE - Static variable in class org.apache.http.client.cache.HeaderConstants
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
CacheConfig.Builder
.