Module io.vertx.web.client

Package io.vertx.ext.web.client

Class WebClientOptions

java.lang.Object

io.vertx.core.net.NetworkOptions

io.vertx.core.net.TCPSSLOptions

io.vertx.core.net.ClientOptionsBase

io.vertx.core.http.HttpClientOptions

io.vertx.ext.web.client.WebClientOptions

Direct Known Subclasses:

CachingWebClientOptions

public class WebClientOptions
extends HttpClientOptions

Author:

Thomas Segismont

Field Summary

Fields

Modifier and Type	Field	Description
static ExpandOptions	DEFAULT_EXPAND_OPTIONS
static boolean	DEFAULT_FOLLOW_REDIRECTS	The default value of whether the Web Client should follow redirects = true.
static String	DEFAULT_USER_AGENT	The default user agent string = Vert.x-WebClient/<version>.
static boolean	DEFAULT_USER_AGENT_ENABLED	The default value of whether the Web Client should send a user agent header = true.

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

DEFAULT_ALPN_VERSIONS, DEFAULT_DECODER_INITIAL_BUFFER_SIZE, DEFAULT_DECOMPRESSION_SUPPORTED, DEFAULT_DEFAULT_HOST, DEFAULT_DEFAULT_PORT, DEFAULT_FORCE_SNI, DEFAULT_HTTP2_CLEAR_TEXT_UPGRADE, DEFAULT_HTTP2_CLEAR_TEXT_UPGRADE_WITH_PREFLIGHT_REQUEST, DEFAULT_HTTP2_CONNECTION_WINDOW_SIZE, DEFAULT_HTTP2_KEEP_ALIVE_TIMEOUT, DEFAULT_HTTP2_MULTIPLEXING_LIMIT, DEFAULT_HTTP2_UPGRADE_MAX_CONTENT_LENGTH, DEFAULT_KEEP_ALIVE, DEFAULT_KEEP_ALIVE_TIMEOUT, DEFAULT_MAX_CHUNK_SIZE, DEFAULT_MAX_HEADER_SIZE, DEFAULT_MAX_INITIAL_LINE_LENGTH, DEFAULT_MAX_REDIRECTS, DEFAULT_NAME, DEFAULT_PIPELINING, DEFAULT_PIPELINING_LIMIT, DEFAULT_PROTOCOL_VERSION, DEFAULT_SHARED, DEFAULT_TRACING_POLICY, DEFAULT_VERIFY_HOST

Fields inherited from class io.vertx.core.net.ClientOptionsBase

DEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME

Fields inherited from class io.vertx.core.net.TCPSSLOptions

DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, DEFAULT_READ_IDLE_TIMEOUT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_SSL_ENGINE, DEFAULT_TCP_CORK, DEFAULT_TCP_FAST_OPEN, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_QUICKACK, DEFAULT_TCP_USER_TIMEOUT, DEFAULT_WRITE_IDLE_TIMEOUT

Fields inherited from class io.vertx.core.net.NetworkOptions

DEFAULT_LOG_ACTIVITY_FORMAT, DEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS

Constructor Summary

Constructors

