public class ProtonClientOptions
extends io.vertx.core.net.NetClientOptions
ProtonClient
connect operations.DEFAULT_HOSTNAME_VERIFICATION_ALGORITHM, DEFAULT_RECONNECT_ATTEMPTS, DEFAULT_RECONNECT_INTERVAL
DEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME, DEFAULT_TRUST_ALL
DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS, DEFAULT_IDLE_TIMEOUT, DEFAULT_IDLE_TIMEOUT_TIME_UNIT, 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
Constructor and Description |
---|
ProtonClientOptions() |
ProtonClientOptions(io.vertx.core.json.JsonObject json)
Create options from JSON
|
ProtonClientOptions(ProtonClientOptions other)
Copy constructor
|
Modifier and Type | Method and Description |
---|---|
ProtonClientOptions |
addCrlPath(String crlPath) |
ProtonClientOptions |
addCrlValue(io.vertx.core.buffer.Buffer crlValue) |
ProtonClientOptions |
addEnabledCipherSuite(String suite) |
ProtonClientOptions |
addEnabledSaslMechanism(String saslMechanism)
Adds a mechanism name that the client may use during SASL negotiation.
|
ProtonClientOptions |
addEnabledSecureTransportProtocol(String protocol) |
boolean |
equals(Object obj) |
Set<String> |
getEnabledSaslMechanisms()
Get the mechanisms the client should be restricted to use.
|
int |
getHeartbeat()
Return the heartbeat (in milliseconds) as maximum delay between sending frames for the remote peers.
|
int |
getMaxFrameSize()
Gets the maximum frame size for the connection.
|
String |
getSniServerName()
Get the hostname override for TLS SNI Server Name set by
setSniServerName(String) . |
String |
getVirtualHost()
Get the virtual host name override for the connection AMQP Open frame and TLS SNI server name (if TLS is in use)
set by
setVirtualHost(String) . |
int |
hashCode() |
ProtonClientOptions |
removeEnabledSecureTransportProtocol(String protocol) |
ProtonClientOptions |
setConnectTimeout(int connectTimeout) |
ProtonClientOptions |
setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols) |
ProtonClientOptions |
setHeartbeat(int heartbeat)
Set the heartbeat (in milliseconds) as maximum delay between sending frames for the remote peers.
|
ProtonClientOptions |
setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm) |
ProtonClientOptions |
setIdleTimeout(int idleTimeout) |
ProtonClientOptions |
setIdleTimeoutUnit(TimeUnit idleTimeoutUnit) |
ProtonClientOptions |
setJdkSslEngineOptions(io.vertx.core.net.JdkSSLEngineOptions sslEngineOptions) |
ProtonClientOptions |
setKeyCertOptions(io.vertx.core.net.KeyCertOptions options) |
ProtonClientOptions |
setKeyStoreOptions(io.vertx.core.net.JksOptions options) |
ProtonClientOptions |
setLocalAddress(String localAddress) |
ProtonClientOptions |
setLogActivity(boolean logEnabled) |
ProtonClientOptions |
setMaxFrameSize(int maxFrameSize)
Sets the maximum frame size for the connection.
|
ProtonClientOptions |
setMetricsName(String metricsName) |
ProtonClientOptions |
setOpenSslEngineOptions(io.vertx.core.net.OpenSSLEngineOptions sslEngineOptions) |
ProtonClientOptions |
setPemKeyCertOptions(io.vertx.core.net.PemKeyCertOptions options) |
ProtonClientOptions |
setPemTrustOptions(io.vertx.core.net.PemTrustOptions options) |
ProtonClientOptions |
setPfxKeyCertOptions(io.vertx.core.net.PfxOptions options) |
ProtonClientOptions |
setPfxTrustOptions(io.vertx.core.net.PfxOptions options) |
ProtonClientOptions |
setProxyOptions(io.vertx.core.net.ProxyOptions proxyOptions) |
ProtonClientOptions |
setReceiveBufferSize(int receiveBufferSize) |
ProtonClientOptions |
setReconnectAttempts(int attempts) |
ProtonClientOptions |
setReconnectInterval(long interval) |
ProtonClientOptions |
setReuseAddress(boolean reuseAddress) |
ProtonClientOptions |
setReusePort(boolean reusePort) |
ProtonClientOptions |
setSendBufferSize(int sendBufferSize) |
ProtonClientOptions |
setSniServerName(String sniServerName)
Explicitly override the hostname to use for the TLS SNI server name.
|
ProtonClientOptions |
setSoLinger(int soLinger) |
ProtonClientOptions |
setSsl(boolean ssl) |
ProtonClientOptions |
setSslEngineOptions(io.vertx.core.net.SSLEngineOptions sslEngineOptions) |
ProtonClientOptions |
setSslHandshakeTimeout(long sslHandshakeTimeout) |
ProtonClientOptions |
setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit) |
ProtonClientOptions |
setTcpCork(boolean tcpCork) |
ProtonClientOptions |
setTcpFastOpen(boolean tcpFastOpen) |
ProtonClientOptions |
setTcpKeepAlive(boolean tcpKeepAlive) |
ProtonClientOptions |
setTcpNoDelay(boolean tcpNoDelay) |
ProtonClientOptions |
setTcpQuickAck(boolean tcpQuickAck) |
ProtonClientOptions |
setTrafficClass(int trafficClass) |
ProtonClientOptions |
setTrustAll(boolean trustAll) |
ProtonClientOptions |
setTrustOptions(io.vertx.core.net.TrustOptions options) |
ProtonClientOptions |
setTrustStoreOptions(io.vertx.core.net.JksOptions options) |
ProtonClientOptions |
setUseAlpn(boolean useAlpn) |
ProtonClientOptions |
setVirtualHost(String virtualHost)
Override the hostname value used in the connection AMQP Open frame and TLS SNI server name (if TLS is in use).
|
io.vertx.core.json.JsonObject |
toJson()
Convert to JSON
|
addNonProxyHost, getApplicationLayerProtocols, getHostnameVerificationAlgorithm, getReconnectAttempts, getReconnectInterval, setApplicationLayerProtocols, setNonProxyHosts
getConnectTimeout, getLocalAddress, getMetricsName, getNonProxyHosts, getProxyOptions, isTrustAll
getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getIdleTimeout, getIdleTimeoutUnit, getJdkSslEngineOptions, getKeyCertOptions, getKeyStoreOptions, getOpenSslEngineOptions, getPemKeyCertOptions, getPemTrustOptions, getPfxKeyCertOptions, getPfxTrustOptions, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getTrustOptions, getTrustStoreOptions, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn
public ProtonClientOptions()
public ProtonClientOptions(ProtonClientOptions other)
other
- the options to copypublic ProtonClientOptions(io.vertx.core.json.JsonObject json)
json
- the JSONpublic io.vertx.core.json.JsonObject toJson()
toJson
in class io.vertx.core.net.ClientOptionsBase
public Set<String> getEnabledSaslMechanisms()
public ProtonClientOptions addEnabledSaslMechanism(String saslMechanism)
saslMechanism
- the sasl mechanism name .public ProtonClientOptions setSendBufferSize(int sendBufferSize)
setSendBufferSize
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setReceiveBufferSize(int receiveBufferSize)
setReceiveBufferSize
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setReuseAddress(boolean reuseAddress)
setReuseAddress
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setTrafficClass(int trafficClass)
setTrafficClass
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setTcpNoDelay(boolean tcpNoDelay)
setTcpNoDelay
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setTcpKeepAlive(boolean tcpKeepAlive)
setTcpKeepAlive
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setSoLinger(int soLinger)
setSoLinger
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setIdleTimeout(int idleTimeout)
setIdleTimeout
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)
setIdleTimeoutUnit
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setSsl(boolean ssl)
setSsl
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setKeyStoreOptions(io.vertx.core.net.JksOptions options)
setKeyStoreOptions
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setPfxKeyCertOptions(io.vertx.core.net.PfxOptions options)
setPfxKeyCertOptions
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setPemKeyCertOptions(io.vertx.core.net.PemKeyCertOptions options)
setPemKeyCertOptions
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setTrustStoreOptions(io.vertx.core.net.JksOptions options)
setTrustStoreOptions
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setPemTrustOptions(io.vertx.core.net.PemTrustOptions options)
setPemTrustOptions
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setPfxTrustOptions(io.vertx.core.net.PfxOptions options)
setPfxTrustOptions
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions addEnabledCipherSuite(String suite)
addEnabledCipherSuite
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions addCrlPath(String crlPath) throws NullPointerException
addCrlPath
in class io.vertx.core.net.NetClientOptions
NullPointerException
public ProtonClientOptions addCrlValue(io.vertx.core.buffer.Buffer crlValue) throws NullPointerException
addCrlValue
in class io.vertx.core.net.NetClientOptions
NullPointerException
public ProtonClientOptions setTrustAll(boolean trustAll)
setTrustAll
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setConnectTimeout(int connectTimeout)
setConnectTimeout
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setReconnectAttempts(int attempts)
setReconnectAttempts
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setReconnectInterval(long interval)
setReconnectInterval
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setUseAlpn(boolean useAlpn)
setUseAlpn
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions addEnabledSecureTransportProtocol(String protocol)
addEnabledSecureTransportProtocol
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)
setHostnameVerificationAlgorithm
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setKeyCertOptions(io.vertx.core.net.KeyCertOptions options)
setKeyCertOptions
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setLogActivity(boolean logEnabled)
setLogActivity
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setMetricsName(String metricsName)
setMetricsName
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setProxyOptions(io.vertx.core.net.ProxyOptions proxyOptions)
setProxyOptions
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setTrustOptions(io.vertx.core.net.TrustOptions options)
setTrustOptions
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setJdkSslEngineOptions(io.vertx.core.net.JdkSSLEngineOptions sslEngineOptions)
setJdkSslEngineOptions
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setOpenSslEngineOptions(io.vertx.core.net.OpenSSLEngineOptions sslEngineOptions)
setOpenSslEngineOptions
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setSslEngineOptions(io.vertx.core.net.SSLEngineOptions sslEngineOptions)
setSslEngineOptions
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setSslHandshakeTimeout(long sslHandshakeTimeout)
setSslHandshakeTimeout
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)
setSslHandshakeTimeoutUnit
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setLocalAddress(String localAddress)
setLocalAddress
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setReusePort(boolean reusePort)
setReusePort
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setTcpCork(boolean tcpCork)
setTcpCork
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setTcpFastOpen(boolean tcpFastOpen)
setTcpFastOpen
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setTcpQuickAck(boolean tcpQuickAck)
setTcpQuickAck
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions removeEnabledSecureTransportProtocol(String protocol)
removeEnabledSecureTransportProtocol
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
setEnabledSecureTransportProtocols
in class io.vertx.core.net.NetClientOptions
public ProtonClientOptions setVirtualHost(String virtualHost)
ProtonClient.connect(java.lang.String, int, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.proton.ProtonConnection>>)
will be used for both, with SNI performed
implicit where a FQDN was specified.
The SNI server name can also be overridden explicitly using setSniServerName(String)
.virtualHost
- hostname to setpublic String getVirtualHost()
setVirtualHost(String)
.public ProtonClientOptions setSniServerName(String sniServerName)
virtualhost
or SNI server name is explicitly
overridden, the hostname specified in ProtonClient.connect(java.lang.String, int, io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.proton.ProtonConnection>>)
will be used, with SNI performed implicitly
where a FQDN was specified.
This method should typically only be needed to set different values for the [virtual] hostname and SNI server name.sniServerName
- hostname to set as SNI server namepublic String getSniServerName()
setSniServerName(String)
.public ProtonClientOptions setHeartbeat(int heartbeat)
heartbeat
- hearthbeat maximum delaypublic int getHeartbeat()
public ProtonClientOptions setMaxFrameSize(int maxFrameSize)
If this property is not set explicitly, a reasonable default value is used.
Setting this property to a negative value will result in no maximum frame size being announced at all.
maxFrameSize
- The frame size in bytes.public int getMaxFrameSize()
If this property is not set explicitly, a reasonable default value is used.
Copyright © 2021 Eclipse. All rights reserved.