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

Class BasicHttpCacheStorage

java.lang.Object

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

All Implemented Interfaces:

HttpCacheStorage

@Contract(threading=SAFE)
public class BasicHttpCacheStorage
extends java.lang.Object
implements HttpCacheStorage

Basic HttpCacheStorage implementation backed by an instance of LinkedHashMap. In other words, cache entries and the cached response bodies are held in-memory. This cache does NOT deallocate resources associated with the cache entries; it is intended for use with HeapResource and similar. This is the default cache storage backend used by CachingHttpClients.

Since:

4.1

Field Summary

Fields

Modifier and Type	Field	Description
private CacheMap	entries

Constructor Summary

Constructors

Constructor	Description
BasicHttpCacheStorage(CacheConfig config)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,HttpCacheEntry>	getEntries(java.util.Collection<java.lang.String> keys)	Retrieves multiple cache entries stored under the given keys.
HttpCacheEntry	getEntry(java.lang.String url)	Gets an entry from the cache, if it exists
void	putEntry(java.lang.String url, HttpCacheEntry entry)	Places a HttpCacheEntry in the cache
void	removeEntry(java.lang.String url)	Removes a HttpCacheEntry from the cache
void	updateEntry(java.lang.String url, HttpCacheCASOperation casOperation)	Atomically applies the given callback to processChallenge an existing cache entry under a given key.

Methods inherited from class java.lang.Object

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

Field Detail

entries

private final CacheMap entries

Constructor Detail

BasicHttpCacheStorage

public BasicHttpCacheStorage(CacheConfig config)

Method Detail

putEntry

public void putEntry(java.lang.String url,
                     HttpCacheEntry entry)
              throws ResourceIOException

Places a HttpCacheEntry in the cache

Specified by:

putEntry in interface HttpCacheStorage

Parameters:

url - Url to use as the cache key

entry - HttpCacheEntry to place in the cache

Throws:

ResourceIOException

getEntry

public HttpCacheEntry getEntry(java.lang.String url)
                        throws ResourceIOException

Gets an entry from the cache, if it exists

Specified by:

getEntry in interface HttpCacheStorage

Parameters:

url - Url that is the cache key

Returns:

HttpCacheEntry if one exists, or null for cache miss

Throws:

ResourceIOException

removeEntry

public void removeEntry(java.lang.String url)
                 throws ResourceIOException

Removes a HttpCacheEntry from the cache

Specified by:

removeEntry in interface HttpCacheStorage

Parameters:

url - Url that is the cache key

Throws:

ResourceIOException

updateEntry

public void updateEntry(java.lang.String url,
                        HttpCacheCASOperation casOperation)
                 throws ResourceIOException

Description copied from interface: HttpCacheStorage

Atomically applies the given callback to processChallenge an existing cache entry under a given key.

Specified by:

updateEntry in interface HttpCacheStorage

Parameters:

url - indicates which entry to modify

casOperation - the CAS operation to perform.

Throws:

ResourceIOException

getEntries

public java.util.Map<java.lang.String,HttpCacheEntry> getEntries(java.util.Collection<java.lang.String> keys)
                                                                throws ResourceIOException

Description copied from interface: HttpCacheStorage

Retrieves multiple cache entries stored under the given keys. Some implementations may use a single bulk operation to do the retrieval.

Specified by:

getEntries in interface HttpCacheStorage

Parameters:

keys - cache keys

Returns:

an map of HttpCacheEntrys.

Throws:

ResourceIOException