Class AmqpEnvironmentBuilder

java.lang.Object

com.rabbitmq.client.amqp.impl.AmqpEnvironmentBuilder

All Implemented Interfaces:

EnvironmentBuilder

public class AmqpEnvironmentBuilder
extends Object
implements EnvironmentBuilder

Builder to create an Environment instance of the RabbitMQ AMQP 1.0 Java Client.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AmqpEnvironmentBuilder.EnvironmentConnectionSettings	Common settings for connections created by an environment instance.

Constructor Summary

Constructors

Constructor	Description
AmqpEnvironmentBuilder()

Method Summary

Modifier and Type	Method	Description
Environment	build()	Create the environment instance.
AmqpEnvironmentBuilder.EnvironmentConnectionSettings	connectionSettings()	Returns connection settings shared by connection builders.
AmqpEnvironmentBuilder	dispatchingExecutor(Executor executor)	Set the shared executor to use for incoming message delivery in this environment instance connections.
AmqpEnvironmentBuilder	executorService(ExecutorService executorService)	Set executor service used for internal tasks (e.g. connection recovery).
AmqpEnvironmentBuilder	metricsCollector(MetricsCollector metricsCollector)	Set up a MetricsCollector.
AmqpEnvironmentBuilder	observationCollector(ObservationCollector observationCollector)	Set up an ObservationCollector.
AmqpEnvironmentBuilder	publisherExecutorService(ExecutorService publisherExecutorService)	Set executor service used to deal with broker responses after processing outbound messages.
AmqpEnvironmentBuilder	scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)	Set scheduled executor service used for internal tasks (e.g. connection recovery).

Methods inherited from class Object

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

Constructor Details

AmqpEnvironmentBuilder

public AmqpEnvironmentBuilder()

Method Details

executorService

public AmqpEnvironmentBuilder executorService(ExecutorService executorService)

Set executor service used for internal tasks (e.g. connection recovery).

The library uses sensible defaults, override only in case of problems.

Parameters:

executorService - the executor service

Returns:

this builder instance

dispatchingExecutor

public AmqpEnvironmentBuilder dispatchingExecutor(Executor executor)

Set the shared executor to use for incoming message delivery in this environment instance connections.

There is no shared executor by default, each connection uses its own, see ConnectionBuilder.dispatchingExecutor(Executor).

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

Parameters:

executor - the executor for incoming message delivery

Returns:

this builder instance

See Also:

• ConnectionBuilder.dispatchingExecutor(Executor)

scheduledExecutorService

public AmqpEnvironmentBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)

Set scheduled executor service used for internal tasks (e.g. connection recovery).

The library uses sensible defaults, override only in case of problems.

Parameters:

scheduledExecutorService - the scheduled executor service

Returns:

this builder instance

publisherExecutorService

public AmqpEnvironmentBuilder publisherExecutorService(ExecutorService publisherExecutorService)

Set executor service used to deal with broker responses after processing outbound messages.

The library uses sensible defaults, override only in case of problems.

Parameters:

publisherExecutorService - the executor service

Returns:

this builder instance

metricsCollector

public AmqpEnvironmentBuilder metricsCollector(MetricsCollector metricsCollector)

Set up a MetricsCollector.

Parameters:

metricsCollector - the metrics collector

Returns:

this builder instance

See Also:

• MicrometerMetricsCollector

observationCollector

public AmqpEnvironmentBuilder observationCollector(ObservationCollector observationCollector)

Set up an ObservationCollector.

Parameters:

observationCollector - the observation collector

Returns:

this builder instance

See Also:

• MicrometerObservationCollectorBuilder

connectionSettings

public AmqpEnvironmentBuilder.EnvironmentConnectionSettings connectionSettings()

Returns connection settings shared by connection builders.

These settings are optional, they are overridden with the appropriate methods in ConnectionBuilder.

Returns:

shared connection settings

See Also:

• ConnectionSettings
• ConnectionBuilder

build

public Environment build()

Create the environment instance.

Specified by:

build in interface EnvironmentBuilder

Returns:

the configured environment