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

## Class CacheConfig.Builder

- java.lang.Object
- - org.apache.hc.client5.http.impl.cache.CacheConfig.Builder

- Enclosing class:
    CacheConfig

      public static class CacheConfig.Builder
      extends Object

- - ### Method Summary

    All Methods Instance Methods Concrete Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `CacheConfig` | `build()`
    `CacheConfig.Builder` | `setAllow303Caching(boolean allow303Caching)` Deprecated. Has no effect. Do not use.
    `CacheConfig.Builder` | `setAsynchronousWorkers(int asynchronousWorkers)` Sets the maximum number of threads to allow for background revalidations due to the `stale-while-revalidate` directive.
    `CacheConfig.Builder` | `setFreshnessCheckEnabled(boolean freshnessCheckEnabled)`
    `CacheConfig.Builder` | `setHeuristicCachingEnabled(boolean heuristicCachingEnabled)` Enables or disables heuristic caching.
    `CacheConfig.Builder` | `setHeuristicCoefficient(float heuristicCoefficient)` Sets coefficient to be used in heuristic freshness caching.
    `CacheConfig.Builder` | `setHeuristicDefaultLifetime(org.apache.hc.core5.util.TimeValue heuristicDefaultLifetime)` Sets default lifetime to be used if heuristic freshness calculation is not possible.
    `CacheConfig.Builder` | `setMaxCacheEntries(int maxCacheEntries)` Sets the maximum number of cache entries the cache will retain.
    `CacheConfig.Builder` | `setMaxObjectSize(long maxObjectSize)` Specifies the maximum response body size that will be eligible for caching.
    `CacheConfig.Builder` | `setMaxUpdateRetries(int maxUpdateRetries)` Sets the number of times to retry a cache processChallenge on failure
    `CacheConfig.Builder` | `setNeverCacheHTTP10ResponsesWithQueryString(boolean neverCacheHTTP10ResponsesWithQuery)` Sets whether the cache should never cache HTTP 1.0 responses with a query string or not.
    `CacheConfig.Builder` | `setNeverCacheHTTP11ResponsesWithQueryString(boolean neverCacheHTTP11ResponsesWithQuery)` Sets the flag indicating whether HTTP/1.1 responses with a query string should never be cached.
    `CacheConfig.Builder` | `setSharedCache(boolean sharedCache)` Sets whether the cache should behave as a shared cache or not.
    `CacheConfig.Builder` | `setStaleIfErrorEnabled(boolean enabled)` Enables or disables the stale-if-error cache directive.
    `CacheConfig.Builder` | `setWeakETagOnPutDeleteAllowed(boolean weakETagOnPutDeleteAllowed)` Deprecated. No longer applicable. Do not use.

    - ### Methods inherited from class java.lang.Object

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

- - ### Method Detail

    - #### setMaxObjectSize

          public CacheConfig.Builder setMaxObjectSize(long maxObjectSize)

      Specifies the maximum response body size that will be eligible for caching.
      Parameters:
        `maxObjectSize` - size in bytes

    - #### setMaxCacheEntries

          public CacheConfig.Builder setMaxCacheEntries(int maxCacheEntries)

      Sets the maximum number of cache entries the cache will retain.

    - #### setMaxUpdateRetries

          public CacheConfig.Builder setMaxUpdateRetries(int maxUpdateRetries)

      Sets the number of times to retry a cache processChallenge on failure

    - #### setAllow303Caching

          @Deprecated
          public CacheConfig.Builder setAllow303Caching(boolean allow303Caching)

      Deprecated. Has no effect. Do not use.

    - #### setWeakETagOnPutDeleteAllowed

          @Deprecated
          public CacheConfig.Builder setWeakETagOnPutDeleteAllowed(boolean weakETagOnPutDeleteAllowed)

      Deprecated. No longer applicable. Do not use.

    - #### setHeuristicCachingEnabled

          public CacheConfig.Builder setHeuristicCachingEnabled(boolean heuristicCachingEnabled)

      Enables or disables heuristic caching.
      Parameters:
        `heuristicCachingEnabled` - should be `true` to permit heuristic caching, `false` to enable it.

    - #### setHeuristicCoefficient

          public CacheConfig.Builder setHeuristicCoefficient(float heuristicCoefficient)

      Sets coefficient to be used in heuristic freshness caching. This is interpreted as the fraction of the time between the `Last-Modified` and `Date` headers of a cached response during which the cached response will be considered heuristically fresh.
      Parameters:
        `heuristicCoefficient` - should be between `0.0` and `1.0`.

    - #### setHeuristicDefaultLifetime

          public CacheConfig.Builder setHeuristicDefaultLifetime(org.apache.hc.core5.util.TimeValue heuristicDefaultLifetime)

      Sets default lifetime to be used if heuristic freshness calculation is not possible. Explicit cache control directives on either the request or origin response will override this, as will the heuristic `Last-Modified` freshness calculation if it is available.
      Parameters:
        `heuristicDefaultLifetime` - is the number to consider a cache-eligible response fresh in the absence of other information. Set this to `0` to disable this style of heuristic caching.

    - #### setSharedCache

          public CacheConfig.Builder setSharedCache(boolean sharedCache)

      Sets whether the cache should behave as a shared cache or not.
      Parameters:
        `sharedCache` - true to behave as a shared cache, false to behave as a non-shared (private) cache. To have the cache behave like a browser cache, you want to set this to `false`.

    - #### setAsynchronousWorkers

          public CacheConfig.Builder setAsynchronousWorkers(int asynchronousWorkers)

      Sets the maximum number of threads to allow for background revalidations due to the `stale-while-revalidate` directive.
      Parameters:
        `asynchronousWorkers` - number of threads; a value of 0 disables background revalidations.

    - #### setNeverCacheHTTP10ResponsesWithQueryString

          public CacheConfig.Builder setNeverCacheHTTP10ResponsesWithQueryString(boolean neverCacheHTTP10ResponsesWithQuery)

      Sets whether the cache should never cache HTTP 1.0 responses with a query string or not.
      Parameters:
        `neverCacheHTTP10ResponsesWithQuery` - true to never cache responses with a query string, false to cache if explicit cache headers are found. Set this to `true` to better emulate IE, which also never caches responses, regardless of what caching headers may be present.

    - #### setStaleIfErrorEnabled

          public CacheConfig.Builder setStaleIfErrorEnabled(boolean enabled)

      Enables or disables the stale-if-error cache directive. If this option is enabled, cached responses that have become stale due to an error (such as a server error or a network failure) will be returned instead of generating a new request. This can help to reduce the load on the origin server and improve performance.

      By default, the stale-if-error directive is disabled.

      Parameters:
        `enabled` - a boolean value indicating whether the stale-if-error directive should be enabled.
      Returns:
        the builder object

    - #### setFreshnessCheckEnabled

          public CacheConfig.Builder setFreshnessCheckEnabled(boolean freshnessCheckEnabled)

    - #### setNeverCacheHTTP11ResponsesWithQueryString

          public CacheConfig.Builder setNeverCacheHTTP11ResponsesWithQueryString(boolean neverCacheHTTP11ResponsesWithQuery)

      Sets the flag indicating whether HTTP/1.1 responses with a query string should never be cached.
      Parameters:
        `neverCacheHTTP11ResponsesWithQuery` - whether to never cache HTTP/1.1 responses with a query string
      Returns:
        the builder object

    - #### build

          public CacheConfig build()

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