Constructor	Description
WebClientOptions()
WebClientOptions(HttpClientOptions other)	Copy constructor using HttpClientOptions.
WebClientOptions(JsonObject json)	Creates a new instance from JSON.
WebClientOptions(WebClientOptions other)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
WebClientOptions	addCrlPath(String crlPath)
WebClientOptions	addCrlValue(Buffer crlValue)
WebClientOptions	addEnabledCipherSuite(String suite)
WebClientOptions	addEnabledSecureTransportProtocol(String protocol)
WebClientOptions	addNonProxyHost(String nonProxyHost)
ExpandOptions	getTemplateExpandOptions()
String	getUserAgent()
boolean	isFollowRedirects()
boolean	isUserAgentEnabled()
static String	loadUserAgent()
WebClientOptions	removeEnabledSecureTransportProtocol(String protocol)
WebClientOptions	setAlpnVersions(List<HttpVersion> alpnVersions)
WebClientOptions	setConnectTimeout(int connectTimeout)
WebClientOptions	setDecoderInitialBufferSize(int decoderInitialBufferSize)
WebClientOptions	setDecompressionSupported(boolean tryUseCompression)
WebClientOptions	setDefaultHost(String defaultHost)
WebClientOptions	setDefaultPort(int defaultPort)
WebClientOptions	setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
WebClientOptions	setFollowRedirects(boolean followRedirects)	Configure the default behavior of the client to follow HTTP 30x redirections.
WebClientOptions	setForceSni(boolean forceSni)
WebClientOptions	setHttp2ClearTextUpgrade(boolean value)
WebClientOptions	setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)
WebClientOptions	setHttp2KeepAliveTimeout(int keepAliveTimeout)
WebClientOptions	setHttp2MultiplexingLimit(int limit)
WebClientOptions	setIdleTimeout(int idleTimeout)
WebClientOptions	setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
WebClientOptions	setInitialSettings(Http2Settings settings)
WebClientOptions	setKeepAlive(boolean keepAlive)
WebClientOptions	setKeepAliveTimeout(int keepAliveTimeout)
WebClientOptions	setKeyCertOptions(KeyCertOptions options)
WebClientOptions	setLocalAddress(String localAddress)
WebClientOptions	setLogActivity(boolean logEnabled)
WebClientOptions	setMaxChunkSize(int maxChunkSize)
WebClientOptions	setMaxHeaderSize(int maxHeaderSize)
WebClientOptions	setMaxInitialLineLength(int maxInitialLineLength)
WebClientOptions	setMaxRedirects(int maxRedirects)
WebClientOptions	setMetricsName(String metricsName)
WebClientOptions	setName(String name)
WebClientOptions	setNonProxyHosts(List<String> nonProxyHosts)
WebClientOptions	setPipelining(boolean pipelining)
WebClientOptions	setPipeliningLimit(int limit)
WebClientOptions	setProtocolVersion(HttpVersion protocolVersion)
WebClientOptions	setProxyOptions(ProxyOptions proxyOptions)
WebClientOptions	setReadIdleTimeout(int idleTimeout)
WebClientOptions	setReceiveBufferSize(int receiveBufferSize)
WebClientOptions	setReuseAddress(boolean reuseAddress)
WebClientOptions	setReusePort(boolean reusePort)
WebClientOptions	setSendBufferSize(int sendBufferSize)
WebClientOptions	setShared(boolean shared)
WebClientOptions	setSoLinger(int soLinger)
WebClientOptions	setSsl(boolean ssl)
WebClientOptions	setSslEngineOptions(SSLEngineOptions sslEngineOptions)
WebClientOptions	setSslHandshakeTimeout(long sslHandshakeTimeout)
WebClientOptions	setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)
WebClientOptions	setTcpCork(boolean tcpCork)
WebClientOptions	setTcpFastOpen(boolean tcpFastOpen)
WebClientOptions	setTcpKeepAlive(boolean tcpKeepAlive)
WebClientOptions	setTcpNoDelay(boolean tcpNoDelay)
WebClientOptions	setTcpQuickAck(boolean tcpQuickAck)
WebClientOptions	setTemplateExpandOptions(ExpandOptions templateExpandOptions)
WebClientOptions	setTracingPolicy(TracingPolicy tracingPolicy)
WebClientOptions	setTrafficClass(int trafficClass)
WebClientOptions	setTrustAll(boolean trustAll)
WebClientOptions	setTrustOptions(TrustOptions options)
WebClientOptions	setUseAlpn(boolean useAlpn)
WebClientOptions	setUserAgent(String userAgent)	Sets the Web Client user agent header.
WebClientOptions	setUserAgentEnabled(boolean userAgentEnabled)	Sets whether the Web Client should send a user agent header.
WebClientOptions	setVerifyHost(boolean verifyHost)
WebClientOptions	setWriteIdleTimeout(int idleTimeout)
JsonObject	toJson()	Convert to JSON

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

