Package org.apache.http.client.cache

Interface HttpCacheStorage

All Known Implementing Classes:

BasicHttpCacheStorage, EhcacheHttpCacheStorage, ManagedHttpCacheStorage, MemcachedHttpCacheStorage

public interface HttpCacheStorage

New storage backends should implement this HttpCacheStorage interface. They can then be plugged into the existing CachingHttpClient implementation.

Since:

4.1

Method Summary

Modifier and Type	Method	Description
HttpCacheEntry	getEntry(java.lang.String key)	Retrieves the cache entry stored under the given key or null if no entry exists under that key.
void	putEntry(java.lang.String key, HttpCacheEntry entry)	Store a given cache entry under the given key.
void	removeEntry(java.lang.String key)	Deletes/invalidates/removes any cache entries currently stored under the given key.
void	updateEntry(java.lang.String key, HttpCacheUpdateCallback callback)	Atomically applies the given callback to update an existing cache entry under a given key.

Method Detail

putEntry

void putEntry(java.lang.String key,
              HttpCacheEntry entry)
       throws java.io.IOException

Store a given cache entry under the given key.

Parameters:

key - where in the cache to store the entry

entry - cached response to store

Throws:

java.io.IOException

getEntry

HttpCacheEntry getEntry(java.lang.String key)
                 throws java.io.IOException

Retrieves the cache entry stored under the given key or null if no entry exists under that key.

Parameters:

key - cache key

Returns:

an HttpCacheEntry or null if no entry exists

Throws:

java.io.IOException

removeEntry

void removeEntry(java.lang.String key)
          throws java.io.IOException

Deletes/invalidates/removes any cache entries currently stored under the given key.

Parameters:

key -

Throws:

java.io.IOException

updateEntry

void updateEntry(java.lang.String key,
                 HttpCacheUpdateCallback callback)
          throws java.io.IOException,
                 HttpCacheUpdateException

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

Parameters:

key - indicates which entry to modify

callback - performs the update; see HttpCacheUpdateCallback for details, but roughly the callback expects to be handed the current entry and will return the new value for the entry.

Throws:

java.io.IOException

HttpCacheUpdateException