public class ConsulClientOptions extends WebClientOptions
DEFAULT_FOLLOW_REDIRECTS, DEFAULT_USER_AGENT, DEFAULT_USER_AGENT_ENABLED
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_MAX_POOL_SIZE, DEFAULT_HTTP2_MULTIPLEXING_LIMIT, DEFAULT_KEEP_ALIVE, 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_PROTOCOL_VERSION, DEFAULT_SEND_UNMASKED_FRAMES, DEFAULT_TRY_USE_COMPRESSION, DEFAULT_VERIFY_HOST
DEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME, DEFAULT_TRUST_ALL
DEFAULT_IDLE_TIMEOUT, DEFAULT_SO_LINGER, DEFAULT_SSL, DEFAULT_SSL_ENGINE, DEFAULT_TCP_KEEP_ALIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_USE_ALPN, DEFAULT_USE_POOLED_BUFFERS
DEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS
Constructor and Description |
---|
ConsulClientOptions()
Default constructor
|
ConsulClientOptions(ConsulClientOptions options)
Copy constructor
|
ConsulClientOptions(JsonObject json)
Constructor from JSON
|
Modifier and Type | Method and Description |
---|---|
ConsulClientOptions |
addCrlPath(String crlPath)
Add a CRL path
|
ConsulClientOptions |
addCrlValue(Buffer crlValue)
Add a CRL value
|
ConsulClientOptions |
addEnabledCipherSuite(String suite)
Add an enabled cipher suite, appended to the ordered suites.
|
ConsulClientOptions |
addEnabledSecureTransportProtocol(String protocol)
Add an enabled SSL/TLS protocols, appended to the ordered protocols.
|
String |
getAclToken()
Get the ACL token.
|
String |
getDc()
Get the datacenter name
|
String |
getHost()
Get Consul host.
|
int |
getPort()
Get Consul HTTP API port.
|
long |
getTimeout()
Get timeout in milliseconds
|
ConsulClientOptions |
setAclToken(String aclToken)
Set the ACL token.
|
ConsulClientOptions |
setAlpnVersions(List<HttpVersion> alpnVersions)
Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation.
|
ConsulClientOptions |
setConnectTimeout(int connectTimeout)
Set the connect timeout
|
ConsulClientOptions |
setDc(String dc)
Set the datacenter name.
|
ConsulClientOptions |
setDecoderInitialBufferSize(int decoderInitialBufferSize)
set to
initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder. |
ConsulClientOptions |
setDefaultHost(String defaultHost)
Set the default host name to be used by this client in requests if none is provided when making the request.
|
ConsulClientOptions |
setDefaultPort(int defaultPort)
Set the default port to be used by this client in requests if none is provided when making the request.
|
ConsulClientOptions |
setFollowRedirects(boolean followRedirects)
Configure the default behavior of the client to follow HTTP
30x redirections. |
ConsulClientOptions |
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. |
ConsulClientOptions |
setHost(String host)
Set Consul host.
|
ConsulClientOptions |
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). |
ConsulClientOptions |
setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)
Set the default HTTP/2 connection window size.
|
ConsulClientOptions |
setHttp2MaxPoolSize(int max)
Set the maximum pool size for HTTP/2 connections
|
ConsulClientOptions |
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.
|
ConsulClientOptions |
setIdleTimeout(int idleTimeout)
Set the idle timeout, in seconds.
|
ConsulClientOptions |
setInitialSettings(Http2Settings settings)
Set the HTTP/2 connection settings immediately sent by to the server when the client connects.
|
ConsulClientOptions |
setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions) |
ConsulClientOptions |
setKeepAlive(boolean keepAlive)
Set whether keep alive is enabled on the client
|
ConsulClientOptions |
setKeyCertOptions(KeyCertOptions options)
Set the key/cert options.
|
ConsulClientOptions |
setKeyStoreOptions(JksOptions options)
Set the key/cert options in jks format, aka Java keystore.
|
ConsulClientOptions |
setLocalAddress(String localAddress)
Set the local interface to bind for network connections.
|
ConsulClientOptions |
setLogActivity(boolean logActivity)
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
|
ConsulClientOptions |
setMaxChunkSize(int maxChunkSize)
Set the maximum HTTP chunk size
|
ConsulClientOptions |
setMaxHeaderSize(int maxHeaderSize)
Set the maximum length of all headers for HTTP/1.x .
|
ConsulClientOptions |
setMaxInitialLineLength(int maxInitialLineLength)
Set the maximum length of the initial line for HTTP/1.x (e.g.
|
ConsulClientOptions |
setMaxPoolSize(int maxPoolSize)
Set the maximum pool size for connections
|
ConsulClientOptions |
setMaxRedirects(int maxRedirects)
Set to
maxRedirects the maximum number of redirection a request can follow. |
ConsulClientOptions |
setMaxWaitQueueSize(int maxWaitQueueSize)
Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in
a ConnectionPoolTooBusyException.
|
ConsulClientOptions |
setMaxWebsocketFrameSize(int maxWebsocketFrameSize)
Set the max websocket frame size
|
ConsulClientOptions |
setMaxWebsocketMessageSize(int maxWebsocketMessageSize)
Set the max websocket message size
|
ConsulClientOptions |
setMetricsName(String metricsName)
Set the metrics name identifying the reported metrics, useful for grouping metrics
with the same name.
|
ConsulClientOptions |
setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions) |
ConsulClientOptions |
setPemKeyCertOptions(PemKeyCertOptions options)
Set the key/cert store options in pem format.
|
ConsulClientOptions |
setPemTrustOptions(PemTrustOptions pemTrustOptions)
Set the trust options.
|
ConsulClientOptions |
setPfxKeyCertOptions(PfxOptions options)
Set the key/cert options in pfx format.
|
ConsulClientOptions |
setPfxTrustOptions(PfxOptions options)
Set the trust options in pfx format
|
ConsulClientOptions |
setPipelining(boolean pipelining)
Set whether pipe-lining is enabled on the client
|
ConsulClientOptions |
setPipeliningLimit(int limit)
Set the limit of pending requests a pipe-lined HTTP/1 connection can send.
|
ConsulClientOptions |
setPort(int port)
Set Consul HTTP API port.
|
ConsulClientOptions |
setProtocolVersion(HttpVersion protocolVersion)
Set the protocol version.
|
ConsulClientOptions |
setProxyOptions(ProxyOptions proxyOptions)
Set proxy options for connections via CONNECT proxy (e.g.
|
ConsulClientOptions |
setReceiveBufferSize(int receiveBufferSize)
Set the TCP receive buffer size
|
ConsulClientOptions |
setReuseAddress(boolean reuseAddress)
Set the value of reuse address
|
ConsulClientOptions |
setSendBufferSize(int sendBufferSize)
Set the TCP send buffer size
|
ConsulClientOptions |
setSendUnmaskedFrames(boolean sendUnmaskedFrames)
Set true when the client wants to skip frame masking.
|
ConsulClientOptions |
setSoLinger(int soLinger)
Set whether SO_linger keep alive is enabled
|
ConsulClientOptions |
setSsl(boolean ssl)
Set whether SSL/TLS is enabled
|
ConsulClientOptions |
setSslEngineOptions(SSLEngineOptions sslEngineOptions)
Set to use SSL engine implementation to use.
|
ConsulClientOptions |
setTcpKeepAlive(boolean tcpKeepAlive)
Set whether TCP keep alive is enabled
|
ConsulClientOptions |
setTcpNoDelay(boolean tcpNoDelay)
Set whether TCP no delay is enabled
|
ConsulClientOptions |
setTimeout(long timeoutMs)
Sets the amount of time (in milliseconds) after which if the request does not return any data
within the timeout period an failure will be passed to the handler and the request will be closed.
|
ConsulClientOptions |
setTrafficClass(int trafficClass)
Set the value of traffic class
|
ConsulClientOptions |
setTrustAll(boolean trustAll)
Set whether all server certificates should be trusted
|
ConsulClientOptions |
setTrustOptions(TrustOptions options)
Set the trust options.
|
ConsulClientOptions |
setTrustStoreOptions(JksOptions options)
Set the trust options in jks format, aka Java truststore
|
ConsulClientOptions |
setTryUseCompression(boolean tryUseCompression)
Set whether compression is enabled
|
ConsulClientOptions |
setUseAlpn(boolean useAlpn)
Set the ALPN usage.
|
ConsulClientOptions |
setUsePooledBuffers(boolean usePooledBuffers)
Set whether Netty pooled buffers are enabled
|
ConsulClientOptions |
setUserAgent(String userAgent)
Sets the Web Client user agent header.
|
ConsulClientOptions |
setUserAgentEnabled(boolean userAgentEnabled)
Sets whether the Web Client should send a user agent header.
|
ConsulClientOptions |
setVerifyHost(boolean verifyHost)
Set whether hostname verification is enabled
|
JsonObject |
toJson()
Convert to JSON
|
getUserAgent, isFollowRedirects, isUserAgentEnabled, loadUserAgent
equals, getAlpnVersions, getDecoderInitialBufferSize, getDefaultHost, getDefaultPort, getHttp2ConnectionWindowSize, getHttp2MaxPoolSize, getHttp2MultiplexingLimit, getInitialSettings, getMaxChunkSize, getMaxHeaderSize, getMaxInitialLineLength, getMaxPoolSize, getMaxRedirects, getMaxWaitQueueSize, getMaxWebsocketFrameSize, getMaxWebsocketMessageSize, getPipeliningLimit, getProtocolVersion, hashCode, isForceSni, isHttp2ClearTextUpgrade, isKeepAlive, isPipelining, isSendUnmaskedFrames, isTryUseCompression, isVerifyHost
getConnectTimeout, getLocalAddress, getMetricsName, getProxyOptions, isTrustAll
getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getSoLinger, getSslEngineOptions, getTrustOptions, getTrustStoreOptions, isSsl, isTcpKeepAlive, isTcpNoDelay, isUseAlpn, isUsePooledBuffers
getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress
public ConsulClientOptions()
public ConsulClientOptions(ConsulClientOptions options)
options
- the one to copypublic ConsulClientOptions(JsonObject json)
json
- the JSONpublic JsonObject toJson()
toJson
in class WebClientOptions
public String getHost()
public int getPort()
public String getAclToken()
public String getDc()
public long getTimeout()
public ConsulClientOptions setHost(String host)
host
- consul hostpublic ConsulClientOptions setPort(int port)
port
- Consul HTTP API portpublic ConsulClientOptions setAclToken(String aclToken)
aclToken
- the ACL tokenpublic ConsulClientOptions setDc(String dc)
dc
- the datacenter namepublic ConsulClientOptions setTimeout(long timeoutMs)
timeoutMs
- timeout in millisecondspublic ConsulClientOptions setSendBufferSize(int sendBufferSize)
setSendBufferSize
in class WebClientOptions
sendBufferSize
- the buffers size, in bytespublic ConsulClientOptions setReceiveBufferSize(int receiveBufferSize)
setReceiveBufferSize
in class WebClientOptions
receiveBufferSize
- the buffers size, in bytespublic ConsulClientOptions setReuseAddress(boolean reuseAddress)
setReuseAddress
in class WebClientOptions
reuseAddress
- the value of reuse addresspublic ConsulClientOptions setTrafficClass(int trafficClass)
setTrafficClass
in class WebClientOptions
trafficClass
- the value of traffic classpublic ConsulClientOptions setTcpNoDelay(boolean tcpNoDelay)
setTcpNoDelay
in class WebClientOptions
tcpNoDelay
- true if TCP no delay is enabled (Nagle disabled)public ConsulClientOptions setTcpKeepAlive(boolean tcpKeepAlive)
setTcpKeepAlive
in class WebClientOptions
tcpKeepAlive
- true if TCP keep alive is enabledpublic ConsulClientOptions setSoLinger(int soLinger)
setSoLinger
in class WebClientOptions
soLinger
- true if SO_linger is enabledpublic ConsulClientOptions setUsePooledBuffers(boolean usePooledBuffers)
setUsePooledBuffers
in class WebClientOptions
usePooledBuffers
- true if pooled buffers enabledpublic ConsulClientOptions setIdleTimeout(int idleTimeout)
setIdleTimeout
in class WebClientOptions
idleTimeout
- the timeout, in secondspublic ConsulClientOptions setSsl(boolean ssl)
setSsl
in class WebClientOptions
ssl
- true if enabledpublic ConsulClientOptions setKeyCertOptions(KeyCertOptions options)
setKeyCertOptions
in class WebClientOptions
options
- the key store optionspublic ConsulClientOptions setKeyStoreOptions(JksOptions options)
setKeyStoreOptions
in class WebClientOptions
options
- the key store in jks formatpublic ConsulClientOptions setPfxKeyCertOptions(PfxOptions options)
setPfxKeyCertOptions
in class WebClientOptions
options
- the key cert options in pfx formatpublic ConsulClientOptions setTrustOptions(TrustOptions options)
setTrustOptions
in class WebClientOptions
options
- the trust optionspublic ConsulClientOptions setPemKeyCertOptions(PemKeyCertOptions options)
setPemKeyCertOptions
in class WebClientOptions
options
- the options in pem formatpublic ConsulClientOptions setTrustStoreOptions(JksOptions options)
setTrustStoreOptions
in class WebClientOptions
options
- the trust options in jks formatpublic ConsulClientOptions setPfxTrustOptions(PfxOptions options)
setPfxTrustOptions
in class WebClientOptions
options
- the trust options in pfx formatpublic ConsulClientOptions setTrustAll(boolean trustAll)
setTrustAll
in class WebClientOptions
trustAll
- true if all should be trustedpublic ConsulClientOptions setPemTrustOptions(PemTrustOptions pemTrustOptions)
setPemTrustOptions
in class WebClientOptions
pemTrustOptions
- the trust optionspublic ConsulClientOptions setConnectTimeout(int connectTimeout)
setConnectTimeout
in class WebClientOptions
connectTimeout
- connect timeout, in mspublic ConsulClientOptions setMaxPoolSize(int maxPoolSize)
setMaxPoolSize
in class WebClientOptions
maxPoolSize
- the maximum pool sizepublic ConsulClientOptions setHttp2MultiplexingLimit(int limit)
-1
means to use the value sent by the server's initial settings.
-1
is the default value.setHttp2MultiplexingLimit
in class WebClientOptions
limit
- the maximum concurrent for an HTTP/2 connectionpublic ConsulClientOptions setHttp2MaxPoolSize(int max)
setHttp2MaxPoolSize
in class WebClientOptions
max
- the maximum pool sizepublic ConsulClientOptions setHttp2ConnectionWindowSize(int http2ConnectionWindowSize)
Http2Settings.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 WebClientOptions
http2ConnectionWindowSize
- the window size applied to the connectionpublic ConsulClientOptions setKeepAlive(boolean keepAlive)
setKeepAlive
in class WebClientOptions
keepAlive
- true if enabledpublic ConsulClientOptions setPipelining(boolean pipelining)
setPipelining
in class WebClientOptions
pipelining
- true if enabledpublic ConsulClientOptions setPipeliningLimit(int limit)
setPipeliningLimit
in class WebClientOptions
limit
- the limit of pending requestspublic ConsulClientOptions setVerifyHost(boolean verifyHost)
setVerifyHost
in class WebClientOptions
verifyHost
- true if enabledpublic ConsulClientOptions setTryUseCompression(boolean tryUseCompression)
setTryUseCompression
in class WebClientOptions
tryUseCompression
- true if enabledpublic ConsulClientOptions setSendUnmaskedFrames(boolean sendUnmaskedFrames)
setSendUnmaskedFrames
in class WebClientOptions
sendUnmaskedFrames
- true if enabledpublic ConsulClientOptions setMaxWebsocketFrameSize(int maxWebsocketFrameSize)
setMaxWebsocketFrameSize
in class WebClientOptions
maxWebsocketFrameSize
- the max frame size, in bytespublic ConsulClientOptions setDefaultHost(String defaultHost)
setDefaultHost
in class WebClientOptions
public ConsulClientOptions setDefaultPort(int defaultPort)
setDefaultPort
in class WebClientOptions
public ConsulClientOptions setProtocolVersion(HttpVersion protocolVersion)
setProtocolVersion
in class WebClientOptions
protocolVersion
- the protocol versionpublic ConsulClientOptions setMaxChunkSize(int maxChunkSize)
setMaxChunkSize
in class WebClientOptions
maxChunkSize
- the maximum chunk sizepublic ConsulClientOptions setMaxInitialLineLength(int maxInitialLineLength)
"HTTP/1.1 200 OK"
)setMaxInitialLineLength
in class HttpClientOptions
maxInitialLineLength
- the new maximum initial lengthpublic ConsulClientOptions setMaxHeaderSize(int maxHeaderSize)
setMaxHeaderSize
in class WebClientOptions
maxHeaderSize
- the new maximum lengthpublic ConsulClientOptions setMaxWaitQueueSize(int maxWaitQueueSize)
setMaxWaitQueueSize
in class WebClientOptions
maxWaitQueueSize
- the maximum number of waiting requestspublic ConsulClientOptions setInitialSettings(Http2Settings settings)
setInitialSettings
in class HttpClientOptions
settings
- the settings valuepublic ConsulClientOptions setUseAlpn(boolean useAlpn)
setUseAlpn
in class WebClientOptions
useAlpn
- true when Application-Layer Protocol Negotiation should be usedpublic ConsulClientOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)
setSslEngineOptions
in class WebClientOptions
sslEngineOptions
- the ssl engine to usepublic ConsulClientOptions setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)
setJdkSslEngineOptions
in class WebClientOptions
public ConsulClientOptions setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
setOpenSslEngineOptions
in class WebClientOptions
public ConsulClientOptions setAlpnVersions(List<HttpVersion> alpnVersions)
setProtocolVersion(io.vertx.core.http.HttpVersion)
:
HttpVersion.HTTP_2
: [ "h2", "http/1.1" ]HttpClientOptions.getProtocolVersion()
]setAlpnVersions
in class WebClientOptions
alpnVersions
- the versionspublic ConsulClientOptions setHttp2ClearTextUpgrade(boolean value)
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).setHttp2ClearTextUpgrade
in class WebClientOptions
value
- the upgrade valuepublic ConsulClientOptions setMaxRedirects(int maxRedirects)
maxRedirects
the maximum number of redirection a request can follow.setMaxRedirects
in class WebClientOptions
maxRedirects
- the maximum number of redirectionpublic ConsulClientOptions setMetricsName(String metricsName)
setMetricsName
in class WebClientOptions
metricsName
- the metrics namepublic ConsulClientOptions setProxyOptions(ProxyOptions proxyOptions)
setProxyOptions
in class WebClientOptions
proxyOptions
- proxy options objectpublic ConsulClientOptions setLocalAddress(String localAddress)
setLocalAddress
in class WebClientOptions
localAddress
- the local addresspublic ConsulClientOptions setLogActivity(boolean logActivity)
setLogActivity
in class WebClientOptions
logActivity
- true for logging the network activitypublic ConsulClientOptions setUserAgentEnabled(boolean userAgentEnabled)
setUserAgentEnabled
in class WebClientOptions
userAgentEnabled
- true to send a user agent header, false otherwisepublic ConsulClientOptions setUserAgent(String userAgent)
setUserAgent
in class WebClientOptions
userAgent
- user agent header valuepublic ConsulClientOptions setFollowRedirects(boolean followRedirects)
30x
redirections.setFollowRedirects
in class WebClientOptions
followRedirects
- true when a redirect is followedpublic ConsulClientOptions setMaxWebsocketMessageSize(int maxWebsocketMessageSize)
setMaxWebsocketMessageSize
in class HttpClientOptions
maxWebsocketMessageSize
- the max message size, in bytespublic ConsulClientOptions addEnabledCipherSuite(String suite)
addEnabledCipherSuite
in class WebClientOptions
suite
- the suitepublic ConsulClientOptions addEnabledSecureTransportProtocol(String protocol)
addEnabledSecureTransportProtocol
in class WebClientOptions
protocol
- the SSL/TLS protocol do enabledpublic ConsulClientOptions addCrlPath(String crlPath) throws NullPointerException
addCrlPath
in class WebClientOptions
crlPath
- the pathNullPointerException
public ConsulClientOptions addCrlValue(Buffer crlValue) throws NullPointerException
addCrlValue
in class WebClientOptions
crlValue
- the valueNullPointerException
public ConsulClientOptions setForceSni(boolean forceSni)
true
forces the server name to be always sent.setForceSni
in class HttpClientOptions
forceSni
- true when the client should always use SNI on TLS/SSL connectionspublic ConsulClientOptions setDecoderInitialBufferSize(int decoderInitialBufferSize)
initialBufferSizeHttpDecoder
the initial buffer of the HttpDecoder.setDecoderInitialBufferSize
in class HttpClientOptions
decoderInitialBufferSize
- the initial buffer sizeCopyright © 2017. All rights reserved.