getAlpnVersions, getDecoderInitialBufferSize, getDefaultHost, getDefaultPort, getHttp2ConnectionWindowSize, getHttp2KeepAliveTimeout, getHttp2MultiplexingLimit, getHttp2UpgradeMaxContentLength, getInitialSettings, getKeepAliveTimeout, getMaxChunkSize, getMaxHeaderSize, getMaxInitialLineLength, getMaxRedirects, getName, getPipeliningLimit, getProtocolVersion, getTracingPolicy, isDecompressionSupported, isForceSni, isHttp2ClearTextUpgrade, isHttp2ClearTextUpgradeWithPreflightRequest, isKeepAlive, isPipelining, isShared, isVerifyHost, removeEnabledCipherSuite, setActivityLogDataFormat, setHttp2ClearTextUpgradeWithPreflightRequest, setHttp2UpgradeMaxContentLength, setTcpUserTimeout

Methods inherited from class io.vertx.core.net.ClientOptionsBase

getConnectTimeout, getLocalAddress, getMetricsName, getNonProxyHosts, getOrCreateSSLOptions, getProxyOptions, getSslOptions, isTrustAll

Methods inherited from class io.vertx.core.net.TCPSSLOptions

getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getKeyCertOptions, getReadIdleTimeout, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getTcpUserTimeout, getTrustOptions, getWriteIdleTimeout, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn

Methods inherited from class io.vertx.core.net.NetworkOptions

getActivityLogDataFormat, getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePort

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_USER_AGENT_ENABLED

public static final boolean DEFAULT_USER_AGENT_ENABLED

The default value of whether the Web Client should send a user agent header = true.

See Also:

Constant Field Values

DEFAULT_USER_AGENT

public static final String DEFAULT_USER_AGENT

The default user agent string = Vert.x-WebClient/<version>.

DEFAULT_FOLLOW_REDIRECTS

public static final boolean DEFAULT_FOLLOW_REDIRECTS

The default value of whether the Web Client should follow redirects = true.

See Also:

Constant Field Values

DEFAULT_EXPAND_OPTIONS

public static final ExpandOptions DEFAULT_EXPAND_OPTIONS

Constructor Detail

WebClientOptions

public WebClientOptions()

WebClientOptions

public WebClientOptions(WebClientOptions other)

Copy constructor.

Parameters:

other - the options to copy

WebClientOptions

public WebClientOptions(HttpClientOptions other)

Copy constructor using HttpClientOptions.

Parameters:

other - the options to copy

WebClientOptions

public WebClientOptions(JsonObject json)

Creates a new instance from JSON.

Parameters:

json - the JSON object

Method Detail

toJson

public JsonObject toJson()

Convert to JSON

Overrides:

toJson in class HttpClientOptions

Returns:

the JSON

isUserAgentEnabled

public boolean isUserAgentEnabled()

Returns:

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

setUserAgentEnabled

public WebClientOptions 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 WebClientOptions 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 WebClientOptions 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 WebClientOptions setTemplateExpandOptions(ExpandOptions templateExpandOptions)

setMaxRedirects

public WebClientOptions setMaxRedirects(int maxRedirects)

Overrides:

setMaxRedirects in class HttpClientOptions

setSendBufferSize

public WebClientOptions setSendBufferSize(int sendBufferSize)

Overrides:

setSendBufferSize in class HttpClientOptions

setReceiveBufferSize

public WebClientOptions setReceiveBufferSize(int receiveBufferSize)

Overrides:

setReceiveBufferSize in class HttpClientOptions

setReuseAddress

public WebClientOptions setReuseAddress(boolean reuseAddress)

Overrides:

setReuseAddress in class HttpClientOptions

setTrafficClass

public WebClientOptions setTrafficClass(int trafficClass)

Overrides:

setTrafficClass in class HttpClientOptions

setTcpNoDelay

public WebClientOptions setTcpNoDelay(boolean tcpNoDelay)

Overrides:

setTcpNoDelay in class HttpClientOptions

setTcpKeepAlive

public WebClientOptions setTcpKeepAlive(boolean tcpKeepAlive)

Overrides:

setTcpKeepAlive in class HttpClientOptions

setSoLinger

public WebClientOptions setSoLinger(int soLinger)

Overrides:

setSoLinger in class HttpClientOptions

