Configuration Reference

Version:3.1.0

Rabbitmq Config Properties

🔗
Table 1. Configuration Properties for DefaultChannelPoolConfiguration
Property Type Description

rabbitmq.servers.*.channel-pool

RabbitConnectionFactoryConfig$ChannelPoolConfiguration

Sets the channel pool configuration.

rabbitmq.servers.*.channel-pool.max-idle-channels

java.lang.Integer

Sets the maximum number of idle channels that will be kept open.
🔗
Table 2. Configuration Properties for DefaultRpcConfiguration
Property Type Description

rabbitmq.rpc

RabbitConnectionFactoryConfig$RpcConfiguration

Sets the RPC configuration.

rabbitmq.rpc.timeout

java.time.Duration

Sets the timeout duration before cancelling an RPC call. Default {@value #DEFAULT_TIMEOUT_SECONDS} seconds.
🔗
Table 3. Configuration Properties for ClusterRabbitConnectionFactoryConfig
Property Type Description

rabbitmq.servers.*.host

java.lang.String

rabbitmq.servers.*.port

int

rabbitmq.servers.*.username

java.lang.String

rabbitmq.servers.*.password

java.lang.String

rabbitmq.servers.*.credentials-provider

com.rabbitmq.client.impl.CredentialsProvider

rabbitmq.servers.*.virtual-host

java.lang.String

rabbitmq.servers.*.uri

java.net.URI

rabbitmq.servers.*.requested-channel-max

int

rabbitmq.servers.*.requested-frame-max

int

rabbitmq.servers.*.connection-timeout

int

rabbitmq.servers.*.handshake-timeout

int

rabbitmq.servers.*.shutdown-timeout

int

rabbitmq.servers.*.requested-heartbeat

int

rabbitmq.servers.*.client-properties

java.util.Map

rabbitmq.servers.*.sasl-config

com.rabbitmq.client.SaslConfig

rabbitmq.servers.*.socket-factory

javax.net.SocketFactory

rabbitmq.servers.*.socket-configurator

com.rabbitmq.client.SocketConfigurator

rabbitmq.servers.*.shared-executor

java.util.concurrent.ExecutorService

rabbitmq.servers.*.shutdown-executor

java.util.concurrent.ExecutorService

rabbitmq.servers.*.heartbeat-executor

java.util.concurrent.ScheduledExecutorService

rabbitmq.servers.*.thread-factory

java.util.concurrent.ThreadFactory

rabbitmq.servers.*.exception-handler

com.rabbitmq.client.ExceptionHandler

rabbitmq.servers.*.automatic-recovery-enabled

boolean

rabbitmq.servers.*.topology-recovery-enabled

boolean

rabbitmq.servers.*.topology-recovery-executor

java.util.concurrent.ExecutorService

rabbitmq.servers.*.metrics-collector

com.rabbitmq.client.MetricsCollector

rabbitmq.servers.*.credentials-refresh-service

com.rabbitmq.client.impl.CredentialsRefreshService

rabbitmq.servers.*.network-recovery-interval

int

rabbitmq.servers.*.recovery-delay-handler

com.rabbitmq.client.RecoveryDelayHandler

rabbitmq.servers.*.nio-params

com.rabbitmq.client.impl.nio.NioParams

rabbitmq.servers.*.channel-rpc-timeout

int

rabbitmq.servers.*.ssl-context-factory

com.rabbitmq.client.SslContextFactory

rabbitmq.servers.*.channel-should-check-rpc-response-type

boolean

rabbitmq.servers.*.work-pool-timeout

int

rabbitmq.servers.*.error-on-write-listener

com.rabbitmq.client.impl.ErrorOnWriteListener

rabbitmq.servers.*.topology-recovery-filter

com.rabbitmq.client.impl.recovery.TopologyRecoveryFilter

rabbitmq.servers.*.connection-recovery-triggering-condition

java.util.function.Predicate

rabbitmq.servers.*.topology-recovery-retry-handler

com.rabbitmq.client.impl.recovery.RetryHandler

rabbitmq.servers.*.traffic-listener

com.rabbitmq.client.TrafficListener

rabbitmq.servers.*.addresses

java.util.List

Sets the addresses to be passed to {@link ConnectionFactory#newConnection(List)}.

rabbitmq.servers.*.consumer-executor

java.lang.String

Sets the name of which executor service consumers should be executed on. Default {@value #DEFAULT_CONSUMER_EXECUTOR}.

rabbitmq.servers.*.confirm-timeout

java.time.Duration

How long to wait for a publisher confirm. Default value (5s).
🔗
Table 4. Configuration Properties for DefaultRpcConfiguration
Property Type Description

rabbitmq.servers.*.rpc

RabbitConnectionFactoryConfig$RpcConfiguration

Sets the RPC configuration.

rabbitmq.servers.*.rpc.timeout

java.time.Duration

Sets the timeout duration before cancelling an RPC call. Default {@value #DEFAULT_TIMEOUT_SECONDS} seconds.
🔗
Table 5. Configuration Properties for DefaultChannelPoolConfiguration
Property Type Description

rabbitmq.channel-pool

RabbitConnectionFactoryConfig$ChannelPoolConfiguration

Sets the channel pool configuration.

rabbitmq.channel-pool.max-idle-channels

java.lang.Integer

Sets the maximum number of idle channels that will be kept open.
🔗
Table 6. Configuration Properties for SingleRabbitConnectionFactoryConfig
Property Type Description

rabbitmq.host

java.lang.String

rabbitmq.port

int

rabbitmq.username

java.lang.String

rabbitmq.password

java.lang.String

rabbitmq.credentials-provider

com.rabbitmq.client.impl.CredentialsProvider

rabbitmq.virtual-host

java.lang.String

rabbitmq.uri

java.net.URI

rabbitmq.requested-channel-max

int

rabbitmq.requested-frame-max

int

rabbitmq.connection-timeout

int

rabbitmq.handshake-timeout

int

rabbitmq.shutdown-timeout

int

rabbitmq.requested-heartbeat

int

rabbitmq.client-properties

java.util.Map

rabbitmq.sasl-config

com.rabbitmq.client.SaslConfig

rabbitmq.socket-factory

javax.net.SocketFactory

rabbitmq.socket-configurator

com.rabbitmq.client.SocketConfigurator

rabbitmq.shared-executor

java.util.concurrent.ExecutorService

rabbitmq.shutdown-executor

java.util.concurrent.ExecutorService

rabbitmq.heartbeat-executor

java.util.concurrent.ScheduledExecutorService

rabbitmq.thread-factory

java.util.concurrent.ThreadFactory

rabbitmq.exception-handler

com.rabbitmq.client.ExceptionHandler

rabbitmq.automatic-recovery-enabled

boolean

rabbitmq.topology-recovery-enabled

boolean

rabbitmq.topology-recovery-executor

java.util.concurrent.ExecutorService

rabbitmq.metrics-collector

com.rabbitmq.client.MetricsCollector

rabbitmq.credentials-refresh-service

com.rabbitmq.client.impl.CredentialsRefreshService

rabbitmq.network-recovery-interval

int

rabbitmq.recovery-delay-handler

com.rabbitmq.client.RecoveryDelayHandler

rabbitmq.nio-params

com.rabbitmq.client.impl.nio.NioParams

rabbitmq.channel-rpc-timeout

int

rabbitmq.ssl-context-factory

com.rabbitmq.client.SslContextFactory

rabbitmq.channel-should-check-rpc-response-type

boolean

rabbitmq.work-pool-timeout

int

rabbitmq.error-on-write-listener

com.rabbitmq.client.impl.ErrorOnWriteListener

rabbitmq.topology-recovery-filter

com.rabbitmq.client.impl.recovery.TopologyRecoveryFilter

rabbitmq.connection-recovery-triggering-condition

java.util.function.Predicate

rabbitmq.topology-recovery-retry-handler

com.rabbitmq.client.impl.recovery.RetryHandler

rabbitmq.traffic-listener

com.rabbitmq.client.TrafficListener

rabbitmq.addresses

java.util.List

Sets the addresses to be passed to {@link ConnectionFactory#newConnection(List)}.

rabbitmq.consumer-executor

java.lang.String

Sets the name of which executor service consumers should be executed on. Default {@value #DEFAULT_CONSUMER_EXECUTOR}.

rabbitmq.confirm-timeout

java.time.Duration

How long to wait for a publisher confirm. Default value (5s).