Module io.vertx.web.client

Package io.vertx.ext.web.client

Class CachingWebClientOptions

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

io.vertx.ext.web.client.CachingWebClientOptions

public class CachingWebClientOptions
extends WebClientOptions

Author:

Craig Day

Field Summary

Fields

Modifier and Type	Field	Description
static Set<HttpMethod>	DEFAULT_CACHED_METHODS
static Set<Integer>	DEFAULT_CACHED_STATUS_CODES

Fields inherited from class io.vertx.ext.web.client.WebClientOptions

DEFAULT_EXPAND_OPTIONS, DEFAULT_FOLLOW_REDIRECTS, DEFAULT_USER_AGENT, DEFAULT_USER_AGENT_ENABLED

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
CachingWebClientOptions()
CachingWebClientOptions(boolean enableVaryCaching)
CachingWebClientOptions(JsonObject json)
CachingWebClientOptions(WebClientOptions other)

Method Summary

Modifier and Type	Method	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)
CachingWebClientOptions	addCrlValue(Buffer crlValue)
CachingWebClientOptions	addEnabledCipherSuite(String suite)
CachingWebClientOptions	addEnabledSecureTransportProtocol(String protocol)
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)
CachingWebClientOptions	setAlpnVersions(List<HttpVersion> alpnVersions)
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)
CachingWebClientOptions	setDecoderInitialBufferSize(int decoderInitialBufferSize)
CachingWebClientOptions	setDecompressionSupported(boolean tryUseCompression)
CachingWebClientOptions	setDefaultHost(String defaultHost)
CachingWebClientOptions	setDefaultPort(int defaultPort)
CachingWebClientOptions	setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
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)
CachingWebClientOptions	setHttp2ClearTextUpgrade(boolean value)
CachingWebClientOptions	setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)
CachingWebClientOptions	setHttp2KeepAliveTimeout(int keepAliveTimeout)
CachingWebClientOptions	setHttp2MultiplexingLimit(int limit)
CachingWebClientOptions	setIdleTimeout(int idleTimeout)
CachingWebClientOptions	setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
CachingWebClientOptions	setInitialSettings(Http2Settings settings)
CachingWebClientOptions	setKeepAlive(boolean keepAlive)
CachingWebClientOptions	setKeepAliveTimeout(int keepAliveTimeout)
CachingWebClientOptions	setKeyCertOptions(KeyCertOptions options)
CachingWebClientOptions	setLocalAddress(String localAddress)
CachingWebClientOptions	setLogActivity(boolean logEnabled)
CachingWebClientOptions	setMaxChunkSize(int maxChunkSize)
CachingWebClientOptions	setMaxHeaderSize(int maxHeaderSize)
CachingWebClientOptions	setMaxInitialLineLength(int maxInitialLineLength)
CachingWebClientOptions	setMaxRedirects(int maxRedirects)
CachingWebClientOptions	setMetricsName(String metricsName)
CachingWebClientOptions	setPipelining(boolean pipelining)
CachingWebClientOptions	setPipeliningLimit(int limit)
CachingWebClientOptions	setProtocolVersion(HttpVersion protocolVersion)
CachingWebClientOptions	setProxyOptions(ProxyOptions proxyOptions)
CachingWebClientOptions	setReceiveBufferSize(int receiveBufferSize)
CachingWebClientOptions	setReuseAddress(boolean reuseAddress)
CachingWebClientOptions	setReusePort(boolean reusePort)
CachingWebClientOptions	setSendBufferSize(int sendBufferSize)
CachingWebClientOptions	setSoLinger(int soLinger)
CachingWebClientOptions	setSsl(boolean ssl)
CachingWebClientOptions	setSslEngineOptions(SSLEngineOptions sslEngineOptions)
CachingWebClientOptions	setSslHandshakeTimeout(long sslHandshakeTimeout)
CachingWebClientOptions	setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)
CachingWebClientOptions	setTcpCork(boolean tcpCork)
CachingWebClientOptions	setTcpFastOpen(boolean tcpFastOpen)
CachingWebClientOptions	setTcpKeepAlive(boolean tcpKeepAlive)
CachingWebClientOptions	setTcpNoDelay(boolean tcpNoDelay)
CachingWebClientOptions	setTcpQuickAck(boolean tcpQuickAck)
CachingWebClientOptions	setTrafficClass(int trafficClass)
CachingWebClientOptions	setTrustAll(boolean trustAll)
CachingWebClientOptions	setTrustOptions(TrustOptions options)
CachingWebClientOptions	setUseAlpn(boolean useAlpn)
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)
JsonObject	toJson()	Convert to JSON

