public abstract class ClientOptionsBase extends TCPSSLOptions
| Modifier and Type | Field and Description |
|---|---|
static int |
DEFAULT_CONNECT_TIMEOUT
The default value of connect timeout = 60000 ms
|
static String |
DEFAULT_METRICS_NAME
The default value of the client metrics = "":
|
static boolean |
DEFAULT_TRUST_ALL
The default value of whether all servers (SSL/TLS) should be trusted = false
|
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_BUFFERSDEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_SEND_BUFFER_SIZE, DEFAULT_TRAFFIC_CLASS| Constructor and Description |
|---|
ClientOptionsBase()
Default constructor
|
ClientOptionsBase(ClientOptionsBase other)
Copy constructor
|
ClientOptionsBase(JsonObject json)
Create options from some JSON
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object o) |
int |
getConnectTimeout() |
String |
getLocalAddress() |
String |
getMetricsName() |
ProxyOptions |
getProxyOptions()
Get proxy options for connections
|
int |
hashCode() |
boolean |
isTrustAll() |
ClientOptionsBase |
setConnectTimeout(int connectTimeout)
Set the connect timeout
|
ClientOptionsBase |
setIdleTimeout(int idleTimeout)
Set the idle timeout, in seconds.
|
ClientOptionsBase |
setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions) |
ClientOptionsBase |
setKeyCertOptions(KeyCertOptions options)
Set the key/cert options.
|
ClientOptionsBase |
setKeyStoreOptions(JksOptions options)
Set the key/cert options in jks format, aka Java keystore.
|
ClientOptionsBase |
setLocalAddress(String localAddress)
Set the local interface to bind for network connections.
|
ClientOptionsBase |
setLogActivity(boolean logEnabled)
Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.
|
ClientOptionsBase |
setMetricsName(String metricsName)
Set the metrics name identifying the reported metrics, useful for grouping metrics
with the same name.
|
ClientOptionsBase |
setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions) |
ClientOptionsBase |
setPemKeyCertOptions(PemKeyCertOptions options)
Set the key/cert store options in pem format.
|
ClientOptionsBase |
setPemTrustOptions(PemTrustOptions options)
Set the trust options in pem format
|
ClientOptionsBase |
setPfxKeyCertOptions(PfxOptions options)
Set the key/cert options in pfx format.
|
ClientOptionsBase |
setPfxTrustOptions(PfxOptions options)
Set the trust options in pfx format
|
ClientOptionsBase |
setProxyOptions(ProxyOptions proxyOptions)
Set proxy options for connections via CONNECT proxy (e.g.
|
ClientOptionsBase |
setReceiveBufferSize(int receiveBufferSize)
Set the TCP receive buffer size
|
ClientOptionsBase |
setReuseAddress(boolean reuseAddress)
Set the value of reuse address
|
ClientOptionsBase |
setSendBufferSize(int sendBufferSize)
Set the TCP send buffer size
|
ClientOptionsBase |
setSoLinger(int soLinger)
Set whether SO_linger keep alive is enabled
|
ClientOptionsBase |
setSsl(boolean ssl)
Set whether SSL/TLS is enabled
|
ClientOptionsBase |
setSslEngineOptions(SSLEngineOptions sslEngineOptions)
Set to use SSL engine implementation to use.
|
ClientOptionsBase |
setTcpKeepAlive(boolean tcpKeepAlive)
Set whether TCP keep alive is enabled
|
ClientOptionsBase |
setTcpNoDelay(boolean tcpNoDelay)
Set whether TCP no delay is enabled
|
ClientOptionsBase |
setTrafficClass(int trafficClass)
Set the value of traffic class
|
ClientOptionsBase |
setTrustAll(boolean trustAll)
Set whether all server certificates should be trusted
|
ClientOptionsBase |
setTrustOptions(TrustOptions options)
Set the trust options.
|
ClientOptionsBase |
setTrustStoreOptions(JksOptions options)
Set the trust options in jks format, aka Java truststore
|
ClientOptionsBase |
setUseAlpn(boolean useAlpn)
Set the ALPN usage.
|
ClientOptionsBase |
setUsePooledBuffers(boolean usePooledBuffers)
Set whether Netty pooled buffers are enabled
|
JsonObject |
toJson()
Convert to JSON
|
addCrlPath, addCrlValue, addEnabledCipherSuite, addEnabledSecureTransportProtocol, getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getSoLinger, getSslEngineOptions, getTrustOptions, getTrustStoreOptions, isSsl, isTcpKeepAlive, isTcpNoDelay, isUseAlpn, isUsePooledBuffersgetLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddresspublic static final int DEFAULT_CONNECT_TIMEOUT
public static final boolean DEFAULT_TRUST_ALL
public static final String DEFAULT_METRICS_NAME
public ClientOptionsBase()
public ClientOptionsBase(ClientOptionsBase other)
other - the options to copypublic ClientOptionsBase(JsonObject json)
json - the JSONpublic JsonObject toJson()
toJson in class TCPSSLOptionspublic boolean isTrustAll()
public ClientOptionsBase setTrustAll(boolean trustAll)
trustAll - true if all should be trustedpublic int getConnectTimeout()
public ClientOptionsBase setConnectTimeout(int connectTimeout)
connectTimeout - connect timeout, in mspublic String getMetricsName()
public ClientOptionsBase setMetricsName(String metricsName)
metricsName - the metrics namepublic ClientOptionsBase setProxyOptions(ProxyOptions proxyOptions)
proxyOptions - proxy options objectpublic ProxyOptions getProxyOptions()
public String getLocalAddress()
public ClientOptionsBase setLocalAddress(String localAddress)
localAddress - the local addresspublic ClientOptionsBase setLogActivity(boolean logEnabled)
NetworkOptionssetLogActivity in class TCPSSLOptionslogEnabled - true for logging the network activitypublic ClientOptionsBase setTcpNoDelay(boolean tcpNoDelay)
TCPSSLOptionssetTcpNoDelay in class TCPSSLOptionstcpNoDelay - true if TCP no delay is enabled (Nagle disabled)public ClientOptionsBase setTcpKeepAlive(boolean tcpKeepAlive)
TCPSSLOptionssetTcpKeepAlive in class TCPSSLOptionstcpKeepAlive - true if TCP keep alive is enabledpublic ClientOptionsBase setSoLinger(int soLinger)
TCPSSLOptionssetSoLinger in class TCPSSLOptionssoLinger - true if SO_linger is enabledpublic ClientOptionsBase setUsePooledBuffers(boolean usePooledBuffers)
TCPSSLOptionssetUsePooledBuffers in class TCPSSLOptionsusePooledBuffers - true if pooled buffers enabledpublic ClientOptionsBase setIdleTimeout(int idleTimeout)
TCPSSLOptionssetIdleTimeout in class TCPSSLOptionsidleTimeout - the timeout, in secondspublic ClientOptionsBase setSsl(boolean ssl)
TCPSSLOptionssetSsl in class TCPSSLOptionsssl - true if enabledpublic ClientOptionsBase setKeyCertOptions(KeyCertOptions options)
TCPSSLOptionssetKeyCertOptions in class TCPSSLOptionsoptions - the key store optionspublic ClientOptionsBase setKeyStoreOptions(JksOptions options)
TCPSSLOptionssetKeyStoreOptions in class TCPSSLOptionsoptions - the key store in jks formatpublic ClientOptionsBase setPfxKeyCertOptions(PfxOptions options)
TCPSSLOptionssetPfxKeyCertOptions in class TCPSSLOptionsoptions - the key cert options in pfx formatpublic ClientOptionsBase setPemKeyCertOptions(PemKeyCertOptions options)
TCPSSLOptionssetPemKeyCertOptions in class TCPSSLOptionsoptions - the options in pem formatpublic ClientOptionsBase setTrustOptions(TrustOptions options)
TCPSSLOptionssetTrustOptions in class TCPSSLOptionsoptions - the trust optionspublic ClientOptionsBase setTrustStoreOptions(JksOptions options)
TCPSSLOptionssetTrustStoreOptions in class TCPSSLOptionsoptions - the trust options in jks formatpublic ClientOptionsBase setPfxTrustOptions(PfxOptions options)
TCPSSLOptionssetPfxTrustOptions in class TCPSSLOptionsoptions - the trust options in pfx formatpublic ClientOptionsBase setPemTrustOptions(PemTrustOptions options)
TCPSSLOptionssetPemTrustOptions in class TCPSSLOptionsoptions - the trust options in pem formatpublic ClientOptionsBase setUseAlpn(boolean useAlpn)
TCPSSLOptionssetUseAlpn in class TCPSSLOptionsuseAlpn - true when Application-Layer Protocol Negotiation should be usedpublic ClientOptionsBase setSslEngineOptions(SSLEngineOptions sslEngineOptions)
TCPSSLOptionssetSslEngineOptions in class TCPSSLOptionssslEngineOptions - the ssl engine to usepublic ClientOptionsBase setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)
setJdkSslEngineOptions in class TCPSSLOptionspublic ClientOptionsBase setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
setOpenSslEngineOptions in class TCPSSLOptionspublic ClientOptionsBase setSendBufferSize(int sendBufferSize)
NetworkOptionssetSendBufferSize in class NetworkOptionssendBufferSize - the buffers size, in bytespublic ClientOptionsBase setReceiveBufferSize(int receiveBufferSize)
NetworkOptionssetReceiveBufferSize in class NetworkOptionsreceiveBufferSize - the buffers size, in bytespublic ClientOptionsBase setReuseAddress(boolean reuseAddress)
NetworkOptionssetReuseAddress in class NetworkOptionsreuseAddress - the value of reuse addresspublic ClientOptionsBase setTrafficClass(int trafficClass)
NetworkOptionssetTrafficClass in class NetworkOptionstrafficClass - the value of traffic classpublic boolean equals(Object o)
equals in class TCPSSLOptionspublic int hashCode()
hashCode in class TCPSSLOptionsCopyright © 2017. All rights reserved.