setIdleTimeout

public WebClientOptions setIdleTimeout(int idleTimeout)

Overrides:

setIdleTimeout in class HttpClientOptions

setIdleTimeoutUnit

public WebClientOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)

Overrides:

setIdleTimeoutUnit in class HttpClientOptions

setSsl

public WebClientOptions setSsl(boolean ssl)

Overrides:

setSsl in class HttpClientOptions

setKeyCertOptions

public WebClientOptions setKeyCertOptions(KeyCertOptions options)

Overrides:

setKeyCertOptions in class HttpClientOptions

setTrustOptions

public WebClientOptions setTrustOptions(TrustOptions options)

Overrides:

setTrustOptions in class HttpClientOptions

addEnabledCipherSuite

public WebClientOptions addEnabledCipherSuite(String suite)

Overrides:

addEnabledCipherSuite in class HttpClientOptions

addCrlPath

public WebClientOptions addCrlPath(String crlPath)
                            throws NullPointerException

Overrides:

addCrlPath in class HttpClientOptions

Throws:

NullPointerException

addCrlValue

public WebClientOptions addCrlValue(Buffer crlValue)
                             throws NullPointerException

Overrides:

addCrlValue in class HttpClientOptions

Throws:

NullPointerException

setConnectTimeout

public WebClientOptions setConnectTimeout(int connectTimeout)

Overrides:

setConnectTimeout in class HttpClientOptions

setTrustAll

public WebClientOptions setTrustAll(boolean trustAll)

Overrides:

setTrustAll in class HttpClientOptions

setHttp2MultiplexingLimit

public WebClientOptions setHttp2MultiplexingLimit(int limit)

Overrides:

setHttp2MultiplexingLimit in class HttpClientOptions

setHttp2ConnectionWindowSize

public WebClientOptions setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)

Overrides:

setHttp2ConnectionWindowSize in class HttpClientOptions

setKeepAlive

public WebClientOptions setKeepAlive(boolean keepAlive)

Overrides:

setKeepAlive in class HttpClientOptions

setPipelining

public WebClientOptions setPipelining(boolean pipelining)

Overrides:

setPipelining in class HttpClientOptions

setPipeliningLimit

public WebClientOptions setPipeliningLimit(int limit)

Overrides:

setPipeliningLimit in class HttpClientOptions

setVerifyHost

public WebClientOptions setVerifyHost(boolean verifyHost)

Overrides:

setVerifyHost in class HttpClientOptions

setDecompressionSupported

public WebClientOptions setDecompressionSupported(boolean tryUseCompression)

Overrides:

setDecompressionSupported in class HttpClientOptions

setDefaultHost

public WebClientOptions setDefaultHost(String defaultHost)

Overrides:

setDefaultHost in class HttpClientOptions

setDefaultPort

public WebClientOptions setDefaultPort(int defaultPort)

Overrides:

setDefaultPort in class HttpClientOptions

setMaxChunkSize

public WebClientOptions setMaxChunkSize(int maxChunkSize)

Overrides:

setMaxChunkSize in class HttpClientOptions

setProtocolVersion

public WebClientOptions setProtocolVersion(HttpVersion protocolVersion)

Overrides:

setProtocolVersion in class HttpClientOptions

setMaxHeaderSize

public WebClientOptions setMaxHeaderSize(int maxHeaderSize)

Overrides:

setMaxHeaderSize in class HttpClientOptions

setUseAlpn

public WebClientOptions setUseAlpn(boolean useAlpn)

Overrides:

setUseAlpn in class HttpClientOptions

setSslEngineOptions

public WebClientOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)

Overrides:

setSslEngineOptions in class HttpClientOptions

setHttp2ClearTextUpgrade

public WebClientOptions setHttp2ClearTextUpgrade(boolean value)

Overrides:

setHttp2ClearTextUpgrade in class HttpClientOptions

setAlpnVersions

public WebClientOptions setAlpnVersions(List<HttpVersion> alpnVersions)

Overrides:

setAlpnVersions in class HttpClientOptions

setMetricsName

public WebClientOptions setMetricsName(String metricsName)

Overrides:

