Package com.rabbitmq.client.amqp

Interface ConnectionBuilder

All Superinterfaces:

ConnectionSettings<ConnectionBuilder>

public interface ConnectionBuilder
extends ConnectionSettings<ConnectionBuilder>

Builder for Connection instances.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ConnectionBuilder.RecoveryConfiguration	Configuration for recovery.

Nested classes/interfaces inherited from interface com.rabbitmq.client.amqp.ConnectionSettings

ConnectionSettings.Affinity<T>, ConnectionSettings.AffinityContext, ConnectionSettings.AffinityStrategy, ConnectionSettings.TlsSettings<T>

Field Summary

Fields inherited from interface com.rabbitmq.client.amqp.ConnectionSettings

SASL_MECHANISM_ANONYMOUS, SASL_MECHANISM_EXTERNAL, SASL_MECHANISM_PLAIN

Method Summary

Modifier and Type	Method	Description
Connection	build()	Create the connection instance.
ConnectionBuilder	dispatchingExecutor(Executor executor)	Set the executor to use for incoming message delivery.
ConnectionBuilder	listeners(Resource.StateListener... listeners)	Add Resource.StateListeners to the connection.
ConnectionBuilder	name(String name)	Set the name of the connection.
ConnectionBuilder.RecoveryConfiguration	recovery()	Configuration for recovery.

Methods inherited from interface com.rabbitmq.client.amqp.ConnectionSettings

addressSelector, affinity, credentialsProvider, host, idleTimeout, oauth2, password, port, saslMechanism, tls, uri, uris, username, virtualHost

Method Details

name

ConnectionBuilder name(String name)

Set the name of the connection.

The name of the connection will be displayed in the management UI.

Parameters:

name - client-provided connection name

Returns:

this builder instance

recovery

ConnectionBuilder.RecoveryConfiguration recovery()

Configuration for recovery.

Returns:

recovery configuration

listeners

ConnectionBuilder listeners(Resource.StateListener... listeners)

Add Resource.StateListeners to the connection.

Parameters:

listeners - listeners

Returns:

this builder instance

dispatchingExecutor

ConnectionBuilder dispatchingExecutor(Executor executor)

Set the executor to use for incoming message delivery.

The executor is shared between the connection consumers.

By default, an ExecutorService with Runtime.availableProcessors() thread(s) is created for the connection.

It is the developer's responsibility to shut down the executor when it is no longer needed.

Parameters:

executor - executor for incoming message delivery

Returns:

this builder instance

See Also:

• AmqpEnvironmentBuilder.dispatchingExecutor(java.util.concurrent.Executor)

build

Connection build()

Create the connection instance.

Returns:

the configured connection