Interface Cache

All Known Implementing Classes:
CacheManager.CacheMap
public interface Cache
Cache interface for response caching

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    Cache.Builder
     
    static interface 
    Cache.Key
    Interface for the cache key which can be implemented by consumers The key should implement equals and hashCode It must must return the time the key was created.
    static interface 
    Cache.KeyGenerator
    A functional interface to generate a cache key

  • Method Summary

    Modifier and Type
    Method
    Description
    static Cache.Builder
    builder()
    a builder for cache options
    <T> HttpResponse
    get(Cache.Key key, Supplier<HttpResponse<T>> fetcher)
    Returns the cached HttpResponse for a key or uses the Supplier to fetch the response
    <T> CompletableFuture
    getAsync(Cache.Key key, Supplier<CompletableFuture<HttpResponse<T>>> fetcher)
    Returns the cached HttpResponse for a key or uses the Supplier to fetch the response

  • Method Details

    • get

      <T> HttpResponse get(Cache.Key key, Supplier<HttpResponse<T>> fetcher)
      Returns the cached HttpResponse for a key or uses the Supplier to fetch the response
      Type Parameters:
      T - the type of response
      Parameters:
      key - the cache key
      fetcher - a function to execute the request and return the response. This response should be cached by the implementation
      Returns:
      the Http Response

    • getAsync

      <T> CompletableFuture getAsync(Cache.Key key, Supplier<CompletableFuture<HttpResponse<T>>> fetcher)
      Returns the cached HttpResponse for a key or uses the Supplier to fetch the response
      Type Parameters:
      T - the type of response
      Parameters:
      key - the cache key
      fetcher - a function to execute the request and return the response. This response should be cached by the implementation
      Returns:
      the CompletableFuture for the response

    • builder

      static Cache.Builder builder()
      a builder for cache options
      Returns:
      a new Builder.