setMetricsName in class HttpClientOptions

setProxyOptions

public WebClientOptions setProxyOptions(ProxyOptions proxyOptions)

Overrides:

setProxyOptions in class HttpClientOptions

setLocalAddress

public WebClientOptions setLocalAddress(String localAddress)

Overrides:

setLocalAddress in class HttpClientOptions

setLogActivity

public WebClientOptions setLogActivity(boolean logEnabled)

Overrides:

setLogActivity in class HttpClientOptions

addEnabledSecureTransportProtocol

public WebClientOptions addEnabledSecureTransportProtocol(String protocol)

Overrides:

addEnabledSecureTransportProtocol in class HttpClientOptions

removeEnabledSecureTransportProtocol

public WebClientOptions removeEnabledSecureTransportProtocol(String protocol)

Overrides:

removeEnabledSecureTransportProtocol in class HttpClientOptions

setEnabledSecureTransportProtocols

public WebClientOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)

Overrides:

setEnabledSecureTransportProtocols in class HttpClientOptions

setReusePort

public WebClientOptions setReusePort(boolean reusePort)

Overrides:

setReusePort in class HttpClientOptions

setTcpFastOpen

public WebClientOptions setTcpFastOpen(boolean tcpFastOpen)

Overrides:

setTcpFastOpen in class HttpClientOptions

setTcpCork

public WebClientOptions setTcpCork(boolean tcpCork)

Overrides:

setTcpCork in class HttpClientOptions

setTcpQuickAck

public WebClientOptions setTcpQuickAck(boolean tcpQuickAck)

Overrides:

setTcpQuickAck in class HttpClientOptions

setHttp2KeepAliveTimeout

public WebClientOptions setHttp2KeepAliveTimeout(int keepAliveTimeout)

Overrides:

setHttp2KeepAliveTimeout in class HttpClientOptions

setForceSni

public WebClientOptions setForceSni(boolean forceSni)

Overrides:

setForceSni in class HttpClientOptions

setDecoderInitialBufferSize

public WebClientOptions setDecoderInitialBufferSize(int decoderInitialBufferSize)

Overrides:

setDecoderInitialBufferSize in class HttpClientOptions

setKeepAliveTimeout

public WebClientOptions setKeepAliveTimeout(int keepAliveTimeout)

Overrides:

setKeepAliveTimeout in class HttpClientOptions

setMaxInitialLineLength

public WebClientOptions setMaxInitialLineLength(int maxInitialLineLength)

Overrides:

setMaxInitialLineLength in class HttpClientOptions

setInitialSettings

public WebClientOptions setInitialSettings(Http2Settings settings)

Overrides:

setInitialSettings in class HttpClientOptions

setSslHandshakeTimeout

public WebClientOptions setSslHandshakeTimeout(long sslHandshakeTimeout)

Overrides:

setSslHandshakeTimeout in class HttpClientOptions

setSslHandshakeTimeoutUnit

public WebClientOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)

Overrides:

setSslHandshakeTimeoutUnit in class HttpClientOptions

setReadIdleTimeout

public WebClientOptions setReadIdleTimeout(int idleTimeout)

Overrides:

setReadIdleTimeout in class HttpClientOptions

setWriteIdleTimeout

public WebClientOptions setWriteIdleTimeout(int idleTimeout)

Overrides:

setWriteIdleTimeout in class HttpClientOptions

setNonProxyHosts

public WebClientOptions setNonProxyHosts(List<String> nonProxyHosts)

Overrides:

setNonProxyHosts in class HttpClientOptions

addNonProxyHost

public WebClientOptions addNonProxyHost(String nonProxyHost)

Overrides:

addNonProxyHost in class HttpClientOptions

setTracingPolicy

public WebClientOptions setTracingPolicy(TracingPolicy tracingPolicy)

Overrides:

setTracingPolicy in class HttpClientOptions

setShared

public WebClientOptions setShared(boolean shared)

Overrides:

setShared in class HttpClientOptions

setName

public WebClientOptions setName(String name)

Overrides:

setName in class HttpClientOptions

loadUserAgent

public static String loadUserAgent()