Class CachingHttpClientBuilder

java.lang.Object

org.apache.hc.client5.http.impl.classic.HttpClientBuilder

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

public class CachingHttpClientBuilder
extends HttpClientBuilder

Builder for CloseableHttpClient instances capable of client-side caching.

Since:

4.3

Field Summary

Fields

Modifier and Type	Field	Description
private CacheConfig	cacheConfig
private File	cacheDir
private boolean	deleteCache
private ResourceFactory	resourceFactory
private SchedulingStrategy	schedulingStrategy
private HttpCacheStorage	storage

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CachingHttpClientBuilder()

Method Summary

Modifier and Type	Method	Description
protected Function<org.apache.hc.core5.http.protocol.HttpContext, HttpClientContext>	contextAdaptor()
static CachingHttpClientBuilder	create()
protected void	customizeExecChain(org.apache.hc.core5.http.config.NamedElementChain<ExecChainHandler> execChainDefinition)	Request exec chain customization and extension.
final CachingHttpClientBuilder	setCacheConfig(CacheConfig cacheConfig)
final CachingHttpClientBuilder	setCacheDir(File cacheDir)
final CachingHttpClientBuilder	setDeleteCache(boolean deleteCache)
final CachingHttpClientBuilder	setHttpCacheInvalidator(HttpCacheInvalidator cacheInvalidator)	Deprecated. Do not use.
final CachingHttpClientBuilder	setHttpCacheStorage(HttpCacheStorage storage)
final CachingHttpClientBuilder	setResourceFactory(ResourceFactory resourceFactory)
final CachingHttpClientBuilder	setSchedulingStrategy(SchedulingStrategy schedulingStrategy)

Methods inherited from class HttpClientBuilder

addCloseable, addExecInterceptorAfter, addExecInterceptorBefore, addExecInterceptorFirst, addExecInterceptorLast, addRequestInterceptorFirst, addRequestInterceptorLast, addResponseInterceptorFirst, addResponseInterceptorLast, build, disableAuthCaching, disableAutomaticRetries, disableConnectionState, disableContentCompression, disableCookieManagement, disableDefaultUserAgent, disableRedirectHandling, evictExpiredConnections, evictIdleConnections, getConnManager, replaceExecInterceptor, setBackoffManager, setConnectionBackoffStrategy, setConnectionManager, setConnectionManagerShared, setConnectionReuseStrategy, setContentDecoderRegistry, setDefaultAuthSchemeRegistry, setDefaultCookieSpecRegistry, setDefaultCookieStore, setDefaultCredentialsProvider, setDefaultHeaders, setDefaultRequestConfig, setKeepAliveStrategy, setProxy, setProxyAuthenticationStrategy, setProxySelector, setRedirectStrategy, setRequestExecutor, setRetryStrategy, setRoutePlanner, setSchemePortResolver, setTargetAuthenticationStrategy, setUserAgent, setUserTokenHandler, useSystemProperties

Methods inherited from class Object

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

Field Details

resourceFactory

private ResourceFactory resourceFactory

storage

private HttpCacheStorage storage

cacheDir

private File cacheDir

schedulingStrategy

private SchedulingStrategy schedulingStrategy

cacheConfig

private CacheConfig cacheConfig

deleteCache

private boolean deleteCache

Constructor Details

CachingHttpClientBuilder

protected CachingHttpClientBuilder()

Method Details

create

public static CachingHttpClientBuilder create()

setResourceFactory

public final CachingHttpClientBuilder setResourceFactory(ResourceFactory resourceFactory)

setHttpCacheStorage

public final CachingHttpClientBuilder setHttpCacheStorage(HttpCacheStorage storage)

setCacheDir

public final CachingHttpClientBuilder setCacheDir(File cacheDir)

setSchedulingStrategy

public final CachingHttpClientBuilder setSchedulingStrategy(SchedulingStrategy schedulingStrategy)

setCacheConfig

public final CachingHttpClientBuilder setCacheConfig(CacheConfig cacheConfig)

setHttpCacheInvalidator

@Deprecated
public final CachingHttpClientBuilder setHttpCacheInvalidator(HttpCacheInvalidator cacheInvalidator)

Deprecated.

Do not use.

setDeleteCache

public final CachingHttpClientBuilder setDeleteCache(boolean deleteCache)

customizeExecChain

protected void customizeExecChain(org.apache.hc.core5.http.config.NamedElementChain<ExecChainHandler> execChainDefinition)

Description copied from class: HttpClientBuilder

Request exec chain customization and extension.

For internal use.

Overrides:

customizeExecChain in class HttpClientBuilder

contextAdaptor

protected Function<org.apache.hc.core5.http.protocol.HttpContext, HttpClientContext> contextAdaptor()

Overrides:

contextAdaptor in class HttpClientBuilder