Methods inherited from class io.vertx.ext.web.client.WebClientOptions

addNonProxyHost, getTemplateExpandOptions, getUserAgent, isFollowRedirects, isUserAgentEnabled, loadUserAgent, setName, setNonProxyHosts, setReadIdleTimeout, setShared, setTemplateExpandOptions, setTracingPolicy, setWriteIdleTimeout

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_CACHED_STATUS_CODES

public static final Set<Integer> DEFAULT_CACHED_STATUS_CODES

DEFAULT_CACHED_METHODS

public static final Set<HttpMethod> DEFAULT_CACHED_METHODS

Constructor Detail

CachingWebClientOptions

public CachingWebClientOptions()

CachingWebClientOptions

public CachingWebClientOptions(boolean enableVaryCaching)

CachingWebClientOptions

public CachingWebClientOptions(WebClientOptions other)

CachingWebClientOptions

public CachingWebClientOptions(JsonObject json)

Method Detail

toJson

public JsonObject toJson()

Convert to JSON

Overrides:

toJson in class WebClientOptions

Returns:

the JSON

setEnableVaryCaching

public CachingWebClientOptions setEnableVaryCaching(boolean enabled)

Configure the client cache behavior for Vary responses.

Parameters:

enabled - true to enable caching varying responses

Returns:

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

getCachedStatusCodes

public Set<Integer> getCachedStatusCodes()

Returns:

the set of status codes to consider cacheable.

setCachedStatusCodes

public CachingWebClientOptions setCachedStatusCodes(Set<Integer> codes)

Configure the status codes that can be cached.

Parameters:

codes - the cacheable status code numbers

Returns:

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

addCachedStatusCode

public CachingWebClientOptions addCachedStatusCode(Integer code)

Add a status code that is cacheable.

Parameters:

code - the additional code number

Returns:

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

removeCachedStatusCode

public CachingWebClientOptions removeCachedStatusCode(Integer code)

Remove a status code that is cacheable.

Parameters:

code - the code number to remove

Returns:

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

getCachedMethods

public Set<HttpMethod> getCachedMethods()

Returns:

the set of HTTP methods to consider cacheable.

setCachedMethods

public CachingWebClientOptions setCachedMethods(Set<HttpMethod> methods)

Configure the HTTP methods that can be cached.

Parameters:

methods - the HTTP methods to cache

Returns:

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

addCachedMethod

public CachingWebClientOptions addCachedMethod(HttpMethod method)

Add an HTTP method that is cacheable.

Parameters:

method - the method to add

Returns:

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

removeCachedMethod

public CachingWebClientOptions removeCachedMethod(HttpMethod method)

Remove an HTTP method that is cacheable.

Parameters:

method - the method to remove

Returns:

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

isVaryCachingEnabled

public boolean isVaryCachingEnabled()

Returns:

true if the client will cache responses with the Vary header, false otherwise

setUserAgentEnabled

public CachingWebClientOptions setUserAgentEnabled(boolean userAgentEnabled)

Description copied from class: WebClientOptions

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

Overrides:

setUserAgentEnabled in class WebClientOptions

Parameters:

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

Returns:

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

setUserAgent

public CachingWebClientOptions setUserAgent(String userAgent)

Description copied from class: WebClientOptions

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

Overrides:

setUserAgent in class WebClientOptions

Parameters:

userAgent - user agent header value

Returns:

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

setFollowRedirects

public CachingWebClientOptions setFollowRedirects(boolean followRedirects)

Description copied from class: WebClientOptions

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

Overrides:

setFollowRedirects in class WebClientOptions

Parameters:

followRedirects - true when a redirect is followed

Returns:

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

setMaxRedirects

public CachingWebClientOptions setMaxRedirects(int maxRedirects)

Overrides:

setMaxRedirects in class WebClientOptions

setSendBufferSize

