Module io.vertx.web.client

Package io.vertx.ext.web.client

Class CachingWebClientConfig

java.lang.Object

io.vertx.core.http.HttpClientConfig

io.vertx.ext.web.client.WebClientConfig

io.vertx.ext.web.client.CachingWebClientConfig

public class CachingWebClientConfig
extends WebClientConfig

Author:

Craig Day

Field Summary

Fields

Modifier and Type	Field	Description
static Set<HttpMethod>	DEFAULT_CACHED_METHODS
static Set<Integer>	DEFAULT_CACHED_STATUS_CODES

Fields inherited from class io.vertx.core.http.HttpClientConfig

DEFAULT_FOLLOW_ALTERNATIVE_SERVICES, DEFAULT_QUIC_INITIAL_MAX_DATA, DEFAULT_QUIC_INITIAL_MAX_STREAM_BIDI, DEFAULT_QUIC_INITIAL_MAX_STREAM_DATA_BIDI_LOCAL, DEFAULT_QUIC_INITIAL_MAX_STREAM_DATA_BIDI_REMOTE, DEFAULT_QUIC_INITIAL_MAX_STREAM_DATA_UNI, DEFAULT_QUIC_INITIAL_MAX_STREAM_UNI, DEFAULT_SUPPORTED_VERSIONS

Constructor Summary

Constructors

Constructor	Description
CachingWebClientConfig()
CachingWebClientConfig(WebClientConfig other)

Method Summary

Modifier and Type	Method	Description
CachingWebClientConfig	addCachedMethod(HttpMethod method)	Add an HTTP method that is cacheable.
CachingWebClientConfig	addCachedStatusCode(Integer code)	Add a status code that is cacheable.
Set<HttpMethod>	getCachedMethods()
Set<Integer>	getCachedStatusCodes()
boolean	isVaryCachingEnabled()
CachingWebClientConfig	removeCachedMethod(HttpMethod method)	Remove an HTTP method that is cacheable.
CachingWebClientConfig	removeCachedStatusCode(Integer code)	Remove a status code that is cacheable.
CachingWebClientConfig	setCachedMethods(Set<HttpMethod> methods)	Configure the HTTP methods that can be cached.
CachingWebClientConfig	setCachedStatusCodes(Set<Integer> codes)	Configure the status codes that can be cached.
CachingWebClientConfig	setConnectTimeout(Duration connectTimeout)
CachingWebClientConfig	setDecompressionEnabled(boolean decompressionEnabled)
CachingWebClientConfig	setDefaultHost(String defaultHost)
CachingWebClientConfig	setDefaultPort(int defaultPort)
CachingWebClientConfig	setEnableVaryCaching(boolean enabled)	Configure the client cache behavior for Vary responses.
CachingWebClientConfig	setFollowAlternativeServices(boolean followAlternativeServices)
CachingWebClientConfig	setFollowRedirects(boolean followRedirects)	Configure the default behavior of the client to follow HTTP 30x redirections.
CachingWebClientConfig	setHttp1Config(Http1ClientConfig config)
CachingWebClientConfig	setHttp2Config(Http2ClientConfig config)
CachingWebClientConfig	setHttp3Config(Http3ClientConfig config)
CachingWebClientConfig	setIdleTimeout(Duration idleTimeout)
CachingWebClientConfig	setKeepAliveTimeout(Duration keepAliveTimeout)
CachingWebClientConfig	setLogConfig(LogConfig config)
CachingWebClientConfig	setMaxRedirects(int maxRedirects)
CachingWebClientConfig	setName(String name)
CachingWebClientConfig	setObservabilityConfig(ObservabilityConfig observabilityConfig)
CachingWebClientConfig	setReadIdleTimeout(Duration idleTimeout)
CachingWebClientConfig	setShared(boolean shared)
CachingWebClientConfig	setSsl(boolean ssl)
CachingWebClientConfig	setTemplateExpandOptions(ExpandOptions templateExpandOptions)
CachingWebClientConfig	setUserAgent(String userAgent)	Sets the Web Client user agent header.
CachingWebClientConfig	setUserAgentEnabled(boolean userAgentEnabled)	Sets whether the Web Client should send a user agent header.
CachingWebClientConfig	setVerifyHost(boolean verifyHost)
CachingWebClientConfig	setVersions(HttpVersion... versions)
CachingWebClientConfig	setVersions(List<HttpVersion> versions)
CachingWebClientConfig	setWriteIdleTimeout(Duration idleTimeout)

