net.jodah.lyra

Class ConnectionOptions

java.lang.Object

net.jodah.lyra.ConnectionOptions

public class ConnectionOptions
extends Object

Connection options. Changes will not effect connections that have already been created.

Constructor Summary

Constructors

Constructor and Description
ConnectionOptions()
ConnectionOptions(com.rabbitmq.client.ConnectionFactory connectionFactory) Creates a new Options object for the connectionFactory.

Method Summary

Methods

Modifier and Type	Method and Description
ConnectionOptions	copy() Returns a new copy of the options.
com.rabbitmq.client.Address[]	getAddresses() Returns the addresses to attempt connections to, in round-robin order.
com.rabbitmq.client.ConnectionFactory	getConnectionFactory() Returns the ConnectionFactory for the options.
ExecutorService	getConsumerExecutor() Returns the consumer executor.
String	getName()
ConnectionOptions	withAddresses(com.rabbitmq.client.Address... addresses) Sets the addresses.
ConnectionOptions	withAddresses(String addresses) Sets the addresses.
ConnectionOptions	withClientProperties(Map<String,Object> clientProperties) Sets the client properties.
ConnectionOptions	withConnectionFactory(com.rabbitmq.client.ConnectionFactory connectionFactory) Sets the connectionFactory.
ConnectionOptions	withConnectionTimeout(Duration connectionTimeout) Set the connection timeout, zero for infinite, for an individual connection attempt.
ConnectionOptions	withConsumerExecutor(ExecutorService executor) Sets the executor used to handle consumer callbacks.
ConnectionOptions	withHost(String host) Sets the host.
ConnectionOptions	withHosts(String... hosts) Sets the hosts.
ConnectionOptions	withName(String name) Sets the connection name.
ConnectionOptions	withPassword(String password) Sets the password.
ConnectionOptions	withPort(int port) Set the port.
ConnectionOptions	withRequestedHeartbeat(Duration requestedHeartbeat) Set the requested heartbeat, zero for none.
ConnectionOptions	withSocketFactory(SocketFactory socketFactory) Sets the SocketFactory to create connections with.
ConnectionOptions	withSsl() Enabled SSL using SSLv3.
ConnectionOptions	withSslProtocol(SSLContext sslContext) Sets the initialized sslContext to use.
ConnectionOptions	withSslProtocol(String sslProtocol) Sets the sslProtocol to use.
ConnectionOptions	withSslProtocol(String sslProtocol, TrustManager trustManager) Sets the sslProtocol and trustManager to use.
ConnectionOptions	withUsername(String username) Sets the username.
ConnectionOptions	withVirtualHost(String virtualHost) Sets the virtual host.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionOptions

public ConnectionOptions()

ConnectionOptions

public ConnectionOptions(com.rabbitmq.client.ConnectionFactory connectionFactory)

Creates a new Options object for the connectionFactory.

Throws:

NullPointerException - if connectionFactory is null

Method Detail

copy

public ConnectionOptions copy()

Returns a new copy of the options.

getAddresses

public com.rabbitmq.client.Address[] getAddresses()

Returns the addresses to attempt connections to, in round-robin order.

See Also:

withAddresses(Address...), withAddresses(String), withHost(String), withHosts(String...)

getConnectionFactory

public com.rabbitmq.client.ConnectionFactory getConnectionFactory()

Returns the ConnectionFactory for the options.

getConsumerExecutor

public ExecutorService getConsumerExecutor()

Returns the consumer executor.

See Also:

withConsumerExecutor(ExecutorService)

getName

public String getName()

withAddresses

public ConnectionOptions withAddresses(com.rabbitmq.client.Address... addresses)

Sets the addresses.

Throws:

NullPointerException - if addresses is null

withAddresses

public ConnectionOptions withAddresses(String addresses)

Sets the addresses.

Parameters:

addresses - formatted as "host1[:port],host2[:port]", etc.

Throws:

NullPointerException - if addresses is null

withClientProperties

public ConnectionOptions withClientProperties(Map<String,Object> clientProperties)

Sets the client properties.

Throws:

NullPointerException - if clientProperties is null

withConnectionFactory

public ConnectionOptions withConnectionFactory(com.rabbitmq.client.ConnectionFactory connectionFactory)

Sets the connectionFactory.

Throws:

NullPointerException - if connectionFactory is null

withConnectionTimeout

public ConnectionOptions withConnectionTimeout(Duration connectionTimeout)

Set the connection timeout, zero for infinite, for an individual connection attempt. Overrides the global recovery policy.

Throws:

NullPointerException - if connectionTimeout is null

withConsumerExecutor

public ConnectionOptions withConsumerExecutor(ExecutorService executor)

Sets the executor used to handle consumer callbacks. The executor will not be shutdown when a connection is closed.

Throws:

NullPointerException - if executor is null

withHost

public ConnectionOptions withHost(String host)

Sets the host.

Throws:

NullPointerException - if host is null

withHosts

public ConnectionOptions withHosts(String... hosts)

Sets the hosts.

Throws:

NullPointerException - if hosts is null

withName

public ConnectionOptions withName(String name)

Sets the connection name. Used for logging and consumer thread naming.

Throws:

NullPointerException - if name is null

withPassword

public ConnectionOptions withPassword(String password)

Sets the password.

withPort

public ConnectionOptions withPort(int port)

Set the port.

withRequestedHeartbeat

public ConnectionOptions withRequestedHeartbeat(Duration requestedHeartbeat)

Set the requested heartbeat, zero for none.

Throws:

NullPointerException - if requestedHeartbeat is null

withSocketFactory

public ConnectionOptions withSocketFactory(SocketFactory socketFactory)

Sets the SocketFactory to create connections with.

Throws:

NullPointerException - if hosts is null

withSsl

public ConnectionOptions withSsl()
                          throws NoSuchAlgorithmException,
                                 KeyManagementException

Enabled SSL using SSLv3.

Throws:

NoSuchAlgorithmException

KeyManagementException

withSslProtocol

public ConnectionOptions withSslProtocol(SSLContext sslContext)

Sets the initialized sslContext to use.

Throws:

NullPointerException - if sslContext is null

withSslProtocol

public ConnectionOptions withSslProtocol(String sslProtocol)
                                  throws NoSuchAlgorithmException,
                                         KeyManagementException

Sets the sslProtocol to use.

Throws:

NullPointerException - if sslProtocol is null

NoSuchAlgorithmException

KeyManagementException

withSslProtocol

public ConnectionOptions withSslProtocol(String sslProtocol,
                                TrustManager trustManager)
                                  throws NoSuchAlgorithmException,
                                         KeyManagementException

Sets the sslProtocol and trustManager to use.

Throws:

NullPointerException - if sslProtocol or trustManager are null

NoSuchAlgorithmException

KeyManagementException

withUsername

public ConnectionOptions withUsername(String username)

Sets the username.

Throws:

NullPointerException - if username is null

withVirtualHost

public ConnectionOptions withVirtualHost(String virtualHost)

Sets the virtual host.

Throws:

NullPointerException - if virtualHost is null