public class WebClientOptions
extends io.vertx.core.http.HttpClientOptions
Modifier and Type | Field and Description |
---|---|
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.
|
DEFAULT_ALPN_VERSIONS, DEFAULT_DECODER_INITIAL_BUFFER_SIZE, DEFAULT_DEFAULT_HOST, DEFAULT_DEFAULT_PORT, DEFAULT_FORCE_SNI, DEFAULT_HTTP2_CLEAR_TEXT_UPGRADE, DEFAULT_HTTP2_CONNECTION_WINDOW_SIZE, DEFAULT_HTTP2_KEEP_ALIVE_TIMEOUT, DEFAULT_HTTP2_MAX_POOL_SIZE, DEFAULT_HTTP2_MULTIPLEXING_LIMIT, DEFAULT_KEEP_ALIVE, DEFAULT_KEEP_ALIVE_TIMEOUT, DEFAULT_MAX_CHUNK_SIZE, DEFAULT_MAX_HEADER_SIZE, DEFAULT_MAX_INITIAL_LINE_LENGTH, DEFAULT_MAX_POOL_SIZE, DEFAULT_MAX_REDIRECTS, DEFAULT_MAX_WAIT_QUEUE_SIZE, DEFAULT_MAX_WEBSOCKET_FRAME_SIZE, DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE, DEFAULT_PIPELINING, DEFAULT_PIPELINING_LIMIT, DEFAULT_POOL_CLEANER_PERIOD, DEFAULT_PROTOCOL_VERSION, DEFAULT_SEND_UNMASKED_FRAMES, DEFAULT_TRY_USE_COMPRESSION, DEFAULT_TRY_USE_PER_FRAME_WEBSOCKET_COMPRESSION, DEFAULT_TRY_USE_PER_MESSAGE_WEBSOCKET_COMPRESSION, DEFAULT_VERIFY_HOST, DEFAULT_WEBSOCKET_ALLOW_CLIENT_NO_CONTEXT, DEFAULT_WEBSOCKET_CLOSING_TIMEOUT, DEFAULT_WEBSOCKET_COMPRESSION_LEVEL, DEFAULT_WEBSOCKET_REQUEST_SERVER_NO_CONTEXT
DEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME, DEFAULT_TRUST_ALL
DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS, DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_SSL_ENGINE, DEFAULT_SSL_HANDSHAKE_TIMEOUT, DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT, DEFAULT_TCP_CORK, DEFAULT_TCP_FAST_OPEN, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_QUICKACK, DEFAULT_USE_ALPN, DEFAULT_USE_POOLED_BUFFERS
Constructor and Description |
---|
WebClientOptions() |
WebClientOptions(io.vertx.core.http.HttpClientOptions other)
Copy constructor using
HttpClientOptions . |
WebClientOptions(io.vertx.core.json.JsonObject json)
Creates a new instance from JSON.
|
WebClientOptions(WebClientOptions other)
Copy constructor.
|
equals, getAlpnVersions, getDecoderInitialBufferSize, getDefaultHost, getDefaultPort, getHttp2ConnectionWindowSize, getHttp2KeepAliveTimeout, getHttp2MaxPoolSize, getHttp2MultiplexingLimit, getInitialSettings, getKeepAliveTimeout, getMaxChunkSize, getMaxHeaderSize, getMaxInitialLineLength, getMaxPoolSize, getMaxRedirects, getMaxWaitQueueSize, getMaxWebsocketFrameSize, getMaxWebSocketFrameSize, getMaxWebsocketMessageSize, getMaxWebSocketMessageSize, getPipeliningLimit, getPoolCleanerPeriod, getProtocolVersion, getTryUsePerMessageWebsocketCompression, getTryUsePerMessageWebSocketCompression, getTryWebsocketDeflateFrameCompression, getTryWebSocketDeflateFrameCompression, getWebSocketClosingTimeout, getWebsocketCompressionAllowClientNoContext, getWebSocketCompressionAllowClientNoContext, getWebsocketCompressionLevel, getWebSocketCompressionLevel, getWebsocketCompressionRequestServerNoContext, getWebSocketCompressionRequestServerNoContext, hashCode, isForceSni, isHttp2ClearTextUpgrade, isKeepAlive, isPipelining, isSendUnmaskedFrames, isTryUseCompression, isVerifyHost, setMaxWebsocketFrameSize, setMaxWebsocketMessageSize, setTryUsePerFrameWebsocketCompression, setTryUsePerMessageWebsocketCompression, setWebSocketClosingTimeout, setWebsocketCompressionAllowClientNoContext, setWebsocketCompressionLevel, setWebsocketCompressionRequestServerNoContext
getConnectTimeout, getLocalAddress, getMetricsName, getProxyOptions, isTrustAll
getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getTrustOptions, getTrustStoreOptions, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn, isUsePooledBuffers
public static final boolean DEFAULT_USER_AGENT_ENABLED
public static final String DEFAULT_USER_AGENT
public static final boolean DEFAULT_FOLLOW_REDIRECTS
public WebClientOptions()
public WebClientOptions(WebClientOptions other)
other
- the options to copypublic WebClientOptions(io.vertx.core.http.HttpClientOptions other)
HttpClientOptions
.other
- the options to copypublic WebClientOptions(io.vertx.core.json.JsonObject json)
json
- the JSON objectpublic io.vertx.core.json.JsonObject toJson()
toJson
in class io.vertx.core.http.HttpClientOptions
public boolean isUserAgentEnabled()
public WebClientOptions setUserAgentEnabled(boolean userAgentEnabled)
userAgentEnabled
- true to send a user agent header, false otherwisepublic String getUserAgent()
public WebClientOptions setUserAgent(String userAgent)
userAgent
- user agent header valuepublic boolean isFollowRedirects()
30x
redirectionspublic WebClientOptions setFollowRedirects(boolean followRedirects)
30x
redirections.followRedirects
- true when a redirect is followedpublic WebClientOptions setMaxRedirects(int maxRedirects)
setMaxRedirects
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setSendBufferSize(int sendBufferSize)
setSendBufferSize
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setReceiveBufferSize(int receiveBufferSize)
setReceiveBufferSize
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setReuseAddress(boolean reuseAddress)
setReuseAddress
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setTrafficClass(int trafficClass)
setTrafficClass
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setTcpNoDelay(boolean tcpNoDelay)
setTcpNoDelay
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setTcpKeepAlive(boolean tcpKeepAlive)
setTcpKeepAlive
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setSoLinger(int soLinger)
setSoLinger
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setUsePooledBuffers(boolean usePooledBuffers)
setUsePooledBuffers
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setIdleTimeout(int idleTimeout)
setIdleTimeout
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
setIdleTimeoutUnit
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setSsl(boolean ssl)
setSsl
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setKeyCertOptions(io.vertx.core.net.KeyCertOptions options)
setKeyCertOptions
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setKeyStoreOptions(io.vertx.core.net.JksOptions options)
setKeyStoreOptions
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setPfxKeyCertOptions(io.vertx.core.net.PfxOptions options)
setPfxKeyCertOptions
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setTrustOptions(io.vertx.core.net.TrustOptions options)
setTrustOptions
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setPemKeyCertOptions(io.vertx.core.net.PemKeyCertOptions options)
setPemKeyCertOptions
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setTrustStoreOptions(io.vertx.core.net.JksOptions options)
setTrustStoreOptions
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setPfxTrustOptions(io.vertx.core.net.PfxOptions options)
setPfxTrustOptions
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setPemTrustOptions(io.vertx.core.net.PemTrustOptions options)
setPemTrustOptions
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions addEnabledCipherSuite(String suite)
addEnabledCipherSuite
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions addCrlPath(String crlPath) throws NullPointerException
addCrlPath
in class io.vertx.core.http.HttpClientOptions
NullPointerException
public WebClientOptions addCrlValue(io.vertx.core.buffer.Buffer crlValue) throws NullPointerException
addCrlValue
in class io.vertx.core.http.HttpClientOptions
NullPointerException
public WebClientOptions setConnectTimeout(int connectTimeout)
setConnectTimeout
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setTrustAll(boolean trustAll)
setTrustAll
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setMaxPoolSize(int maxPoolSize)
setMaxPoolSize
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setHttp2MultiplexingLimit(int limit)
setHttp2MultiplexingLimit
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setHttp2MaxPoolSize(int max)
setHttp2MaxPoolSize
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)
setHttp2ConnectionWindowSize
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setKeepAlive(boolean keepAlive)
setKeepAlive
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setPipelining(boolean pipelining)
setPipelining
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setPipeliningLimit(int limit)
setPipeliningLimit
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setVerifyHost(boolean verifyHost)
setVerifyHost
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setTryUseCompression(boolean tryUseCompression)
setTryUseCompression
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setSendUnmaskedFrames(boolean sendUnmaskedFrames)
setSendUnmaskedFrames
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setMaxWebSocketFrameSize(int maxWebsocketFrameSize)
setMaxWebSocketFrameSize
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setDefaultHost(String defaultHost)
setDefaultHost
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setDefaultPort(int defaultPort)
setDefaultPort
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setMaxChunkSize(int maxChunkSize)
setMaxChunkSize
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setProtocolVersion(io.vertx.core.http.HttpVersion protocolVersion)
setProtocolVersion
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setMaxHeaderSize(int maxHeaderSize)
setMaxHeaderSize
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setMaxWaitQueueSize(int maxWaitQueueSize)
setMaxWaitQueueSize
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setUseAlpn(boolean useAlpn)
setUseAlpn
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setSslEngineOptions(io.vertx.core.net.SSLEngineOptions sslEngineOptions)
setSslEngineOptions
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setJdkSslEngineOptions(io.vertx.core.net.JdkSSLEngineOptions sslEngineOptions)
setJdkSslEngineOptions
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setOpenSslEngineOptions(io.vertx.core.net.OpenSSLEngineOptions sslEngineOptions)
setOpenSslEngineOptions
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setHttp2ClearTextUpgrade(boolean value)
setHttp2ClearTextUpgrade
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setAlpnVersions(List<io.vertx.core.http.HttpVersion> alpnVersions)
setAlpnVersions
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setMetricsName(String metricsName)
setMetricsName
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setProxyOptions(io.vertx.core.net.ProxyOptions proxyOptions)
setProxyOptions
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setLocalAddress(String localAddress)
setLocalAddress
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setLogActivity(boolean logEnabled)
setLogActivity
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions addEnabledSecureTransportProtocol(String protocol)
addEnabledSecureTransportProtocol
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions removeEnabledSecureTransportProtocol(String protocol)
removeEnabledSecureTransportProtocol
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
setEnabledSecureTransportProtocols
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setReusePort(boolean reusePort)
setReusePort
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setTcpFastOpen(boolean tcpFastOpen)
setTcpFastOpen
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setTcpCork(boolean tcpCork)
setTcpCork
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setTcpQuickAck(boolean tcpQuickAck)
setTcpQuickAck
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setHttp2KeepAliveTimeout(int keepAliveTimeout)
setHttp2KeepAliveTimeout
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setForceSni(boolean forceSni)
setForceSni
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setDecoderInitialBufferSize(int decoderInitialBufferSize)
setDecoderInitialBufferSize
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setPoolCleanerPeriod(int poolCleanerPeriod)
setPoolCleanerPeriod
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setKeepAliveTimeout(int keepAliveTimeout)
setKeepAliveTimeout
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setMaxWebSocketMessageSize(int maxWebsocketMessageSize)
setMaxWebSocketMessageSize
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setMaxInitialLineLength(int maxInitialLineLength)
setMaxInitialLineLength
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setInitialSettings(io.vertx.core.http.Http2Settings settings)
setInitialSettings
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setSslHandshakeTimeout(long sslHandshakeTimeout)
setSslHandshakeTimeout
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)
setSslHandshakeTimeoutUnit
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setTryUsePerFrameWebSocketCompression(boolean offer)
setTryUsePerFrameWebSocketCompression
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setTryUsePerMessageWebSocketCompression(boolean offer)
setTryUsePerMessageWebSocketCompression
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setWebSocketCompressionLevel(int compressionLevel)
setWebSocketCompressionLevel
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setWebSocketCompressionAllowClientNoContext(boolean offer)
setWebSocketCompressionAllowClientNoContext
in class io.vertx.core.http.HttpClientOptions
public WebClientOptions setWebSocketCompressionRequestServerNoContext(boolean offer)
setWebSocketCompressionRequestServerNoContext
in class io.vertx.core.http.HttpClientOptions
public static String loadUserAgent()
Copyright © 2020 Eclipse. All rights reserved.