io.vertx.proton

Class ProtonClientOptions

java.lang.Object

io.vertx.core.net.NetworkOptions

io.vertx.core.net.TCPSSLOptions

io.vertx.core.net.ClientOptionsBase

io.vertx.core.net.NetClientOptions

io.vertx.proton.ProtonClientOptions

public class ProtonClientOptions
extends NetClientOptions

Options for configuring ProtonClient connect operations.

Field Summary

Fields inherited from class io.vertx.core.net.NetClientOptions

DEFAULT_HOSTNAME_VERIFICATION_ALGORITHM, DEFAULT_RECONNECT_ATTEMPTS, DEFAULT_RECONNECT_INTERVAL

Fields inherited from class io.vertx.core.net.ClientOptionsBase

DEFAULT_CONNECT_TIMEOUT, DEFAULT_METRICS_NAME, DEFAULT_TRUST_ALL

Fields inherited from class io.vertx.core.net.TCPSSLOptions

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_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 and Description
ProtonClientOptions()
ProtonClientOptions(JsonObject json) Create options from JSON
ProtonClientOptions(ProtonClientOptions other) Copy constructor

Method Summary

Modifier and Type	Method and Description
ProtonClientOptions	addCrlPath(String crlPath)
ProtonClientOptions	addCrlValue(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(JdkSSLEngineOptions sslEngineOptions)
ProtonClientOptions	setKeyCertOptions(KeyCertOptions options)
ProtonClientOptions	setKeyStoreOptions(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(OpenSSLEngineOptions sslEngineOptions)
ProtonClientOptions	setPemKeyCertOptions(PemKeyCertOptions options)
ProtonClientOptions	setPemTrustOptions(PemTrustOptions options)
ProtonClientOptions	setPfxKeyCertOptions(PfxOptions options)
ProtonClientOptions	setPfxTrustOptions(PfxOptions options)
ProtonClientOptions	setProxyOptions(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(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(TrustOptions options)
ProtonClientOptions	setTrustStoreOptions(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).
JsonObject	toJson() Convert to JSON

Methods inherited from class io.vertx.core.net.NetClientOptions

addNonProxyHost, getApplicationLayerProtocols, getHostnameVerificationAlgorithm, getReconnectAttempts, getReconnectInterval, setActivityLogDataFormat, setApplicationLayerProtocols, setNonProxyHosts, setReadIdleTimeout, setWriteIdleTimeout

Methods inherited from class io.vertx.core.net.ClientOptionsBase

getConnectTimeout, getLocalAddress, getMetricsName, getNonProxyHosts, getProxyOptions, isTrustAll

Methods inherited from class io.vertx.core.net.TCPSSLOptions

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

Methods inherited from class io.vertx.core.net.NetworkOptions

getActivityLogDataFormat, getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePort

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProtonClientOptions

public ProtonClientOptions()

ProtonClientOptions

public ProtonClientOptions(ProtonClientOptions other)

Copy constructor

Parameters:

other - the options to copy

ProtonClientOptions

public ProtonClientOptions(JsonObject json)

Create options from JSON

Parameters:

json - the JSON

Method Detail

toJson

public JsonObject toJson()

Convert to JSON

Overrides:

toJson in class NetClientOptions

Returns:

the JSON

getEnabledSaslMechanisms

public Set<String> getEnabledSaslMechanisms()

Get the mechanisms the client should be restricted to use.

Returns:

the mechanisms, or null/empty set if there is no restriction in place

addEnabledSaslMechanism

public ProtonClientOptions addEnabledSaslMechanism(String saslMechanism)

Adds a mechanism name that the client may use during SASL negotiation.

Parameters:

saslMechanism - the sasl mechanism name .

Returns:

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

setSendBufferSize

public ProtonClientOptions setSendBufferSize(int sendBufferSize)

Overrides:

setSendBufferSize in class NetClientOptions

setReceiveBufferSize

public ProtonClientOptions setReceiveBufferSize(int receiveBufferSize)

Overrides:

setReceiveBufferSize in class NetClientOptions

setReuseAddress

public ProtonClientOptions setReuseAddress(boolean reuseAddress)

Overrides:

setReuseAddress in class NetClientOptions

setTrafficClass

public ProtonClientOptions setTrafficClass(int trafficClass)

Overrides:

setTrafficClass in class NetClientOptions

setTcpNoDelay

public ProtonClientOptions setTcpNoDelay(boolean tcpNoDelay)

Overrides:

setTcpNoDelay in class NetClientOptions

setTcpKeepAlive

public ProtonClientOptions setTcpKeepAlive(boolean tcpKeepAlive)

Overrides:

setTcpKeepAlive in class NetClientOptions

setSoLinger

public ProtonClientOptions setSoLinger(int soLinger)

Overrides:

setSoLinger in class NetClientOptions

setIdleTimeout

public ProtonClientOptions setIdleTimeout(int idleTimeout)

Overrides:

setIdleTimeout in class NetClientOptions

setIdleTimeoutUnit

public ProtonClientOptions setIdleTimeoutUnit(TimeUnit idleTimeoutUnit)

Overrides:

setIdleTimeoutUnit in class NetClientOptions

setSsl

public ProtonClientOptions setSsl(boolean ssl)

Overrides:

setSsl in class NetClientOptions

setKeyStoreOptions

public ProtonClientOptions setKeyStoreOptions(JksOptions options)

Overrides:

setKeyStoreOptions in class NetClientOptions

setPfxKeyCertOptions

public ProtonClientOptions setPfxKeyCertOptions(PfxOptions options)

Overrides:

setPfxKeyCertOptions in class NetClientOptions

setPemKeyCertOptions

public ProtonClientOptions setPemKeyCertOptions(PemKeyCertOptions options)

Overrides:

setPemKeyCertOptions in class NetClientOptions

setTrustStoreOptions

public ProtonClientOptions setTrustStoreOptions(JksOptions options)

Overrides:

setTrustStoreOptions in class NetClientOptions

setPemTrustOptions

public ProtonClientOptions setPemTrustOptions(PemTrustOptions options)

Overrides:

setPemTrustOptions in class NetClientOptions

setPfxTrustOptions

public ProtonClientOptions setPfxTrustOptions(PfxOptions options)

Overrides:

setPfxTrustOptions in class NetClientOptions

addEnabledCipherSuite

public ProtonClientOptions addEnabledCipherSuite(String suite)

Overrides:

addEnabledCipherSuite in class NetClientOptions

addCrlPath

public ProtonClientOptions addCrlPath(String crlPath)
                               throws NullPointerException

Overrides:

addCrlPath in class NetClientOptions

Throws:

NullPointerException

addCrlValue

public ProtonClientOptions addCrlValue(Buffer crlValue)
                                throws NullPointerException

Overrides:

addCrlValue in class NetClientOptions

Throws:

NullPointerException

setTrustAll

public ProtonClientOptions setTrustAll(boolean trustAll)

Overrides:

setTrustAll in class NetClientOptions

setConnectTimeout

public ProtonClientOptions setConnectTimeout(int connectTimeout)

Overrides:

setConnectTimeout in class NetClientOptions

setReconnectAttempts

public ProtonClientOptions setReconnectAttempts(int attempts)

Overrides:

setReconnectAttempts in class NetClientOptions

setReconnectInterval

public ProtonClientOptions setReconnectInterval(long interval)

Overrides:

setReconnectInterval in class NetClientOptions

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

setUseAlpn

public ProtonClientOptions setUseAlpn(boolean useAlpn)

Overrides:

setUseAlpn in class NetClientOptions

addEnabledSecureTransportProtocol

public ProtonClientOptions addEnabledSecureTransportProtocol(String protocol)

Overrides:

addEnabledSecureTransportProtocol in class NetClientOptions

setHostnameVerificationAlgorithm

public ProtonClientOptions setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)

Overrides:

setHostnameVerificationAlgorithm in class NetClientOptions

setKeyCertOptions

public ProtonClientOptions setKeyCertOptions(KeyCertOptions options)

Overrides:

setKeyCertOptions in class NetClientOptions

setLogActivity

public ProtonClientOptions setLogActivity(boolean logEnabled)

Overrides:

setLogActivity in class NetClientOptions

setMetricsName

public ProtonClientOptions setMetricsName(String metricsName)

Overrides:

setMetricsName in class NetClientOptions

setProxyOptions

public ProtonClientOptions setProxyOptions(ProxyOptions proxyOptions)

Overrides:

setProxyOptions in class NetClientOptions

setTrustOptions

public ProtonClientOptions setTrustOptions(TrustOptions options)

Overrides:

setTrustOptions in class NetClientOptions

setJdkSslEngineOptions

public ProtonClientOptions setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)

Overrides:

setJdkSslEngineOptions in class NetClientOptions

setOpenSslEngineOptions

public ProtonClientOptions setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)

Overrides:

setOpenSslEngineOptions in class NetClientOptions

setSslEngineOptions

public ProtonClientOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)

