io.vertx.amqp

Class AmqpClientOptions

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

io.vertx.amqp.AmqpClientOptions

public class AmqpClientOptions
extends ProtonClientOptions

Configures the AMQP Client. You can also configure the underlying Proton instance. Refer to ProtonClientOptions for details.

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_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

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

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
AmqpClientOptions()
AmqpClientOptions(AmqpClientOptions other)
AmqpClientOptions(JsonObject json)

Method Summary

Modifier and Type	Method and Description
AmqpClientOptions	addCrlPath(String crlPath)
AmqpClientOptions	addCrlValue(Buffer crlValue)
AmqpClientOptions	addEnabledCipherSuite(String suite)
AmqpClientOptions	addEnabledSaslMechanism(String saslMechanism)
AmqpClientOptions	addEnabledSecureTransportProtocol(String protocol)
String	getContainerId()
String	getHost()
String	getPassword()
int	getPort()
String	getUsername()
AmqpClientOptions	removeEnabledSecureTransportProtocol(String protocol)
AmqpClientOptions	setConnectTimeout(int connectTimeout)
AmqpClientOptions	setContainerId(String containerId) Sets the container id.
AmqpClientOptions	setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)
AmqpClientOptions	setHeartbeat(int heartbeat)
AmqpClientOptions	setHost(String host) Sets the host.
AmqpClientOptions	setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)
AmqpClientOptions	setIdleTimeout(int idleTimeout)
AmqpClientOptions	setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)
AmqpClientOptions	setKeyStoreOptions(JksOptions options)
AmqpClientOptions	setLocalAddress(String localAddress)
AmqpClientOptions	setMaxFrameSize(int maxFrameSize)
AmqpClientOptions	setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)
AmqpClientOptions	setPassword(String pwd) Sets the password.
AmqpClientOptions	setPemKeyCertOptions(PemKeyCertOptions options)
AmqpClientOptions	setPemTrustOptions(PemTrustOptions options)
AmqpClientOptions	setPfxKeyCertOptions(PfxOptions options)
AmqpClientOptions	setPfxTrustOptions(PfxOptions options)
AmqpClientOptions	setPort(int port) Sets the port.
AmqpClientOptions	setReceiveBufferSize(int receiveBufferSize)
AmqpClientOptions	setReconnectAttempts(int attempts)
AmqpClientOptions	setReconnectInterval(long interval)
AmqpClientOptions	setReuseAddress(boolean reuseAddress)
AmqpClientOptions	setReusePort(boolean reusePort)
AmqpClientOptions	setSendBufferSize(int sendBufferSize)
AmqpClientOptions	setSniServerName(String sniServerName)
AmqpClientOptions	setSoLinger(int soLinger)
AmqpClientOptions	setSsl(boolean ssl)
AmqpClientOptions	setSslEngineOptions(SSLEngineOptions sslEngineOptions)
AmqpClientOptions	setTcpCork(boolean tcpCork)
AmqpClientOptions	setTcpFastOpen(boolean tcpFastOpen)
AmqpClientOptions	setTcpKeepAlive(boolean tcpKeepAlive)
AmqpClientOptions	setTcpNoDelay(boolean tcpNoDelay)
AmqpClientOptions	setTcpQuickAck(boolean tcpQuickAck)
AmqpClientOptions	setTrafficClass(int trafficClass)
AmqpClientOptions	setTrustAll(boolean trustAll)
AmqpClientOptions	setTrustStoreOptions(JksOptions options)
AmqpClientOptions	setUsername(String username) Sets the username.
AmqpClientOptions	setVirtualHost(String virtualHost)
JsonObject	toJson()

Methods inherited from class io.vertx.proton.ProtonClientOptions

equals, getEnabledSaslMechanisms, getHeartbeat, getMaxFrameSize, getSniServerName, getVirtualHost, hashCode, setIdleTimeoutUnit, setKeyCertOptions, setLogActivity, setMetricsName, setProxyOptions, setSslHandshakeTimeout, setSslHandshakeTimeoutUnit, setTrustOptions, setUseAlpn

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