Methods inherited from class io.vertx.ext.web.client.WebClientConfig

getTemplateExpandOptions, getUserAgent, isFollowRedirects, isUserAgentEnabled

Methods inherited from class io.vertx.core.http.HttpClientConfig

getDefaultHost, getDefaultPort, getFollowAlternativeServices, getHttp1Config, getHttp2Config, getHttp3Config, getMaxRedirects, getName, getObservabilityConfig, getQuicConfig, getRedirectConfig, getResolverConfig, getTcpConfig, getVersions, isDecompressionEnabled, isShared, isSsl, isVerifyHost, setRedirectConfig, setResolverConfig

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CACHED_STATUS_CODES

public static final Set<Integer> DEFAULT_CACHED_STATUS_CODES

DEFAULT_CACHED_METHODS

public static final Set<HttpMethod> DEFAULT_CACHED_METHODS

Constructor Detail

CachingWebClientConfig

public CachingWebClientConfig()

CachingWebClientConfig

public CachingWebClientConfig(WebClientConfig other)

Method Detail

setEnableVaryCaching

public CachingWebClientConfig setEnableVaryCaching(boolean enabled)

Configure the client cache behavior for Vary responses.

Parameters:

enabled - true to enable caching varying responses

Returns:

a reference to this, so the API can be used fluently

getCachedStatusCodes

public Set<Integer> getCachedStatusCodes()

Returns:

the set of status codes to consider cacheable.

setCachedStatusCodes

public CachingWebClientConfig setCachedStatusCodes(Set<Integer> codes)

Configure the status codes that can be cached.

Parameters:

codes - the cacheable status code numbers

Returns:

a reference to this, so the API can be used fluently

addCachedStatusCode

public CachingWebClientConfig addCachedStatusCode(Integer code)

Add a status code that is cacheable.

Parameters:

code - the additional code number

Returns:

a reference to this, so the API can be used fluently

removeCachedStatusCode

public CachingWebClientConfig removeCachedStatusCode(Integer code)

Remove a status code that is cacheable.

Parameters:

code - the code number to remove

Returns:

a reference to this, so the API can be used fluently

getCachedMethods

public Set<HttpMethod> getCachedMethods()

Returns:

the set of HTTP methods to consider cacheable.

setCachedMethods

public CachingWebClientConfig setCachedMethods(Set<HttpMethod> methods)

Configure the HTTP methods that can be cached.

Parameters:

methods - the HTTP methods to cache

Returns:

a reference to this, so the API can be used fluently

addCachedMethod

public CachingWebClientConfig addCachedMethod(HttpMethod method)

Add an HTTP method that is cacheable.

Parameters:

method - the method to add

Returns:

a reference to this, so the API can be used fluently

removeCachedMethod

public CachingWebClientConfig removeCachedMethod(HttpMethod method)

Remove an HTTP method that is cacheable.

Parameters:

method - the method to remove

Returns:

a reference to this, so the API can be used fluently

isVaryCachingEnabled

public boolean isVaryCachingEnabled()

Returns:

true if the client will cache responses with the Vary header, false otherwise

setUserAgentEnabled

public CachingWebClientConfig setUserAgentEnabled(boolean userAgentEnabled)

Description copied from class: WebClientConfig

Sets whether the Web Client should send a user agent header. Defaults to true.

Overrides:

setUserAgentEnabled in class WebClientConfig

Parameters:

userAgentEnabled - true to send a user agent header, false otherwise

Returns:

a reference to this, so the API can be used fluently

setUserAgent

public CachingWebClientConfig setUserAgent(String userAgent)