Overrides:

setSslEngineOptions in class NetClientOptions

setSslHandshakeTimeout

public ProtonClientOptions setSslHandshakeTimeout(long sslHandshakeTimeout)

Overrides:

setSslHandshakeTimeout in class NetClientOptions

setSslHandshakeTimeoutUnit

public ProtonClientOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)

Overrides:

setSslHandshakeTimeoutUnit in class NetClientOptions

setLocalAddress

public ProtonClientOptions setLocalAddress(String localAddress)

Overrides:

setLocalAddress in class NetClientOptions

setReusePort

public ProtonClientOptions setReusePort(boolean reusePort)

Overrides:

setReusePort in class NetClientOptions

setTcpCork

public ProtonClientOptions setTcpCork(boolean tcpCork)

Overrides:

setTcpCork in class NetClientOptions

setTcpFastOpen

public ProtonClientOptions setTcpFastOpen(boolean tcpFastOpen)

Overrides:

setTcpFastOpen in class NetClientOptions

setTcpQuickAck

public ProtonClientOptions setTcpQuickAck(boolean tcpQuickAck)

Overrides:

setTcpQuickAck in class NetClientOptions

removeEnabledSecureTransportProtocol

public ProtonClientOptions removeEnabledSecureTransportProtocol(String protocol)