getHostnameVerificationAlgorithm, getReconnectAttempts, getReconnectInterval

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

getConnectTimeout, getLocalAddress, getMetricsName, 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, getSoLinger, getSslEngineOptions, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getTrustOptions, getTrustStoreOptions, isSsl, isTcpCork, isTcpFastOpen, isTcpKeepAlive, isTcpNoDelay, isTcpQuickAck, isUseAlpn

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

getLogActivity, getReceiveBufferSize, getSendBufferSize, getTrafficClass, isReuseAddress, isReusePort

Methods inherited from class java.lang.Object

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

Constructor Detail

AmqpClientOptions

public AmqpClientOptions()

AmqpClientOptions

public AmqpClientOptions(JsonObject json)

AmqpClientOptions

public AmqpClientOptions(AmqpClientOptions other)

Method Detail

toJson

public JsonObject toJson()

Overrides:

toJson in class ProtonClientOptions

getHost

public String getHost()

Returns:

the host.

setHost

public AmqpClientOptions setHost(String host)

Sets the host.

Parameters:

host - the host, must not be null when the client attempt to connect. Defaults to system variable amqp-client-host and to AMQP_CLIENT_HOST environment variable

Returns:

the current AmqpClientOptions

getPort

public int getPort()

Returns:

the port.

setPort

public AmqpClientOptions setPort(int port)

Sets the port.

Parameters:

port - the port, defaults to system variable amqp-client-port and to AMQP_CLIENT_PORT environment variable and if neither is set 5672.

Returns:

the current AmqpClientOptions

getUsername

public String getUsername()

Returns:

the username

setUsername

public AmqpClientOptions setUsername(String username)

Sets the username.

Parameters:

username - the username, defaults to system variable amqp-client-username and to AMQP_CLIENT_USERNAME environment variable.

Returns:

the current AmqpClientOptions

getPassword

public String getPassword()

Returns:

the password

setPassword

public AmqpClientOptions setPassword(String pwd)

Sets the password.

Parameters:

pwd - the password, defaults to system variable amqp-client-password and to AMQP_CLIENT_PASSWORD environment variable.

Returns:

the current AmqpClientOptions

getContainerId

public String getContainerId()

Returns:

the container id.

setContainerId

public AmqpClientOptions setContainerId(String containerId)

Sets the container id.

Parameters:

containerId - the container id

Returns:

the current AmqpClientOptions

addEnabledSaslMechanism

public AmqpClientOptions addEnabledSaslMechanism(String saslMechanism)

Overrides:

addEnabledSaslMechanism in class ProtonClientOptions

See Also:

ProtonClientOptions.addEnabledSaslMechanism(String)

setSendBufferSize

public AmqpClientOptions setSendBufferSize(int sendBufferSize)

Overrides:

setSendBufferSize in class ProtonClientOptions

See Also:

ProtonClientOptions.setSendBufferSize(int)

setReceiveBufferSize

public AmqpClientOptions setReceiveBufferSize(int receiveBufferSize)

Overrides:

setReceiveBufferSize in class ProtonClientOptions

See Also:

ProtonClientOptions.setReceiveBufferSize(int)

setReuseAddress

public AmqpClientOptions setReuseAddress(boolean reuseAddress)

Overrides:

setReuseAddress in class ProtonClientOptions

See Also:

ProtonClientOptions.setReuseAddress(boolean)

setTrafficClass

public AmqpClientOptions setTrafficClass(int trafficClass)

Overrides:

setTrafficClass in class ProtonClientOptions

See Also:

ProtonClientOptions.setTrafficClass(int)

setTcpNoDelay

public AmqpClientOptions setTcpNoDelay(boolean tcpNoDelay)

Overrides:

setTcpNoDelay in class ProtonClientOptions

See Also:

ProtonClientOptions.setTcpNoDelay(boolean)

setTcpKeepAlive

public AmqpClientOptions setTcpKeepAlive(boolean tcpKeepAlive)