Description copied from class: WebClientConfig

Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

Overrides:

setUserAgent in class WebClientConfig

Parameters:

userAgent - user agent header value

Returns:

a reference to this, so the API can be used fluently

setFollowRedirects

public CachingWebClientConfig setFollowRedirects(boolean followRedirects)

Description copied from class: WebClientConfig

Configure the default behavior of the client to follow HTTP 30x redirections.

Overrides:

setFollowRedirects in class WebClientConfig

Parameters:

followRedirects - true when a redirect is followed

Returns:

a reference to this, so the API can be used fluently

setTemplateExpandOptions

public CachingWebClientConfig setTemplateExpandOptions(ExpandOptions templateExpandOptions)

Overrides:

setTemplateExpandOptions in class WebClientConfig

setConnectTimeout

public CachingWebClientConfig setConnectTimeout(Duration connectTimeout)

Overrides:

setConnectTimeout in class WebClientConfig

setIdleTimeout

public CachingWebClientConfig setIdleTimeout(Duration idleTimeout)

Overrides:

setIdleTimeout in class WebClientConfig

setReadIdleTimeout

public CachingWebClientConfig setReadIdleTimeout(Duration idleTimeout)

Overrides:

setReadIdleTimeout in class WebClientConfig

setWriteIdleTimeout

public CachingWebClientConfig setWriteIdleTimeout(Duration idleTimeout)

Overrides:

setWriteIdleTimeout in class WebClientConfig

setLogConfig

public CachingWebClientConfig setLogConfig(LogConfig config)

Overrides:

setLogConfig in class WebClientConfig

setSsl

public CachingWebClientConfig setSsl(boolean ssl)

Overrides:

setSsl in class WebClientConfig

setVersions

public CachingWebClientConfig setVersions(List<HttpVersion> versions)

Overrides:

setVersions in class WebClientConfig

setHttp1Config

public CachingWebClientConfig setHttp1Config(Http1ClientConfig config)

Overrides:

setHttp1Config in class WebClientConfig

setHttp2Config

public CachingWebClientConfig setHttp2Config(Http2ClientConfig config)

Overrides:

setHttp2Config in class WebClientConfig

setHttp3Config

public CachingWebClientConfig setHttp3Config(Http3ClientConfig config)

Overrides:

setHttp3Config in class WebClientConfig

setVerifyHost

public CachingWebClientConfig setVerifyHost(boolean verifyHost)

Overrides:

setVerifyHost in class WebClientConfig

setDecompressionEnabled

public CachingWebClientConfig setDecompressionEnabled(boolean decompressionEnabled)

Overrides:

setDecompressionEnabled in class WebClientConfig

setDefaultHost

public CachingWebClientConfig setDefaultHost(String defaultHost)

Overrides:

setDefaultHost in class WebClientConfig

setDefaultPort

public CachingWebClientConfig setDefaultPort(int defaultPort)

Overrides:

setDefaultPort in class WebClientConfig

setMaxRedirects

public CachingWebClientConfig setMaxRedirects(int maxRedirects)

Overrides:

setMaxRedirects in class WebClientConfig

setObservabilityConfig

public CachingWebClientConfig setObservabilityConfig(ObservabilityConfig observabilityConfig)

Overrides:

setObservabilityConfig in class WebClientConfig

setVersions

public CachingWebClientConfig setVersions(HttpVersion... versions)

Overrides:

setVersions in class WebClientConfig

setKeepAliveTimeout

public CachingWebClientConfig setKeepAliveTimeout(Duration keepAliveTimeout)

Overrides:

setKeepAliveTimeout in class WebClientConfig

setShared

public CachingWebClientConfig setShared(boolean shared)

Overrides:

setShared in class WebClientConfig

setName

public CachingWebClientConfig setName(String name)

Overrides:

setName in class WebClientConfig

setFollowAlternativeServices

public CachingWebClientConfig setFollowAlternativeServices(boolean followAlternativeServices)

Overrides:

setFollowAlternativeServices in class WebClientConfig