org.apache.hc.client5.http.cache

## Class HttpAsyncCacheStorageAdaptor

- java.lang.Object
- - org.apache.hc.client5.http.cache.HttpAsyncCacheStorageAdaptor

- All Implemented Interfaces:
    HttpAsyncCacheStorage

      @Contract(threading=SAFE_CONDITIONAL)
      public final class HttpAsyncCacheStorageAdaptor
      extends Object
      implements HttpAsyncCacheStorage

  `HttpAsyncCacheStorage` implementation that emulates asynchronous behavior using an instance of classic `HttpCacheStorage`.
  Since:
    5.0

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `HttpAsyncCacheStorageAdaptor(HttpCacheStorage cacheStorage)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `org.apache.hc.core5.concurrent.Cancellable` | `getEntries(Collection<String> keys, org.apache.hc.core5.concurrent.FutureCallback<Map<String,HttpCacheEntry>> callback)` Retrieves multiple cache entries stored under the given keys.
    `org.apache.hc.core5.concurrent.Cancellable` | `getEntry(String key, org.apache.hc.core5.concurrent.FutureCallback<HttpCacheEntry> callback)` Retrieves the cache entry stored under the given key or null if no entry exists under that key.
    `org.apache.hc.core5.concurrent.Cancellable` | `putEntry(String key, HttpCacheEntry entry, org.apache.hc.core5.concurrent.FutureCallback<Boolean> callback)` Store a given cache entry under the given key.
    `org.apache.hc.core5.concurrent.Cancellable` | `removeEntry(String key, org.apache.hc.core5.concurrent.FutureCallback<Boolean> callback)` Deletes/invalidates/removes any cache entries currently stored under the given key.
    `org.apache.hc.core5.concurrent.Cancellable` | `updateEntry(String key, HttpCacheCASOperation casOperation, org.apache.hc.core5.concurrent.FutureCallback<Boolean> callback)` 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`

- - ### Constructor Detail

    - #### HttpAsyncCacheStorageAdaptor

          public HttpAsyncCacheStorageAdaptor(HttpCacheStorage cacheStorage)

  - ### Method Detail

    - #### putEntry

          public org.apache.hc.core5.concurrent.Cancellable putEntry(String key,
                                                                     HttpCacheEntry entry,
                                                                     org.apache.hc.core5.concurrent.FutureCallback<Boolean> callback)

      Description copied from interface: `HttpAsyncCacheStorage`
      Store a given cache entry under the given key.
      Specified by:
        `putEntry` in interface `HttpAsyncCacheStorage`
      Parameters:
        `key` - where in the cache to store the entry
        `entry` - cached response to store
        `callback` - result callback

    - #### getEntry

          public org.apache.hc.core5.concurrent.Cancellable getEntry(String key,
                                                                     org.apache.hc.core5.concurrent.FutureCallback<HttpCacheEntry> callback)

      Description copied from interface: `HttpAsyncCacheStorage`
      Retrieves the cache entry stored under the given key or null if no entry exists under that key.
      Specified by:
        `getEntry` in interface `HttpAsyncCacheStorage`
      Parameters:
        `key` - cache key
        `callback` - result callback
      Returns:
        an `HttpCacheEntry` or `null` if no entry exists

    - #### removeEntry

          public org.apache.hc.core5.concurrent.Cancellable removeEntry(String key,
                                                                        org.apache.hc.core5.concurrent.FutureCallback<Boolean> callback)

      Description copied from interface: `HttpAsyncCacheStorage`
      Deletes/invalidates/removes any cache entries currently stored under the given key.
      Specified by:
        `removeEntry` in interface `HttpAsyncCacheStorage`
        `callback` - result callback

    - #### updateEntry

          public org.apache.hc.core5.concurrent.Cancellable updateEntry(String key,
                                                                        HttpCacheCASOperation casOperation,
                                                                        org.apache.hc.core5.concurrent.FutureCallback<Boolean> callback)

      Description copied from interface: `HttpAsyncCacheStorage`
      Atomically applies the given callback to processChallenge an existing cache entry under a given key.
      Specified by:
        `updateEntry` in interface `HttpAsyncCacheStorage`
      Parameters:
        `key` - indicates which entry to modify
        `casOperation` - the CAS operation to perform.
        `callback` - result callback

    - #### getEntries

          public org.apache.hc.core5.concurrent.Cancellable getEntries(Collection<String> keys,
                                                                       org.apache.hc.core5.concurrent.FutureCallback<Map<String,HttpCacheEntry>> callback)

      Description copied from interface: `HttpAsyncCacheStorage`
      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 `HttpAsyncCacheStorage`
      Parameters:
        `keys` - cache keys
        `callback` - result callback

Copyright © 1999–2022 The Apache Software Foundation. All rights reserved.