public class CachingWebClientOptions extends WebClientOptions
| Modifier and Type | Field and Description |
|---|---|
static Set<HttpMethod> |
DEFAULT_CACHED_METHODS |
static Set<Integer> |
DEFAULT_CACHED_STATUS_CODES |
DEFAULT_EXPAND_OPTIONS, DEFAULT_FOLLOW_REDIRECTS, DEFAULT_USER_AGENT, DEFAULT_USER_AGENT_ENABLEDDEFAULT_ALPN_VERSIONS, DEFAULT_DECODER_INITIAL_BUFFER_SIZE, 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_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_MAX_WEBSOCKETS, DEFAULT_NAME, DEFAULT_PIPELINING, DEFAULT_PIPELINING_LIMIT, DEFAULT_POOL_CLEANER_PERIOD, DEFAULT_POOL_EVENT_LOOP_SIZE, DEFAULT_PROTOCOL_VERSION, DEFAULT_SEND_UNMASKED_FRAMES, DEFAULT_SHARED, DEFAULT_TRACING_POLICY, 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_CONTEXTDEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME, DEFAULT_TRUST_ALLDEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS, DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, DEFAULT_READ_IDLE_TIMEOUT, 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_TCP_USER_TIMEOUT, DEFAULT_USE_ALPN, DEFAULT_WRITE_IDLE_TIMEOUTDEFAULT_LOG_ACTIVITY_FORMAT, DEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS| Constructor and Description |
|---|
CachingWebClientOptions() |
CachingWebClientOptions(boolean enableVaryCaching) |
CachingWebClientOptions(JsonObject json) |
CachingWebClientOptions(WebClientOptions other) |
| Modifier and Type | Method and Description |
|---|---|
CachingWebClientOptions |
addCachedMethod(HttpMethod method)
Add an HTTP method that is cacheable.
|
CachingWebClientOptions |
addCachedStatusCode(Integer code)
Add a status code that is cacheable.
|
CachingWebClientOptions |
addCrlPath(String crlPath)
Add a CRL path
|
CachingWebClientOptions |
addCrlValue(Buffer crlValue)
Add a CRL value
|
CachingWebClientOptions |
addEnabledCipherSuite(String suite)
Add an enabled cipher suite, appended to the ordered suites.
|
CachingWebClientOptions |
addEnabledSecureTransportProtocol(String protocol)
Add an enabled SSL/TLS protocols, appended to the ordered protocols.
|
Set<HttpMethod> |
getCachedMethods() |
Set<Integer> |
getCachedStatusCodes() |
boolean |
isVaryCachingEnabled() |
CachingWebClientOptions |
removeCachedMethod(HttpMethod method)
Remove an HTTP method that is cacheable.
|
CachingWebClientOptions |
removeCachedStatusCode(Integer code)
Remove a status code that is cacheable.
|
CachingWebClientOptions |
removeEnabledSecureTransportProtocol(String protocol)
Removes an enabled SSL/TLS protocol from the ordered protocols.
|
CachingWebClientOptions |
setAlpnVersions(List<HttpVersion> alpnVersions)
Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation.
|
CachingWebClientOptions |
setCachedMethods(Set<HttpMethod> methods)
Configure the HTTP methods that can be cached.
|
CachingWebClientOptions |
setCachedStatusCodes(Set<Integer> codes)
Configure the status codes that can be cached.
|
CachingWebClientOptions |
setConnectTimeout(int connectTimeout)
Set the connect timeout
|
CachingWebClientOptions |
setDecoderInitialBufferSize(int decoderInitialBufferSize)
set to
initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder. |
CachingWebClientOptions |
setDefaultHost(String defaultHost)
Set the default host name to be used by this client in requests if none is provided when making the request.
|
CachingWebClientOptions |
setDefaultPort(int defaultPort)
Set the default port to be used by this client in requests if none is provided when making the request.
|
CachingWebClientOptions |
setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
Sets the list of enabled SSL/TLS protocols.
|
CachingWebClientOptions |
setEnableVaryCaching(boolean enabled)
Configure the client cache behavior for
Vary responses. |
CachingWebClientOptions |
setFollowRedirects(boolean followRedirects)
Configure the default behavior of the client to follow HTTP
30x redirections. |
CachingWebClientOptions |
setForceSni(boolean forceSni)
By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting
this property to
true forces the server name to be always sent. |
CachingWebClientOptions |
setHttp2ClearTextUpgrade(boolean value)
Set to
true when an h2c connection is established using an HTTP/1.1 upgrade request, and false
when an h2c connection is established directly (with prior knowledge). |
CachingWebClientOptions |
setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)
Set the default HTTP/2 connection window size.
|
CachingWebClientOptions |
setHttp2KeepAliveTimeout(int keepAliveTimeout)
Set the keep alive timeout for HTTP/2 connections, in seconds.
|
CachingWebClientOptions |
setHttp2MaxPoolSize(int max)
Set the maximum pool size for HTTP/2 connections
|
CachingWebClientOptions |
setHttp2MultiplexingLimit(int limit)
Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number
of streams the client can create for a connection.
|
CachingWebClientOptions |
setIdleTimeout(int idleTimeout)
Set the idle timeout, default time unit is seconds.
|
CachingWebClientOptions |
setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
Set the idle timeout unit.
|
CachingWebClientOptions |
setInitialSettings(Http2Settings settings)
Set the HTTP/2 connection settings immediately sent by to the server when the client connects.
|
CachingWebClientOptions |
setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions) |
CachingWebClientOptions |
setKeepAlive(boolean keepAlive)
Set whether keep alive is enabled on the client
|
CachingWebClientOptions |
setKeepAliveTimeout(int keepAliveTimeout)
Set the keep alive timeout for HTTP/1.x, in seconds.
|
CachingWebClientOptions |
setKeyCertOptions(KeyCertOptions options)
Set the key/cert options.
|
CachingWebClientOptions |
setKeyStoreOptions(JksOptions options)
Set the key/cert options in jks format, aka Java keystore.
|
CachingWebClientOptions |
setLocalAddress(String localAddress)
Set the local interface to bind for network connections.
|
CachingWebClientOptions |
setLogActivity(boolean logEnabled)
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
|
CachingWebClientOptions |
setMaxChunkSize(int maxChunkSize)
Set the maximum HTTP chunk size
|
CachingWebClientOptions |
setMaxHeaderSize(int maxHeaderSize)
Set the maximum length of all headers for HTTP/1.x .
|
CachingWebClientOptions |
setMaxInitialLineLength(int maxInitialLineLength)
Set the maximum length of the initial line for HTTP/1.x (e.g.
|
CachingWebClientOptions |
setMaxPoolSize(int maxPoolSize)
Set the maximum pool size for connections
|
CachingWebClientOptions |
setMaxRedirects(int maxRedirects)
Set to
maxRedirects the maximum number of redirection a request can follow. |
CachingWebClientOptions |
setMaxWaitQueueSize(int maxWaitQueueSize)
Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in
a ConnectionPoolTooBusyException.
|
CachingWebClientOptions |
setMaxWebSocketFrameSize(int maxWebsocketFrameSize)
Set the max WebSocket frame size
|
CachingWebClientOptions |
setMaxWebSocketMessageSize(int maxWebsocketMessageSize)
Set the max WebSocket message size
|
CachingWebClientOptions |
setMetricsName(String metricsName)
Set the metrics name identifying the reported metrics, useful for grouping metrics
with the same name.
|
CachingWebClientOptions |
setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions) |
CachingWebClientOptions |
setPemKeyCertOptions(PemKeyCertOptions options)
Set the key/cert store options in pem format.
|
CachingWebClientOptions |
setPemTrustOptions(PemTrustOptions options)
Set the trust options in pem format
|
CachingWebClientOptions |
setPfxKeyCertOptions(PfxOptions options)
Set the key/cert options in pfx format.
|
CachingWebClientOptions |
setPfxTrustOptions(PfxOptions options)
Set the trust options in pfx format
|
CachingWebClientOptions |
setPipelining(boolean pipelining)
Set whether pipe-lining is enabled on the client
|
CachingWebClientOptions |
setPipeliningLimit(int limit)
Set the limit of pending requests a pipe-lined HTTP/1 connection can send.
|
CachingWebClientOptions |
setPoolCleanerPeriod(int poolCleanerPeriod)
Set the connection pool cleaner period in milli seconds, a non positive value disables expiration checks and connections
will remain in the pool until they are closed.
|
CachingWebClientOptions |
setProtocolVersion(HttpVersion protocolVersion)
Set the protocol version.
|
CachingWebClientOptions |
setProxyOptions(ProxyOptions proxyOptions)
Set proxy options for connections via CONNECT proxy (e.g.
|
CachingWebClientOptions |
setReceiveBufferSize(int receiveBufferSize)
Set the TCP receive buffer size
|
CachingWebClientOptions |
setReuseAddress(boolean reuseAddress)
Set the value of reuse address
|
CachingWebClientOptions |
setReusePort(boolean reusePort)
Set the value of reuse port.
|
CachingWebClientOptions |
setSendBufferSize(int sendBufferSize)
Set the TCP send buffer size
|
CachingWebClientOptions |
setSendUnmaskedFrames(boolean sendUnmaskedFrames)
Set
true when the client wants to skip frame masking. |
CachingWebClientOptions |
setSoLinger(int soLinger)
Set whether SO_linger keep alive is enabled
|
CachingWebClientOptions |
setSsl(boolean ssl)
Set whether SSL/TLS is enabled
|
CachingWebClientOptions |
setSslEngineOptions(SSLEngineOptions sslEngineOptions)
Set to use SSL engine implementation to use.
|
CachingWebClientOptions |
setSslHandshakeTimeout(long sslHandshakeTimeout)
Set the SSL handshake timeout, default time unit is seconds.
|
CachingWebClientOptions |
setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)
Set the SSL handshake timeout unit.
|
CachingWebClientOptions |
setTcpCork(boolean tcpCork)
Enable the
TCP_CORK option - only with linux native transport. |
CachingWebClientOptions |
setTcpFastOpen(boolean tcpFastOpen)
Enable the
TCP_FASTOPEN option - only with linux native transport. |
CachingWebClientOptions |
setTcpKeepAlive(boolean tcpKeepAlive)
Set whether TCP keep alive is enabled
|
CachingWebClientOptions |
setTcpNoDelay(boolean tcpNoDelay)
Set whether TCP no delay is enabled
|
CachingWebClientOptions |
setTcpQuickAck(boolean tcpQuickAck)
Enable the
TCP_QUICKACK option - only with linux native transport. |
CachingWebClientOptions |
setTrafficClass(int trafficClass)
Set the value of traffic class
|
CachingWebClientOptions |
setTrustAll(boolean trustAll)
Set whether all server certificates should be trusted
|
CachingWebClientOptions |
setTrustOptions(TrustOptions options)
Set the trust options.
|
CachingWebClientOptions |
setTrustStoreOptions(JksOptions options)
Set the trust options in jks format, aka Java truststore
|
CachingWebClientOptions |
setTryUseCompression(boolean tryUseCompression)
Set whether compression is enabled
|
CachingWebClientOptions |
setTryUsePerFrameWebSocketCompression(boolean offer)
Set whether the client will offer the WebSocket per-frame deflate compression extension.
|
CachingWebClientOptions |
setTryUsePerMessageWebSocketCompression(boolean offer)
Set whether the client will offer the WebSocket per-message deflate compression extension.
|
CachingWebClientOptions |
setUseAlpn(boolean useAlpn)
Set the ALPN usage.
|
CachingWebClientOptions |
setUserAgent(String userAgent)
Sets the Web Client user agent header.
|
CachingWebClientOptions |
setUserAgentEnabled(boolean userAgentEnabled)
Sets whether the Web Client should send a user agent header.
|
CachingWebClientOptions |
setVerifyHost(boolean verifyHost)
Set whether hostname verification is enabled
|
CachingWebClientOptions |
setWebSocketCompressionAllowClientNoContext(boolean offer)
Set whether the
client_no_context_takeover parameter of the WebSocket per-message
deflate compression extension will be offered. |
CachingWebClientOptions |
setWebSocketCompressionLevel(int compressionLevel)
Set the WebSocket deflate compression level.
|
CachingWebClientOptions |
setWebSocketCompressionRequestServerNoContext(boolean offer)
Set whether the
server_no_context_takeover parameter of the WebSocket per-message
deflate compression extension will be offered. |
JsonObject |
toJson()
Convert to JSON
|
addNonProxyHost, getTemplateExpandOptions, getUserAgent, isFollowRedirects, isUserAgentEnabled, loadUserAgent, setMaxWebSockets, setName, setNonProxyHosts, setPoolEventLoopSize, setReadIdleTimeout, setShared, setTemplateExpandOptions, setTracingPolicy, setWebSocketClosingTimeout, setWriteIdleTimeoutgetAlpnVersions, getDecoderInitialBufferSize, getDefaultHost, getDefaultPort, getHttp2ConnectionWindowSize, getHttp2KeepAliveTimeout, getHttp2MaxPoolSize, getHttp2MultiplexingLimit, getInitialSettings, getKeepAliveTimeout, getMaxChunkSize, getMaxHeaderSize, getMaxInitialLineLength, getMaxPoolSize, getMaxRedirects, getMaxWaitQueueSize, getMaxWebSocketFrameSize, getMaxWebSocketMessageSize, getMaxWebSockets, getName, getPipeliningLimit, getPoolCleanerPeriod, getPoolEventLoopSize, getProtocolVersion, getTracingPolicy, getTryUsePerMessageWebSocketCompression, getTryWebSocketDeflateFrameCompression, getWebSocketClosingTimeout, getWebSocketCompressionAllowClientNoContext, getWebSocketCompressionLevel, getWebSocketCompressionRequestServerNoContext, isForceSni, isHttp2ClearTextUpgrade, isHttp2ClearTextUpgradeWithPreflightRequest, isKeepAlive, isPipelining, isSendUnmaskedFrames, isShared, isTryUseCompression, isVerifyHost, removeEnabledCipherSuite, setActivityLogDataFormat, setHttp2ClearTextUpgradeWithPreflightRequest, setTcpUserTimeoutgetConnectTimeout, getLocalAddress, getMetricsName, getNonProxyHosts, getProxyOptions, isTrustAllgetCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getReadIdleTimeout, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getSslOptions, getTcpUserTimeout, getTrustOptions, getTrustStoreOptions, getWriteIdleTimeout, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpngetActivityLogDataFormat, getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePortpublic static final Set<HttpMethod> DEFAULT_CACHED_METHODS
public CachingWebClientOptions()
public CachingWebClientOptions(boolean enableVaryCaching)
public CachingWebClientOptions(WebClientOptions other)
public CachingWebClientOptions(JsonObject json)
public JsonObject toJson()
toJson in class WebClientOptionspublic CachingWebClientOptions setEnableVaryCaching(boolean enabled)
Vary responses.enabled - true to enable caching varying responsespublic Set<Integer> getCachedStatusCodes()
public CachingWebClientOptions setCachedStatusCodes(Set<Integer> codes)
codes - the cacheable status code numberspublic CachingWebClientOptions addCachedStatusCode(Integer code)
code - the additional code numberpublic CachingWebClientOptions removeCachedStatusCode(Integer code)
code - the code number to removepublic Set<HttpMethod> getCachedMethods()
public CachingWebClientOptions setCachedMethods(Set<HttpMethod> methods)
methods - the HTTP methods to cachepublic CachingWebClientOptions addCachedMethod(HttpMethod method)
method - the method to addpublic CachingWebClientOptions removeCachedMethod(HttpMethod method)
method - the method to removepublic boolean isVaryCachingEnabled()
Vary header, false otherwisepublic CachingWebClientOptions setUserAgentEnabled(boolean userAgentEnabled)
WebClientOptionssetUserAgentEnabled in class WebClientOptionsuserAgentEnabled - true to send a user agent header, false otherwisepublic CachingWebClientOptions setUserAgent(String userAgent)
WebClientOptionssetUserAgent in class WebClientOptionsuserAgent - user agent header valuepublic CachingWebClientOptions setFollowRedirects(boolean followRedirects)
WebClientOptions30x redirections.setFollowRedirects in class WebClientOptionsfollowRedirects - true when a redirect is followedpublic CachingWebClientOptions setMaxRedirects(int maxRedirects)
HttpClientOptionsmaxRedirects the maximum number of redirection a request can follow.setMaxRedirects in class WebClientOptionsmaxRedirects - the maximum number of redirectionpublic CachingWebClientOptions setSendBufferSize(int sendBufferSize)
NetworkOptionssetSendBufferSize in class WebClientOptionssendBufferSize - the buffers size, in bytespublic CachingWebClientOptions setReceiveBufferSize(int receiveBufferSize)
NetworkOptionssetReceiveBufferSize in class WebClientOptionsreceiveBufferSize - the buffers size, in bytespublic CachingWebClientOptions setReuseAddress(boolean reuseAddress)
NetworkOptionssetReuseAddress in class WebClientOptionsreuseAddress - the value of reuse addresspublic CachingWebClientOptions setTrafficClass(int trafficClass)
NetworkOptionssetTrafficClass in class WebClientOptionstrafficClass - the value of traffic classpublic CachingWebClientOptions setTcpNoDelay(boolean tcpNoDelay)
TCPSSLOptionssetTcpNoDelay in class WebClientOptionstcpNoDelay - true if TCP no delay is enabled (Nagle disabled)public CachingWebClientOptions setTcpKeepAlive(boolean tcpKeepAlive)
TCPSSLOptionssetTcpKeepAlive in class WebClientOptionstcpKeepAlive - true if TCP keep alive is enabledpublic CachingWebClientOptions setSoLinger(int soLinger)
TCPSSLOptionssetSoLinger in class WebClientOptionssoLinger - true if SO_linger is enabledpublic CachingWebClientOptions setIdleTimeout(int idleTimeout)
TCPSSLOptionsTCPSSLOptions.setIdleTimeoutUnit(TimeUnit)setIdleTimeout in class WebClientOptionsidleTimeout - the timeoutpublic CachingWebClientOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
TCPSSLOptionssetIdleTimeoutUnit in class WebClientOptionsidleTimeoutUnit - specify time unit.public CachingWebClientOptions setSsl(boolean ssl)
TCPSSLOptionssetSsl in class WebClientOptionsssl - true if enabledpublic CachingWebClientOptions setKeyCertOptions(KeyCertOptions options)
TCPSSLOptionssetKeyCertOptions in class WebClientOptionsoptions - the key store optionspublic CachingWebClientOptions setKeyStoreOptions(JksOptions options)
TCPSSLOptionssetKeyStoreOptions in class WebClientOptionsoptions - the key store in jks formatpublic CachingWebClientOptions setPfxKeyCertOptions(PfxOptions options)
TCPSSLOptionssetPfxKeyCertOptions in class WebClientOptionsoptions - the key cert options in pfx formatpublic CachingWebClientOptions setTrustOptions(TrustOptions options)
TCPSSLOptionssetTrustOptions in class WebClientOptionsoptions - the trust optionspublic CachingWebClientOptions setPemKeyCertOptions(PemKeyCertOptions options)
TCPSSLOptionssetPemKeyCertOptions in class WebClientOptionsoptions - the options in pem formatpublic CachingWebClientOptions setTrustStoreOptions(JksOptions options)
TCPSSLOptionssetTrustStoreOptions in class WebClientOptionsoptions - the trust options in jks formatpublic CachingWebClientOptions setPfxTrustOptions(PfxOptions options)
TCPSSLOptionssetPfxTrustOptions in class WebClientOptionsoptions - the trust options in pfx formatpublic CachingWebClientOptions setPemTrustOptions(PemTrustOptions options)
TCPSSLOptionssetPemTrustOptions in class WebClientOptionsoptions - the trust options in pem formatpublic CachingWebClientOptions addEnabledCipherSuite(String suite)
TCPSSLOptionsaddEnabledCipherSuite in class WebClientOptionssuite - the suiteTCPSSLOptions.getEnabledCipherSuites()public CachingWebClientOptions addCrlPath(String crlPath) throws NullPointerException
TCPSSLOptionsaddCrlPath in class WebClientOptionscrlPath - the pathNullPointerExceptionpublic CachingWebClientOptions addCrlValue(Buffer crlValue) throws NullPointerException
TCPSSLOptionsaddCrlValue in class WebClientOptionscrlValue - the valueNullPointerExceptionpublic CachingWebClientOptions setConnectTimeout(int connectTimeout)
ClientOptionsBasesetConnectTimeout in class WebClientOptionsconnectTimeout - connect timeout, in mspublic CachingWebClientOptions setTrustAll(boolean trustAll)
ClientOptionsBasesetTrustAll in class WebClientOptionstrustAll - true if all should be trustedpublic CachingWebClientOptions setMaxPoolSize(int maxPoolSize)
HttpClientOptionssetMaxPoolSize in class WebClientOptionsmaxPoolSize - the maximum pool sizepublic CachingWebClientOptions setHttp2MultiplexingLimit(int limit)
HttpClientOptions-1 means to use the value sent by the server's initial settings.
-1 is the default value.setHttp2MultiplexingLimit in class WebClientOptionslimit - the maximum concurrent for an HTTP/2 connectionpublic CachingWebClientOptions setHttp2MaxPoolSize(int max)
HttpClientOptionssetHttp2MaxPoolSize in class WebClientOptionsmax - the maximum pool sizepublic CachingWebClientOptions setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)
HttpClientOptionsHttp2Settings.getInitialWindowSize(), so the connection window size
is greater than for its streams, in order the data throughput.
A value of -1 reuses the initial window size setting.setHttp2ConnectionWindowSize in class WebClientOptionshttp2ConnectionWindowSize - the window size applied to the connectionpublic CachingWebClientOptions setKeepAlive(boolean keepAlive)
HttpClientOptionssetKeepAlive in class WebClientOptionskeepAlive - true if enabledpublic CachingWebClientOptions setPipelining(boolean pipelining)
HttpClientOptionssetPipelining in class WebClientOptionspipelining - true if enabledpublic CachingWebClientOptions setPipeliningLimit(int limit)
HttpClientOptionssetPipeliningLimit in class WebClientOptionslimit - the limit of pending requestspublic CachingWebClientOptions setVerifyHost(boolean verifyHost)
HttpClientOptionssetVerifyHost in class WebClientOptionsverifyHost - true if enabledpublic CachingWebClientOptions setTryUseCompression(boolean tryUseCompression)
HttpClientOptionssetTryUseCompression in class WebClientOptionstryUseCompression - true if enabledpublic CachingWebClientOptions setSendUnmaskedFrames(boolean sendUnmaskedFrames)
HttpClientOptionstrue when the client wants to skip frame masking.
You may want to set it true on server by server WebSocket communication: in this case you are by passing
RFC6455 protocol.
It's false as default.
setSendUnmaskedFrames in class WebClientOptionssendUnmaskedFrames - true if enabledpublic CachingWebClientOptions setMaxWebSocketFrameSize(int maxWebsocketFrameSize)
HttpClientOptionssetMaxWebSocketFrameSize in class WebClientOptionsmaxWebsocketFrameSize - the max frame size, in bytespublic CachingWebClientOptions setDefaultHost(String defaultHost)
HttpClientOptionssetDefaultHost in class WebClientOptionspublic CachingWebClientOptions setDefaultPort(int defaultPort)
HttpClientOptionssetDefaultPort in class WebClientOptionspublic CachingWebClientOptions setMaxChunkSize(int maxChunkSize)
HttpClientOptionssetMaxChunkSize in class WebClientOptionsmaxChunkSize - the maximum chunk sizepublic CachingWebClientOptions setProtocolVersion(HttpVersion protocolVersion)
HttpClientOptionssetProtocolVersion in class WebClientOptionsprotocolVersion - the protocol versionpublic CachingWebClientOptions setMaxHeaderSize(int maxHeaderSize)
HttpClientOptionssetMaxHeaderSize in class WebClientOptionsmaxHeaderSize - the new maximum lengthpublic CachingWebClientOptions setMaxWaitQueueSize(int maxWaitQueueSize)
HttpClientOptionssetMaxWaitQueueSize in class WebClientOptionsmaxWaitQueueSize - the maximum number of waiting requestspublic CachingWebClientOptions setUseAlpn(boolean useAlpn)
TCPSSLOptionssetUseAlpn in class WebClientOptionsuseAlpn - true when Application-Layer Protocol Negotiation should be usedpublic CachingWebClientOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)
TCPSSLOptionssetSslEngineOptions in class WebClientOptionssslEngineOptions - the ssl engine to usepublic CachingWebClientOptions setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)
setJdkSslEngineOptions in class WebClientOptionspublic CachingWebClientOptions setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
setOpenSslEngineOptions in class WebClientOptionspublic CachingWebClientOptions setHttp2ClearTextUpgrade(boolean value)
HttpClientOptionstrue when an h2c connection is established using an HTTP/1.1 upgrade request, and false
when an h2c connection is established directly (with prior knowledge).setHttp2ClearTextUpgrade in class WebClientOptionsvalue - the upgrade valuepublic CachingWebClientOptions setAlpnVersions(List<HttpVersion> alpnVersions)
HttpClientOptionsHttpClientOptions.setProtocolVersion(io.vertx.core.http.HttpVersion):
HttpVersion.HTTP_2: [ "h2", "http/1.1" ]HttpClientOptions.getProtocolVersion()]setAlpnVersions in class WebClientOptionsalpnVersions - the versionspublic CachingWebClientOptions setMetricsName(String metricsName)
ClientOptionsBasesetMetricsName in class WebClientOptionsmetricsName - the metrics namepublic CachingWebClientOptions setProxyOptions(ProxyOptions proxyOptions)
ClientOptionsBasesetProxyOptions in class WebClientOptionsproxyOptions - proxy options objectpublic CachingWebClientOptions setLocalAddress(String localAddress)
ClientOptionsBasesetLocalAddress in class WebClientOptionslocalAddress - the local addresspublic CachingWebClientOptions setLogActivity(boolean logEnabled)
NetworkOptionssetLogActivity in class WebClientOptionslogEnabled - true for logging the network activitypublic CachingWebClientOptions addEnabledSecureTransportProtocol(String protocol)
TCPSSLOptionsaddEnabledSecureTransportProtocol in class WebClientOptionsprotocol - the SSL/TLS protocol to enablepublic CachingWebClientOptions removeEnabledSecureTransportProtocol(String protocol)
TCPSSLOptionsremoveEnabledSecureTransportProtocol in class WebClientOptionsprotocol - the SSL/TLS protocol to disablepublic CachingWebClientOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
TCPSSLOptionssetEnabledSecureTransportProtocols in class WebClientOptionsenabledSecureTransportProtocols - the SSL/TLS protocols to enablepublic CachingWebClientOptions setReusePort(boolean reusePort)
NetworkOptionssetReusePort in class WebClientOptionsreusePort - the value of reuse portpublic CachingWebClientOptions setTcpFastOpen(boolean tcpFastOpen)
TCPSSLOptionsTCP_FASTOPEN option - only with linux native transport.setTcpFastOpen in class WebClientOptionstcpFastOpen - the fast open valuepublic CachingWebClientOptions setTcpCork(boolean tcpCork)
TCPSSLOptionsTCP_CORK option - only with linux native transport.setTcpCork in class WebClientOptionstcpCork - the cork valuepublic CachingWebClientOptions setTcpQuickAck(boolean tcpQuickAck)
TCPSSLOptionsTCP_QUICKACK option - only with linux native transport.setTcpQuickAck in class WebClientOptionstcpQuickAck - the quick ack valuepublic CachingWebClientOptions setHttp2KeepAliveTimeout(int keepAliveTimeout)
HttpClientOptions0 means there is no timeout.setHttp2KeepAliveTimeout in class WebClientOptionskeepAliveTimeout - the timeout, in secondspublic CachingWebClientOptions setForceSni(boolean forceSni)
HttpClientOptionstrue forces the server name to be always sent.setForceSni in class WebClientOptionsforceSni - true when the client should always use SNI on TLS/SSL connectionspublic CachingWebClientOptions setDecoderInitialBufferSize(int decoderInitialBufferSize)
HttpClientOptionsinitialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.setDecoderInitialBufferSize in class WebClientOptionsdecoderInitialBufferSize - the initial buffer sizepublic CachingWebClientOptions setPoolCleanerPeriod(int poolCleanerPeriod)
HttpClientOptionssetPoolCleanerPeriod in class WebClientOptionspoolCleanerPeriod - the pool cleaner periodpublic CachingWebClientOptions setKeepAliveTimeout(int keepAliveTimeout)
HttpClientOptions0 means there is no timeout.setKeepAliveTimeout in class WebClientOptionskeepAliveTimeout - the timeout, in secondspublic CachingWebClientOptions setMaxWebSocketMessageSize(int maxWebsocketMessageSize)
HttpClientOptionssetMaxWebSocketMessageSize in class WebClientOptionsmaxWebsocketMessageSize - the max message size, in bytespublic CachingWebClientOptions setMaxInitialLineLength(int maxInitialLineLength)
HttpClientOptions"HTTP/1.1 200 OK")setMaxInitialLineLength in class WebClientOptionsmaxInitialLineLength - the new maximum initial lengthpublic CachingWebClientOptions setInitialSettings(Http2Settings settings)
HttpClientOptionssetInitialSettings in class WebClientOptionssettings - the settings valuepublic CachingWebClientOptions setSslHandshakeTimeout(long sslHandshakeTimeout)
TCPSSLOptionssetSslHandshakeTimeout in class WebClientOptionssslHandshakeTimeout - the SSL handshake timeout to set, in millisecondspublic CachingWebClientOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)
TCPSSLOptionssetSslHandshakeTimeoutUnit in class WebClientOptionssslHandshakeTimeoutUnit - specify time unit.public CachingWebClientOptions setTryUsePerFrameWebSocketCompression(boolean offer)
HttpClientOptionssetTryUsePerFrameWebSocketCompression in class WebClientOptionsoffer - true to offer the per-frame deflate compression extensionpublic CachingWebClientOptions setTryUsePerMessageWebSocketCompression(boolean offer)
HttpClientOptionssetTryUsePerMessageWebSocketCompression in class WebClientOptionsoffer - true to offer the per-message deflate compression extensionpublic CachingWebClientOptions setWebSocketCompressionLevel(int compressionLevel)
HttpClientOptionssetWebSocketCompressionLevel in class WebClientOptionscompressionLevel - the WebSocket deflate compression levelpublic CachingWebClientOptions setWebSocketCompressionAllowClientNoContext(boolean offer)
HttpClientOptionsclient_no_context_takeover parameter of the WebSocket per-message
deflate compression extension will be offered.setWebSocketCompressionAllowClientNoContext in class WebClientOptionsoffer - true to offer the client_no_context_takeover parameterpublic CachingWebClientOptions setWebSocketCompressionRequestServerNoContext(boolean offer)
HttpClientOptionsserver_no_context_takeover parameter of the WebSocket per-message
deflate compression extension will be offered.setWebSocketCompressionRequestServerNoContext in class WebClientOptionsoffer - true to offer the server_no_context_takeover parameterCopyright © 2023 Eclipse. All rights reserved.