Overrides:

removeEnabledSecureTransportProtocol in class NetClientOptions

setEnabledSecureTransportProtocols

public ProtonClientOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)

Overrides:

setEnabledSecureTransportProtocols in class NetClientOptions

setVirtualHost

public 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). By default, 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 for both, with SNI performed implicit where a FQDN was specified. The SNI server name can also be overridden explicitly using setSniServerName(String).

Parameters:

virtualHost - hostname to set

Returns:

current ProtonClientOptions instance

getVirtualHost

public 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).

Returns:

the hostname

setSniServerName

public ProtonClientOptions setSniServerName(String sniServerName)

Explicitly override the hostname to use for the TLS SNI server name. If neither the 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.

Parameters:

sniServerName - hostname to set as SNI server name

Returns:

current ProtonClientOptions instance

getSniServerName

public String getSniServerName()

Get the hostname override for TLS SNI Server Name set by setSniServerName(String).

Returns:

the hostname

setHeartbeat

public ProtonClientOptions setHeartbeat(int heartbeat)

Set the heartbeat (in milliseconds) as maximum delay between sending frames for the remote peers. If no frames are received within 2*heartbeat, the connection is closed

Parameters:

heartbeat - hearthbeat maximum delay

Returns:

current ProtonClientOptions instance

getHeartbeat

public int getHeartbeat()

Return the heartbeat (in milliseconds) as maximum delay between sending frames for the remote peers.

Returns:

hearthbeat maximum delay

setMaxFrameSize

public ProtonClientOptions setMaxFrameSize(int maxFrameSize)

Sets the maximum frame size for the connection.

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.

Parameters:

maxFrameSize - The frame size in bytes.

Returns:

This instance for setter chaining.

getMaxFrameSize

public int getMaxFrameSize()

Gets the maximum frame size for the connection.

If this property is not set explicitly, a reasonable default value is used.

Returns:

The frame size in bytes or -1 if no limit is set.