Overrides:

setTcpKeepAlive in class ProtonClientOptions

See Also:

ProtonClientOptions.setTcpKeepAlive(boolean)

setSoLinger

public AmqpClientOptions setSoLinger(int soLinger)

Overrides:

setSoLinger in class ProtonClientOptions

See Also:

ProtonClientOptions.setSoLinger(int)

setIdleTimeout

public AmqpClientOptions setIdleTimeout(int idleTimeout)

Overrides:

setIdleTimeout in class ProtonClientOptions

See Also:

ProtonClientOptions.setIdleTimeout(int)

setSsl

public AmqpClientOptions setSsl(boolean ssl)

Overrides:

setSsl in class ProtonClientOptions

See Also:

ProtonClientOptions.setSsl(boolean)

setKeyStoreOptions

public AmqpClientOptions setKeyStoreOptions(JksOptions options)

Overrides:

setKeyStoreOptions in class ProtonClientOptions

See Also:

ProtonClientOptions.setKeyStoreOptions(JksOptions)

setPfxKeyCertOptions

public AmqpClientOptions setPfxKeyCertOptions(PfxOptions options)

Overrides:

setPfxKeyCertOptions in class ProtonClientOptions

See Also:

ProtonClientOptions.setPfxKeyCertOptions(PfxOptions)

setPemKeyCertOptions

public AmqpClientOptions setPemKeyCertOptions(PemKeyCertOptions options)

Overrides:

setPemKeyCertOptions in class ProtonClientOptions

See Also:

ProtonClientOptions.setPemKeyCertOptions(PemKeyCertOptions)

setTrustStoreOptions

public AmqpClientOptions setTrustStoreOptions(JksOptions options)

Overrides:

setTrustStoreOptions in class ProtonClientOptions

See Also:

ProtonClientOptions.setTrustStoreOptions(JksOptions)

setPemTrustOptions

public AmqpClientOptions setPemTrustOptions(PemTrustOptions options)

Overrides:

setPemTrustOptions in class ProtonClientOptions

See Also:

ProtonClientOptions.setPemTrustOptions(PemTrustOptions)

setPfxTrustOptions

public AmqpClientOptions setPfxTrustOptions(PfxOptions options)

Overrides:

setPfxTrustOptions in class ProtonClientOptions

See Also:

ProtonClientOptions.setPfxTrustOptions(PfxOptions)

addEnabledCipherSuite

public AmqpClientOptions addEnabledCipherSuite(String suite)

Overrides:

addEnabledCipherSuite in class ProtonClientOptions

See Also:

ProtonClientOptions.addEnabledCipherSuite(String)

addCrlPath

public AmqpClientOptions addCrlPath(String crlPath)

Overrides:

addCrlPath in class ProtonClientOptions

See Also:

ProtonClientOptions.addCrlPath(String)

addCrlValue

public AmqpClientOptions addCrlValue(Buffer crlValue)

Overrides:

addCrlValue in class ProtonClientOptions

See Also:

ProtonClientOptions.addCrlValue(Buffer)

setTrustAll

public AmqpClientOptions setTrustAll(boolean trustAll)

Overrides:

setTrustAll in class ProtonClientOptions

See Also:

ProtonClientOptions.setTrustAll(boolean)

setConnectTimeout

public AmqpClientOptions setConnectTimeout(int connectTimeout)

Overrides:

setConnectTimeout in class ProtonClientOptions

See Also:

ProtonClientOptions.setConnectTimeout(int)

setReconnectAttempts

public AmqpClientOptions setReconnectAttempts(int attempts)

Overrides:

setReconnectAttempts in class ProtonClientOptions

See Also:

ProtonClientOptions.setReconnectAttempts(int)

setReconnectInterval

public AmqpClientOptions setReconnectInterval(long interval)

Overrides:

setReconnectInterval in class ProtonClientOptions

See Also:

ProtonClientOptions.setReconnectInterval(long)

addEnabledSecureTransportProtocol

public AmqpClientOptions addEnabledSecureTransportProtocol(String protocol)

