|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.http.impl.client.cache.ManagedHttpCacheStorage
@Contract(threading=SAFE) public class ManagedHttpCacheStorage
HttpCacheStorage implementation capable of deallocating resources associated with
the cache entries.
This cache keeps track of cache entries using
PhantomReference and maintains a collection of all resources that
are no longer in use. The cache, however, does not automatically deallocates associated
resources by invoking Resource.dispose() method. The consumer MUST periodically
call cleanResources() method to trigger resource deallocation. The cache can be
permanently shut down using shutdown() method. All resources associated with
the entries used by the cache will be deallocated.
This HttpCacheStorage implementation is intended for use with FileResource
and similar.
Compatibility note. Prior to version 4.4 this storage implementation used to dispose of
all resource entries upon close(). As of version 4.4 the close() method
disposes only of those resources that have been explicitly removed from the cache with
removeEntry(String) method.
The shutdown() ()} method can still be used to shut down the storage and dispose of
all resources currently managed by it.
| Constructor Summary | |
|---|---|
ManagedHttpCacheStorage(CacheConfig config)
|
|
| Method Summary | |
|---|---|
void |
cleanResources()
|
void |
close()
|
HttpCacheEntry |
getEntry(String url)
Retrieves the cache entry stored under the given key or null if no entry exists under that key. |
void |
putEntry(String url,
HttpCacheEntry entry)
Store a given cache entry under the given key. |
void |
removeEntry(String url)
Deletes/invalidates/removes any cache entries currently stored under the given key. |
void |
shutdown()
|
void |
updateEntry(String url,
HttpCacheUpdateCallback callback)
Atomically applies the given callback to update 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 |
| Constructor Detail |
|---|
public ManagedHttpCacheStorage(CacheConfig config)
| Method Detail |
|---|
public void putEntry(String url,
HttpCacheEntry entry)
throws IOException
HttpCacheStorage
putEntry in interface HttpCacheStorageurl - where in the cache to store the entryentry - cached response to store
IOException
public HttpCacheEntry getEntry(String url)
throws IOException
HttpCacheStorage
getEntry in interface HttpCacheStorageurl - cache key
HttpCacheEntry or null if no
entry exists
IOException
public void removeEntry(String url)
throws IOException
HttpCacheStorage
removeEntry in interface HttpCacheStorageIOException
public void updateEntry(String url,
HttpCacheUpdateCallback callback)
throws IOException
HttpCacheStorage
updateEntry in interface HttpCacheStorageurl - indicates which entry to modifycallback - 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.
IOExceptionpublic void cleanResources()
public void shutdown()
public void close()
close in interface Closeable
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||