Package org.springframework.boot.autoconfigure.amqp

Interface RabbitConnectionDetails

All Superinterfaces:

ConnectionDetails

public interface RabbitConnectionDetails
extends ConnectionDetails

Details required to establish a connection to a RabbitMQ service.

Since:

3.1.0

Author:

Moritz Halbritter, Andy Wilkinson, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	RabbitConnectionDetails.Address	A RabbitMQ address.

Method Summary

Modifier and Type	Method	Description
List<RabbitConnectionDetails.Address>	getAddresses()	List of addresses to which the client should connect.
default RabbitConnectionDetails.Address	getFirstAddress()	Returns the first address.
default String	getPassword()	Login to authenticate against the broker.
default String	getUsername()	Login user to authenticate to the broker.
default String	getVirtualHost()	Virtual host to use when connecting to the broker.

Method Details

getUsername

default String getUsername()

Login user to authenticate to the broker.

Returns:

the login user to authenticate to the broker or null

getPassword

default String getPassword()

Login to authenticate against the broker.

Returns:

the login to authenticate against the broker or null

getVirtualHost

default String getVirtualHost()

Virtual host to use when connecting to the broker.

Returns:

the virtual host to use when connecting to the broker or null

getAddresses

List<RabbitConnectionDetails.Address> getAddresses()

List of addresses to which the client should connect. Must return at least one address.

Returns:

the list of addresses to which the client should connect

getFirstAddress

default RabbitConnectionDetails.Address getFirstAddress()

Returns the first address.

Returns:

the first address

Throws:

IllegalStateException - if the address list is empty