Overrides:

addEnabledSecureTransportProtocol in class ProtonClientOptions

See Also:

ProtonClientOptions.addEnabledSecureTransportProtocol(String)

setHostnameVerificationAlgorithm

public AmqpClientOptions setHostnameVerificationAlgorithm(String hostnameVerificationAlgorithm)

Overrides:

setHostnameVerificationAlgorithm in class ProtonClientOptions

See Also:

ProtonClientOptions.setHostnameVerificationAlgorithm(String)

setJdkSslEngineOptions

public AmqpClientOptions setJdkSslEngineOptions(JdkSSLEngineOptions sslEngineOptions)

Overrides:

setJdkSslEngineOptions in class ProtonClientOptions

See Also:

ProtonClientOptions.setJdkSslEngineOptions(JdkSSLEngineOptions)

setOpenSslEngineOptions

public AmqpClientOptions setOpenSslEngineOptions(OpenSSLEngineOptions sslEngineOptions)

Overrides:

setOpenSslEngineOptions in class ProtonClientOptions

See Also:

ProtonClientOptions.setOpenSslEngineOptions(OpenSSLEngineOptions)

setSslEngineOptions

public AmqpClientOptions setSslEngineOptions(SSLEngineOptions sslEngineOptions)

Overrides:

setSslEngineOptions in class ProtonClientOptions

See Also:

ProtonClientOptions.setSslEngineOptions(SSLEngineOptions)

setLocalAddress

public AmqpClientOptions setLocalAddress(String localAddress)

Overrides:

setLocalAddress in class ProtonClientOptions

See Also:

ProtonClientOptions.setLocalAddress(String)

setReusePort

public AmqpClientOptions setReusePort(boolean reusePort)

Overrides:

setReusePort in class ProtonClientOptions

See Also:

ProtonClientOptions.setReusePort(boolean)

setTcpCork

public AmqpClientOptions setTcpCork(boolean tcpCork)

Overrides:

setTcpCork in class ProtonClientOptions

See Also:

ProtonClientOptions.setTcpCork(boolean)

setTcpFastOpen

public AmqpClientOptions setTcpFastOpen(boolean tcpFastOpen)

Overrides:

setTcpFastOpen in class ProtonClientOptions

See Also:

ProtonClientOptions.setTcpFastOpen(boolean)

setTcpQuickAck

public AmqpClientOptions setTcpQuickAck(boolean tcpQuickAck)

Overrides:

setTcpQuickAck in class ProtonClientOptions

See Also:

ProtonClientOptions.setTcpQuickAck(boolean)

removeEnabledSecureTransportProtocol

public AmqpClientOptions removeEnabledSecureTransportProtocol(String protocol)

Overrides:

removeEnabledSecureTransportProtocol in class ProtonClientOptions

See Also:

ProtonClientOptions.removeEnabledSecureTransportProtocol(String)

setEnabledSecureTransportProtocols

public AmqpClientOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)

Overrides:

setEnabledSecureTransportProtocols in class ProtonClientOptions

See Also:

ProtonClientOptions.setEnabledSecureTransportProtocols(Set)

setVirtualHost

public AmqpClientOptions setVirtualHost(String virtualHost)

Overrides:

setVirtualHost in class ProtonClientOptions

See Also:

ProtonClientOptions.setVirtualHost(String)

setSniServerName

public AmqpClientOptions setSniServerName(String sniServerName)

Overrides:

setSniServerName in class ProtonClientOptions

See Also:

ProtonClientOptions.setSniServerName(String)

setHeartbeat

public AmqpClientOptions setHeartbeat(int heartbeat)

Overrides:

setHeartbeat in class ProtonClientOptions

See Also:

ProtonClientOptions.setHeartbeat(int)

setMaxFrameSize

public AmqpClientOptions setMaxFrameSize(int maxFrameSize)

Overrides:

setMaxFrameSize in class ProtonClientOptions

See Also:

ProtonClientOptions.setMaxFrameSize(int)