Module io.vertx.web.client

Package io.vertx.ext.web.client

Class WebClientConfig

java.lang.Object

io.vertx.core.http.HttpClientConfig

io.vertx.ext.web.client.WebClientConfig

Direct Known Subclasses:

CachingWebClientConfig

public class WebClientConfig
extends HttpClientConfig

Author:

Thomas Segismont

Field Summary

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
WebClientConfig()
WebClientConfig(HttpClientConfig other)	Copy constructor.
WebClientConfig(WebClientConfig other)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
ExpandOptions	getTemplateExpandOptions()
String	getUserAgent()
boolean	isFollowRedirects()
boolean	isUserAgentEnabled()
WebClientConfig	setConnectTimeout(Duration connectTimeout)
WebClientConfig	setDecompressionEnabled(boolean decompressionEnabled)
WebClientConfig	setDefaultHost(String defaultHost)
WebClientConfig	setDefaultPort(int defaultPort)
WebClientConfig	setFollowAlternativeServices(boolean followAlternativeServices)
WebClientConfig	setFollowRedirects(boolean followRedirects)	Configure the default behavior of the client to follow HTTP 30x redirections.
WebClientConfig	setHttp1Config(Http1ClientConfig config)
WebClientConfig	setHttp2Config(Http2ClientConfig config)
WebClientConfig	setHttp3Config(Http3ClientConfig config)
WebClientConfig	setIdleTimeout(Duration idleTimeout)
WebClientConfig	setKeepAliveTimeout(Duration keepAliveTimeout)
WebClientConfig	setLogConfig(LogConfig config)
WebClientConfig	setMaxRedirects(int maxRedirects)
WebClientConfig	setName(String name)
WebClientConfig	setObservabilityConfig(ObservabilityConfig observabilityConfig)
WebClientConfig	setReadIdleTimeout(Duration idleTimeout)
WebClientConfig	setShared(boolean shared)
WebClientConfig	setSsl(boolean ssl)
WebClientConfig	setTemplateExpandOptions(ExpandOptions templateExpandOptions)
WebClientConfig	setUserAgent(String userAgent)	Sets the Web Client user agent header.
WebClientConfig	setUserAgentEnabled(boolean userAgentEnabled)	Sets whether the Web Client should send a user agent header.
WebClientConfig	setVerifyHost(boolean verifyHost)
WebClientConfig	setVersions(HttpVersion... versions)
WebClientConfig	setVersions(List<HttpVersion> versions)
WebClientConfig	setWriteIdleTimeout(Duration idleTimeout)

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

Constructor Detail

WebClientConfig

public WebClientConfig()

WebClientConfig

public WebClientConfig(WebClientConfig other)

Copy constructor.

Parameters:

other - the options to copy

WebClientConfig

public WebClientConfig(HttpClientConfig other)

Copy constructor.

Parameters:

other - the options to copy

Method Detail

isUserAgentEnabled

public boolean isUserAgentEnabled()

Returns:

true if the Web Client should send a user agent header, false otherwise

setUserAgentEnabled

public WebClientConfig setUserAgentEnabled(boolean userAgentEnabled)

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

Parameters:

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

Returns:

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

getUserAgent

public String getUserAgent()

Returns:

the user agent header string

setUserAgent

public WebClientConfig setUserAgent(String userAgent)

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

Parameters:

userAgent - user agent header value

Returns:

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

isFollowRedirects

public boolean isFollowRedirects()

Returns:

the default behavior of the client for following HTTP 30x redirections

setFollowRedirects

public WebClientConfig setFollowRedirects(boolean followRedirects)

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

Parameters:

followRedirects - true when a redirect is followed

Returns:

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

getTemplateExpandOptions

public ExpandOptions getTemplateExpandOptions()

setTemplateExpandOptions

public WebClientConfig setTemplateExpandOptions(ExpandOptions templateExpandOptions)

setKeepAliveTimeout

public WebClientConfig setKeepAliveTimeout(Duration keepAliveTimeout)

Overrides:

setKeepAliveTimeout in class HttpClientConfig

setVersions

public WebClientConfig setVersions(HttpVersion... versions)

Overrides:

setVersions in class HttpClientConfig

setConnectTimeout

public WebClientConfig setConnectTimeout(Duration connectTimeout)

Overrides:

setConnectTimeout in class HttpClientConfig

setIdleTimeout

public WebClientConfig setIdleTimeout(Duration idleTimeout)

Overrides:

setIdleTimeout in class HttpClientConfig

setReadIdleTimeout

public WebClientConfig setReadIdleTimeout(Duration idleTimeout)

Overrides:

setReadIdleTimeout in class HttpClientConfig

setWriteIdleTimeout

public WebClientConfig setWriteIdleTimeout(Duration idleTimeout)

Overrides:

setWriteIdleTimeout in class HttpClientConfig

setLogConfig

public WebClientConfig setLogConfig(LogConfig config)

Overrides:

setLogConfig in class HttpClientConfig

setSsl

public WebClientConfig setSsl(boolean ssl)

Overrides:

setSsl in class HttpClientConfig

setVersions

public WebClientConfig setVersions(List<HttpVersion> versions)

Overrides:

setVersions in class HttpClientConfig

setHttp1Config

public WebClientConfig setHttp1Config(Http1ClientConfig config)

Overrides:

setHttp1Config in class HttpClientConfig

setHttp2Config

public WebClientConfig setHttp2Config(Http2ClientConfig config)

Overrides:

setHttp2Config in class HttpClientConfig

setHttp3Config

public WebClientConfig setHttp3Config(Http3ClientConfig config)

Overrides:

setHttp3Config in class HttpClientConfig

setVerifyHost

public WebClientConfig setVerifyHost(boolean verifyHost)

Overrides:

setVerifyHost in class HttpClientConfig

setDecompressionEnabled

public WebClientConfig setDecompressionEnabled(boolean decompressionEnabled)

Overrides:

setDecompressionEnabled in class HttpClientConfig

setDefaultHost

public WebClientConfig setDefaultHost(String defaultHost)

Overrides:

setDefaultHost in class HttpClientConfig

setDefaultPort

public WebClientConfig setDefaultPort(int defaultPort)

Overrides:

setDefaultPort in class HttpClientConfig

setMaxRedirects

public WebClientConfig setMaxRedirects(int maxRedirects)

Overrides:

setMaxRedirects in class HttpClientConfig

setObservabilityConfig

public WebClientConfig setObservabilityConfig(ObservabilityConfig observabilityConfig)

Overrides:

setObservabilityConfig in class HttpClientConfig

setShared

public WebClientConfig setShared(boolean shared)

Overrides:

setShared in class HttpClientConfig

setName

public WebClientConfig setName(String name)

Overrides:

setName in class HttpClientConfig

setFollowAlternativeServices

public WebClientConfig setFollowAlternativeServices(boolean followAlternativeServices)

Overrides:

setFollowAlternativeServices in class HttpClientConfig