public class WebClientOptions extends 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_WEBSOCKET_DEFLATE_FRAME, DEFAULT_TRY_USE_WEBSOCKET_PERMESSAGE_DEFLATE, DEFAULT_VERIFY_HOST, DEFAULT_WEBSOCKET_COMPRESSION_ALLOW_CLIENT_NO_CONTEXT, DEFAULT_WEBSOCKET_COMPRESSION_LEVEL, DEFAULT_WEBSOCKET_COMPRESSION_REQUEST_SERVER_NO_CONTEXTDEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME, DEFAULT_TRUST_ALLDEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS, DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, 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_USE_ALPN, DEFAULT_USE_POOLED_BUFFERSDEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS| Constructor and Description |
|---|
WebClientOptions() |
WebClientOptions(HttpClientOptions other)
Copy constructor using
HttpClientOptions. |
WebClientOptions(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, getMaxWebsocketMessageSize, getPipeliningLimit, getPoolCleanerPeriod, getProtocolVersion, getWebsocketCompressionAllowClientNoContext, getWebsocketCompressionLevel, getWebsocketCompressionRequestServerNoContext, hashCode, isForceSni, isHttp2ClearTextUpgrade, isKeepAlive, isPipelining, isSendUnmaskedFrames, isTryUseCompression, isVerifyHost, setTryUsePerFrameWebsocketCompression, setTryUsePerMessageWebsocketCompression, setWebsocketCompressionAllowClientNoContext, setWebsocketCompressionLevel, setWebsocketCompressionRequestServerNoContext, tryUsePerMessageWebsocketCompression, tryWebsocketDeflateFrameCompressiongetConnectTimeout, getLocalAddress, getMetricsName, getProxyOptions, isTrustAllgetCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getSoLinger, getSslEngineOptions, getTrustOptions, getTrustStoreOptions, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn, isUsePooledBuffersgetLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePortpublic 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(HttpClientOptions other)
HttpClientOptions.other - the options to copypublic WebClientOptions(JsonObject json)
json - the JSON objectpublic JsonObject toJson()
toJson in class HttpClientOptionspublic 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 HttpClientOptionspublic WebClientOptions setSendBufferSize(int sendBufferSize)
setSendBufferSize in class HttpClientOptionspublic WebClientOptions setReceiveBufferSize(int receiveBufferSize)
setReceiveBufferSize in class HttpClientOptionspublic WebClientOptions setReuseAddress(boolean reuseAddress)
setReuseAddress in class HttpClientOptionspublic WebClientOptions setTrafficClass(int trafficClass)
setTrafficClass in class HttpClientOptionspublic WebClientOptions setTcpNoDelay(boolean tcpNoDelay)
setTcpNoDelay in class HttpClientOptionspublic WebClientOptions setTcpKeepAlive(boolean tcpKeepAlive)
setTcpKeepAlive in class HttpClientOptionspublic WebClientOptions setSoLinger(int soLinger)
setSoLinger in class HttpClientOptionspublic WebClientOptions setUsePooledBuffers(boolean usePooledBuffers)
setUsePooledBuffers in class HttpClientOptionspublic WebClientOptions setIdleTimeout(int idleTimeout)
setIdleTimeout in class HttpClientOptionspublic WebClientOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
setIdleTimeoutUnit in class HttpClientOptionspublic WebClientOptions setSsl(boolean ssl)
setSsl in class HttpClientOptionspublic WebClientOptions setKeyCertOptions(KeyCertOptions options)
setKeyCertOptions in class HttpClientOptionspublic WebClientOptions setKeyStoreOptions(JksOptions options)
setKeyStoreOptions in class HttpClientOptionspublic WebClientOptions setPfxKeyCertOptions(PfxOptions options)
setPfxKeyCertOptions in class HttpClientOptionspublic WebClientOptions setTrustOptions(TrustOptions options)
setTrustOptions in class HttpClientOptionspublic WebClientOptions setPemKeyCertOptions(PemKeyCertOptions options)
setPemKeyCertOptions in class HttpClientOptionspublic WebClientOptions setTrustStoreOptions(JksOptions options)
setTrustStoreOptions in class HttpClientOptionspublic WebClientOptions setPfxTrustOptions(PfxOptions options)
setPfxTrustOptions in class HttpClientOptionspublic WebClientOptions setPemTrustOptions(PemTrustOptions options)
setPemTrustOptions in class HttpClientOptionspublic WebClientOptions addEnabledCipherSuite(String suite)
addEnabledCipherSuite in class HttpClientOptionspublic WebClientOptions addCrlPath(String crlPath) throws NullPointerException
addCrlPath in class HttpClientOptionsNullPointerExceptionpublic WebClientOptions addCrlValue(Buffer crlValue) throws NullPointerException
addCrlValue in class HttpClientOptionsNullPointerExceptionpublic WebClientOptions setConnectTimeout(int connectTimeout)
setConnectTimeout in class HttpClientOptionspublic WebClientOptions setTrustAll(boolean trustAll)
setTrustAll in class HttpClientOptionspublic WebClientOptions setMaxPoolSize(int maxPoolSize)
setMaxPoolSize in class HttpClientOptionspublic WebClientOptions setHttp2MultiplexingLimit(int limit)
setHttp2MultiplexingLimit in class HttpClientOptionspublic WebClientOptions setHttp2MaxPoolSize(int max)
setHttp2MaxPoolSize in class HttpClientOptionspublic WebClientOptions setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)
setHttp2ConnectionWindowSize in class HttpClientOptionspublic WebClientOptions setKeepAlive(boolean keepAlive)
setKeepAlive in class HttpClientOptionspublic WebClientOptions setPipelining(boolean pipelining)
setPipelining in class HttpClientOptionspublic WebClientOptions setPipeliningLimit(int limit)
setPipeliningLimit in class HttpClientOptionspublic WebClientOptions setVerifyHost(boolean verifyHost)
setVerifyHost in class HttpClientOptionspublic WebClientOptions setTryUseCompression(boolean tryUseCompression)
setTryUseCompression in class HttpClientOptionspublic WebClientOptions setSendUnmaskedFrames(boolean sendUnmaskedFrames)
setSendUnmaskedFrames in class HttpClientOptionspublic WebClientOptions setMaxWebsocketFrameSize(int maxWebsocketFrameSize)
setMaxWebsocketFrameSize in class HttpClientOptionspublic WebClientOptions setDefaultHost(String defaultHost)
setDefaultHost in class HttpClientOptionspublic WebClientOptions setDefaultPort(int defaultPort)
setDefaultPort in class HttpClientOptionspublic WebClientOptions setMaxChunkSize(int maxChunkSize)
setMaxChunkSize in class HttpClientOptionspublic WebClientOptions setProtocolVersion(HttpVersion protocolVersion)
setProtocolVersion in class HttpClientOptionspublic WebClientOptions setMaxHeaderSize(int maxHeaderSize)
setMaxHeaderSize in class HttpClientOptionspublic WebClientOptions setMaxWaitQueueSize(int maxWaitQueueSize)
setMaxWaitQueueSize in class HttpClientOptionspublic WebClientOptions setUseAlpn(boolean useAlpn)
setUseAlpn in class HttpClientOptionspublic WebClientOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)
setSslEngineOptions in class HttpClientOptionspublic WebClientOptions setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)
setJdkSslEngineOptions in class HttpClientOptionspublic WebClientOptions setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
setOpenSslEngineOptions in class HttpClientOptionspublic WebClientOptions setHttp2ClearTextUpgrade(boolean value)
setHttp2ClearTextUpgrade in class HttpClientOptionspublic WebClientOptions setAlpnVersions(List<HttpVersion> alpnVersions)
setAlpnVersions in class HttpClientOptionspublic WebClientOptions setMetricsName(String metricsName)
setMetricsName in class HttpClientOptionspublic WebClientOptions setProxyOptions(ProxyOptions proxyOptions)
setProxyOptions in class HttpClientOptionspublic WebClientOptions setLocalAddress(String localAddress)
setLocalAddress in class HttpClientOptionspublic WebClientOptions setLogActivity(boolean logEnabled)
setLogActivity in class HttpClientOptionspublic WebClientOptions addEnabledSecureTransportProtocol(String protocol)
addEnabledSecureTransportProtocol in class HttpClientOptionspublic WebClientOptions removeEnabledSecureTransportProtocol(String protocol)
removeEnabledSecureTransportProtocol in class HttpClientOptionspublic WebClientOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
setEnabledSecureTransportProtocols in class HttpClientOptionspublic WebClientOptions setReusePort(boolean reusePort)
setReusePort in class HttpClientOptionspublic WebClientOptions setTcpFastOpen(boolean tcpFastOpen)
setTcpFastOpen in class HttpClientOptionspublic WebClientOptions setTcpCork(boolean tcpCork)
setTcpCork in class HttpClientOptionspublic WebClientOptions setTcpQuickAck(boolean tcpQuickAck)
setTcpQuickAck in class HttpClientOptionspublic WebClientOptions setHttp2KeepAliveTimeout(int keepAliveTimeout)
setHttp2KeepAliveTimeout in class HttpClientOptionspublic WebClientOptions setForceSni(boolean forceSni)
setForceSni in class HttpClientOptionspublic WebClientOptions setDecoderInitialBufferSize(int decoderInitialBufferSize)
setDecoderInitialBufferSize in class HttpClientOptionspublic WebClientOptions setPoolCleanerPeriod(int poolCleanerPeriod)
setPoolCleanerPeriod in class HttpClientOptionspublic WebClientOptions setKeepAliveTimeout(int keepAliveTimeout)
setKeepAliveTimeout in class HttpClientOptionspublic WebClientOptions setMaxWebsocketMessageSize(int maxWebsocketMessageSize)
setMaxWebsocketMessageSize in class HttpClientOptionspublic WebClientOptions setMaxInitialLineLength(int maxInitialLineLength)
setMaxInitialLineLength in class HttpClientOptionspublic WebClientOptions setInitialSettings(Http2Settings settings)
setInitialSettings in class HttpClientOptionspublic static String loadUserAgent()
Copyright © 2019 Eclipse. All rights reserved.