public CachingWebClientOptions setSendBufferSize(int sendBufferSize)

Overrides:

setSendBufferSize in class WebClientOptions

setReceiveBufferSize

public CachingWebClientOptions setReceiveBufferSize(int receiveBufferSize)

Overrides:

setReceiveBufferSize in class WebClientOptions

setReuseAddress

public CachingWebClientOptions setReuseAddress(boolean reuseAddress)

Overrides:

setReuseAddress in class WebClientOptions

setTrafficClass

public CachingWebClientOptions setTrafficClass(int trafficClass)

Overrides:

setTrafficClass in class WebClientOptions

setTcpNoDelay

public CachingWebClientOptions setTcpNoDelay(boolean tcpNoDelay)

Overrides:

setTcpNoDelay in class WebClientOptions

setTcpKeepAlive

public CachingWebClientOptions setTcpKeepAlive(boolean tcpKeepAlive)

Overrides:

setTcpKeepAlive in class WebClientOptions

setSoLinger

public CachingWebClientOptions setSoLinger(int soLinger)

Overrides:

setSoLinger in class WebClientOptions

setIdleTimeout

public CachingWebClientOptions setIdleTimeout(int idleTimeout)

Overrides:

setIdleTimeout in class WebClientOptions

setIdleTimeoutUnit

public CachingWebClientOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)

Overrides:

setIdleTimeoutUnit in class WebClientOptions

setSsl

public CachingWebClientOptions setSsl(boolean ssl)

Overrides:

setSsl in class WebClientOptions

setKeyCertOptions

public CachingWebClientOptions setKeyCertOptions(KeyCertOptions options)

Overrides:

setKeyCertOptions in class WebClientOptions

setTrustOptions

public CachingWebClientOptions setTrustOptions(TrustOptions options)

Overrides:

setTrustOptions in class WebClientOptions

addEnabledCipherSuite

public CachingWebClientOptions addEnabledCipherSuite(String suite)

Overrides:

addEnabledCipherSuite in class WebClientOptions

addCrlPath

public CachingWebClientOptions addCrlPath(String crlPath)
                                   throws NullPointerException

Overrides:

addCrlPath in class WebClientOptions

Throws:

NullPointerException

addCrlValue

public CachingWebClientOptions addCrlValue(Buffer crlValue)
                                    throws NullPointerException

Overrides:

addCrlValue in class WebClientOptions

Throws:

NullPointerException

setConnectTimeout

public CachingWebClientOptions setConnectTimeout(int connectTimeout)

Overrides:

setConnectTimeout in class WebClientOptions

setTrustAll

public CachingWebClientOptions setTrustAll(boolean trustAll)

Overrides:

setTrustAll in class WebClientOptions

setHttp2MultiplexingLimit

public CachingWebClientOptions setHttp2MultiplexingLimit(int limit)

Overrides:

setHttp2MultiplexingLimit in class WebClientOptions

setHttp2ConnectionWindowSize

public CachingWebClientOptions setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)

Overrides:

setHttp2ConnectionWindowSize in class WebClientOptions

setKeepAlive

public CachingWebClientOptions setKeepAlive(boolean keepAlive)

Overrides:

setKeepAlive in class WebClientOptions

setPipelining

public CachingWebClientOptions setPipelining(boolean pipelining)

Overrides:

setPipelining in class WebClientOptions

setPipeliningLimit

public CachingWebClientOptions setPipeliningLimit(int limit)

Overrides:

setPipeliningLimit in class WebClientOptions

setVerifyHost

public CachingWebClientOptions setVerifyHost(boolean verifyHost)

Overrides:

setVerifyHost in class WebClientOptions

setDecompressionSupported

public CachingWebClientOptions setDecompressionSupported(boolean tryUseCompression)

Overrides:

setDecompressionSupported in class WebClientOptions

setDefaultHost

public CachingWebClientOptions setDefaultHost(String defaultHost)

Overrides:

setDefaultHost in class WebClientOptions

setDefaultPort

public CachingWebClientOptions setDefaultPort(int defaultPort)

Overrides:

setDefaultPort in class WebClientOptions

setMaxChunkSize

public CachingWebClientOptions setMaxChunkSize(int maxChunkSize)

Overrides:

