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_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_USE_ALPN, DEFAULT_WRITE_IDLE_TIMEOUTDEFAULT_LOG_ENABLED, DEFAULT_RECEIVE_BUFFER_SIZE, DEFAULT_REUSE_ADDRESS, DEFAULT_REUSE_PORT, 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 |
|---|---|
ClientOptionsBase |
addCrlPath(String crlPath)
Add a CRL path
|
ClientOptionsBase |
addCrlValue(Buffer crlValue)
Add a CRL value
|
ClientOptionsBase |
addEnabledCipherSuite(String suite)
Add an enabled cipher suite, appended to the ordered suites.
|
ClientOptionsBase |
addEnabledSecureTransportProtocol(String protocol)
Add an enabled SSL/TLS protocols, appended to the ordered protocols.
|
ClientOptionsBase |
addNonProxyHost(String host)
Add a
host to the getNonProxyHosts() list. |
int |
getConnectTimeout() |
String |
getLocalAddress() |
String |
getMetricsName() |
List<String> |
getNonProxyHosts() |
ProxyOptions |
getProxyOptions()
Get proxy options for connections
|
boolean |
isTrustAll() |
ClientOptionsBase |
removeEnabledSecureTransportProtocol(String protocol)
Removes an enabled SSL/TLS protocol from the ordered protocols.
|
ClientOptionsBase |
setConnectTimeout(int connectTimeout)
Set the connect timeout
|
ClientOptionsBase |
setIdleTimeout(int idleTimeout)
Set the idle timeout, default time unit is seconds.
|
ClientOptionsBase |
setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
Set the idle timeout unit.
|
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 |
setNonProxyHosts(List<String> nonProxyHosts)
Set a list of remote hosts that are not proxied when the client is configured to use a proxy.
|
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 |
setReadIdleTimeout(int idleTimeout)
Set the read idle timeout, default time unit is seconds.
|
ClientOptionsBase |
setReceiveBufferSize(int receiveBufferSize)
Set the TCP receive buffer size
|
ClientOptionsBase |
setReuseAddress(boolean reuseAddress)
Set the value of reuse address
|
ClientOptionsBase |
setReusePort(boolean reusePort)
Set the value of reuse port.
|
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 |
setTcpCork(boolean tcpCork)
Enable the
TCP_CORK option - only with linux native transport. |
ClientOptionsBase |
setTcpFastOpen(boolean tcpFastOpen)
Enable the
TCP_FASTOPEN option - only with linux native transport. |
ClientOptionsBase |
setTcpKeepAlive(boolean tcpKeepAlive)
Set whether TCP keep alive is enabled
|
ClientOptionsBase |
setTcpNoDelay(boolean tcpNoDelay)
Set whether TCP no delay is enabled
|
ClientOptionsBase |
setTcpQuickAck(boolean tcpQuickAck)
Enable the
TCP_QUICKACK option - only with linux native transport. |
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 |
setWriteIdleTimeout(int idleTimeout)
Set the write idle timeout, default time unit is seconds.
|
JsonObject |
toJson()
Convert to JSON
|
getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getReadIdleTimeout, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getTrustOptions, getTrustStoreOptions, getWriteIdleTimeout, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn, setEnabledSecureTransportProtocols, setSslHandshakeTimeout, setSslHandshakeTimeoutUnitgetLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePortpublic 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 ClientOptionsBase setNonProxyHosts(List<String> nonProxyHosts)
nonProxyHosts configuration.
Entries can use the * wildcard character for pattern matching, e.g *.example.com matches www.example.com.
nonProxyHosts - the list of non proxies hostspublic ClientOptionsBase addNonProxyHost(String host)
host to the getNonProxyHosts() list.host - the added hostpublic 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 setIdleTimeout(int idleTimeout)
TCPSSLOptionsTCPSSLOptions.setIdleTimeoutUnit(TimeUnit)setIdleTimeout in class TCPSSLOptionsidleTimeout - the timeoutpublic ClientOptionsBase setReadIdleTimeout(int idleTimeout)
TCPSSLOptionsTCPSSLOptions.setIdleTimeoutUnit(TimeUnit)setReadIdleTimeout in class TCPSSLOptionsidleTimeout - the read timeoutpublic ClientOptionsBase setWriteIdleTimeout(int idleTimeout)
TCPSSLOptionsTCPSSLOptions.setIdleTimeoutUnit(TimeUnit)setWriteIdleTimeout in class TCPSSLOptionsidleTimeout - the write timeoutpublic ClientOptionsBase setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
TCPSSLOptionssetIdleTimeoutUnit in class TCPSSLOptionsidleTimeoutUnit - specify time unit.public 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 TCPSSLOptionssendBufferSize - the buffers size, in bytespublic ClientOptionsBase setReceiveBufferSize(int receiveBufferSize)
NetworkOptionssetReceiveBufferSize in class TCPSSLOptionsreceiveBufferSize - the buffers size, in bytespublic ClientOptionsBase setReuseAddress(boolean reuseAddress)
NetworkOptionssetReuseAddress in class TCPSSLOptionsreuseAddress - the value of reuse addresspublic ClientOptionsBase setReusePort(boolean reusePort)
NetworkOptionssetReusePort in class TCPSSLOptionsreusePort - the value of reuse portpublic ClientOptionsBase setTrafficClass(int trafficClass)
NetworkOptionssetTrafficClass in class TCPSSLOptionstrafficClass - the value of traffic classpublic ClientOptionsBase addEnabledCipherSuite(String suite)
TCPSSLOptionsaddEnabledCipherSuite in class TCPSSLOptionssuite - the suiteTCPSSLOptions.getEnabledCipherSuites()public ClientOptionsBase addCrlPath(String crlPath) throws NullPointerException
TCPSSLOptionsaddCrlPath in class TCPSSLOptionscrlPath - the pathNullPointerExceptionpublic ClientOptionsBase addCrlValue(Buffer crlValue) throws NullPointerException
TCPSSLOptionsaddCrlValue in class TCPSSLOptionscrlValue - the valueNullPointerExceptionpublic ClientOptionsBase addEnabledSecureTransportProtocol(String protocol)
TCPSSLOptionsaddEnabledSecureTransportProtocol in class TCPSSLOptionsprotocol - the SSL/TLS protocol to enablepublic ClientOptionsBase removeEnabledSecureTransportProtocol(String protocol)
TCPSSLOptionsremoveEnabledSecureTransportProtocol in class TCPSSLOptionsprotocol - the SSL/TLS protocol to disablepublic ClientOptionsBase setTcpFastOpen(boolean tcpFastOpen)
TCPSSLOptionsTCP_FASTOPEN option - only with linux native transport.setTcpFastOpen in class TCPSSLOptionstcpFastOpen - the fast open valuepublic ClientOptionsBase setTcpCork(boolean tcpCork)
TCPSSLOptionsTCP_CORK option - only with linux native transport.setTcpCork in class TCPSSLOptionstcpCork - the cork valuepublic ClientOptionsBase setTcpQuickAck(boolean tcpQuickAck)
TCPSSLOptionsTCP_QUICKACK option - only with linux native transport.setTcpQuickAck in class TCPSSLOptionstcpQuickAck - the quick ack valueCopyright © 2022 Eclipse. All rights reserved.