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

Class EhcacheHttpCacheStorage<T>

java.lang.Object

org.apache.hc.client5.http.impl.cache.AbstractSerializingCacheStorage<T,T>

org.apache.hc.client5.http.impl.cache.ehcache.EhcacheHttpCacheStorage<T>

All Implemented Interfaces:

HttpCacheStorage

public class EhcacheHttpCacheStorage<T>
extends AbstractSerializingCacheStorage<T,T>

This class is a storage backend for cache entries that uses the popular Ehcache cache implementation. In particular, this backend allows for spillover to disk, where the cache can be effectively larger than memory, and cached responses are paged into and out of memory from disk as needed.

N.B. Since the Ehcache is configured ahead of time with a maximum number of cache entries, this effectively ignores the CacheConfig.getMaxCacheEntries() maximum cache entries} specified by a provided CacheConfig.

Please refer to the Ehcache documentation for details on how to configure the Ehcache itself.

Since:

4.1

Field Summary

Fields

Modifier and Type	Field	Description
private org.ehcache.Cache<java.lang.String,T>	cache

Constructor Summary

Constructors

Constructor	Description
EhcacheHttpCacheStorage(org.ehcache.Cache<java.lang.String,T> cache, CacheConfig config, HttpCacheEntrySerializer<T> serializer)	Constructs a storage backend using the provided Ehcache with the given configuration options, but using an alternative cache entry serialization strategy.

Method Summary

Modifier and Type	Method	Description
protected java.util.Map<java.lang.String,T>	bulkRestore(java.util.Collection<java.lang.String> storageKeys)
static EhcacheHttpCacheStorage<HttpCacheStorageEntry>	createObjectCache(org.ehcache.Cache<java.lang.String,HttpCacheStorageEntry> cache, CacheConfig config)	Creates cache that stores HttpCacheStorageEntrys without direct serialization.
static EhcacheHttpCacheStorage<byte[]>	createSerializedCache(org.ehcache.Cache<java.lang.String,byte[]> cache, CacheConfig config)	Creates cache that stores serialized HttpCacheStorageEntrys.
protected void	delete(java.lang.String storageKey)
protected java.lang.String	digestToStorageKey(java.lang.String key)
protected T	getForUpdateCAS(java.lang.String storageKey)
protected T	getStorageObject(T element)
protected T	restore(java.lang.String storageKey)
protected void	store(java.lang.String storageKey, T storageObject)
protected boolean	updateCAS(java.lang.String storageKey, T oldStorageObject, T storageObject)

Methods inherited from class org.apache.hc.client5.http.impl.cache.AbstractSerializingCacheStorage

getEntries, getEntry, putEntry, removeEntry, updateEntry

Methods inherited from class java.lang.Object

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

Field Detail

cache

private final org.ehcache.Cache<java.lang.String,T> cache

Constructor Detail

EhcacheHttpCacheStorage

public EhcacheHttpCacheStorage(org.ehcache.Cache<java.lang.String,T> cache,
                               CacheConfig config,
                               HttpCacheEntrySerializer<T> serializer)

Constructs a storage backend using the provided Ehcache with the given configuration options, but using an alternative cache entry serialization strategy.

Parameters:

cache - where to store cached origin responses

config - cache storage configuration options - note that the setting for max object size will be ignored and should be configured in the Ehcache instead.

serializer - alternative serialization mechanism

Method Detail

createObjectCache

public static EhcacheHttpCacheStorage<HttpCacheStorageEntry> createObjectCache(org.ehcache.Cache<java.lang.String,HttpCacheStorageEntry> cache,
                                                                               CacheConfig config)

Creates cache that stores HttpCacheStorageEntrys without direct serialization.

Since:

5.0

createSerializedCache

public static EhcacheHttpCacheStorage<byte[]> createSerializedCache(org.ehcache.Cache<java.lang.String,byte[]> cache,
                                                                    CacheConfig config)

Creates cache that stores serialized HttpCacheStorageEntrys.

Since:

5.0

digestToStorageKey

protected java.lang.String digestToStorageKey(java.lang.String key)

Specified by:

digestToStorageKey in class AbstractSerializingCacheStorage<T,T>

store

protected void store(java.lang.String storageKey,
                     T storageObject)
              throws ResourceIOException

Specified by:

store in class AbstractSerializingCacheStorage<T,T>

Throws:

ResourceIOException

restore

protected T restore(java.lang.String storageKey)
             throws ResourceIOException

Specified by:

restore in class AbstractSerializingCacheStorage<T,T>

Throws:

ResourceIOException

getForUpdateCAS

protected T getForUpdateCAS(java.lang.String storageKey)
                     throws ResourceIOException

Specified by:

getForUpdateCAS in class AbstractSerializingCacheStorage<T,T>

Throws:

ResourceIOException

getStorageObject

protected T getStorageObject(T element)
                      throws ResourceIOException

Specified by:

getStorageObject in class AbstractSerializingCacheStorage<T,T>

Throws:

ResourceIOException

updateCAS

protected boolean updateCAS(java.lang.String storageKey,
                            T oldStorageObject,
                            T storageObject)
                     throws ResourceIOException

Specified by:

updateCAS in class AbstractSerializingCacheStorage<T,T>

Throws:

ResourceIOException

delete

protected void delete(java.lang.String storageKey)
               throws ResourceIOException

Specified by:

delete in class AbstractSerializingCacheStorage<T,T>

Throws:

ResourceIOException

bulkRestore

protected java.util.Map<java.lang.String,T> bulkRestore(java.util.Collection<java.lang.String> storageKeys)
                                                       throws ResourceIOException

Specified by:

bulkRestore in class AbstractSerializingCacheStorage<T,T>

Throws:

ResourceIOException