setMaxChunkSize in class WebClientOptions

setProtocolVersion

public CachingWebClientOptions setProtocolVersion(HttpVersion protocolVersion)

Overrides:

setProtocolVersion in class WebClientOptions

setMaxHeaderSize

public CachingWebClientOptions setMaxHeaderSize(int maxHeaderSize)

Overrides:

setMaxHeaderSize in class WebClientOptions

setUseAlpn

public CachingWebClientOptions setUseAlpn(boolean useAlpn)

Overrides:

setUseAlpn in class WebClientOptions

setSslEngineOptions

public CachingWebClientOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)

Overrides:

setSslEngineOptions in class WebClientOptions

setHttp2ClearTextUpgrade

public CachingWebClientOptions setHttp2ClearTextUpgrade(boolean value)

Overrides:

setHttp2ClearTextUpgrade in class WebClientOptions

setAlpnVersions

public CachingWebClientOptions setAlpnVersions(List<HttpVersion> alpnVersions)

Overrides:

setAlpnVersions in class WebClientOptions

setMetricsName

public CachingWebClientOptions setMetricsName(String metricsName)

Overrides:

setMetricsName in class WebClientOptions

setProxyOptions

public CachingWebClientOptions setProxyOptions(ProxyOptions proxyOptions)

Overrides:

setProxyOptions in class WebClientOptions

setLocalAddress

public CachingWebClientOptions setLocalAddress(String localAddress)

Overrides:

setLocalAddress in class WebClientOptions

setLogActivity

public CachingWebClientOptions setLogActivity(boolean logEnabled)

Overrides:

setLogActivity in class WebClientOptions

addEnabledSecureTransportProtocol

public CachingWebClientOptions addEnabledSecureTransportProtocol(String protocol)

Overrides:

addEnabledSecureTransportProtocol in class WebClientOptions

removeEnabledSecureTransportProtocol

public CachingWebClientOptions removeEnabledSecureTransportProtocol(String protocol)

Overrides:

removeEnabledSecureTransportProtocol in class WebClientOptions

setEnabledSecureTransportProtocols

public CachingWebClientOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)

Overrides:

setEnabledSecureTransportProtocols in class WebClientOptions

setReusePort

public CachingWebClientOptions setReusePort(boolean reusePort)

Overrides:

setReusePort in class WebClientOptions

setTcpFastOpen

public CachingWebClientOptions setTcpFastOpen(boolean tcpFastOpen)

Overrides:

setTcpFastOpen in class WebClientOptions

setTcpCork

public CachingWebClientOptions setTcpCork(boolean tcpCork)

Overrides:

setTcpCork in class WebClientOptions

setTcpQuickAck

public CachingWebClientOptions setTcpQuickAck(boolean tcpQuickAck)

Overrides:

setTcpQuickAck in class WebClientOptions

setHttp2KeepAliveTimeout

public CachingWebClientOptions setHttp2KeepAliveTimeout(int keepAliveTimeout)

Overrides:

setHttp2KeepAliveTimeout in class WebClientOptions

setForceSni

public CachingWebClientOptions setForceSni(boolean forceSni)

Overrides:

setForceSni in class WebClientOptions

setDecoderInitialBufferSize

public CachingWebClientOptions setDecoderInitialBufferSize(int decoderInitialBufferSize)

Overrides:

setDecoderInitialBufferSize in class WebClientOptions

setKeepAliveTimeout

public CachingWebClientOptions setKeepAliveTimeout(int keepAliveTimeout)

Overrides:

setKeepAliveTimeout in class WebClientOptions

setMaxInitialLineLength

public CachingWebClientOptions setMaxInitialLineLength(int maxInitialLineLength)

Overrides:

setMaxInitialLineLength in class WebClientOptions

setInitialSettings

public CachingWebClientOptions setInitialSettings(Http2Settings settings)

Overrides:

setInitialSettings in class WebClientOptions

setSslHandshakeTimeout

public CachingWebClientOptions setSslHandshakeTimeout(long sslHandshakeTimeout)

Overrides:

setSslHandshakeTimeout in class WebClientOptions

setSslHandshakeTimeoutUnit

public CachingWebClientOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)

Overrides:

setSslHandshakeTimeoutUnit in class WebClientOptions