Package com.rabbitmq.client.amqp

Interface ConnectionSettings<T>

Type Parameters:

T - the type of object returned by methods, usually the object itself

All Known Subinterfaces:

AmqpEnvironmentBuilder.EnvironmentConnectionSettings, ConnectionBuilder

public interface ConnectionSettings<T>

Settings for a connection.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ConnectionSettings.Affinity<T>	Connection affinity settings.
static interface	ConnectionSettings.AffinityContext	Context for the ConnectionSettings.AffinityStrategy.
static interface	ConnectionSettings.AffinityStrategy	Strategy to pick candidate nodes with an affinity with a queue.
static interface	ConnectionSettings.TlsSettings<T>	TLS settings.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SASL_MECHANISM_ANONYMOUS	ANONYMOUS SASL mechanism (the default).
static final String	SASL_MECHANISM_EXTERNAL	EXTERNAL SASL mechanism (e.g. client certificate).
static final String	SASL_MECHANISM_PLAIN	PLAIN SASL mechanism (username and password).

Method Summary

Modifier and Type	Method	Description
T	addressSelector(AddressSelector selector)	The AddressSelector to use.
ConnectionSettings.Affinity<? extends T>	affinity()	Connection affinity settings.
T	credentialsProvider(CredentialsProvider credentialsProvider)	The CredentialsProvider to use.
T	host(String host)	The host to connect to.
T	idleTimeout(Duration idleTimeout)	Idle timeout (heartbeat) to use.
OAuth2Settings<? extends T>	oauth2()	OAuth 2 settings.
T	password(String password)	The password to use.
T	port(int port)	The port to use to connect.
T	saslMechanism(String mechanism)	SASL mechanism to use.
ConnectionSettings.TlsSettings<? extends T>	tls()	TLS settings.
T	uri(String uri)	The URI of a node to connect to.
T	uris(String... uris)	A list of URIs of nodes of the same cluster to use to connect to.
T	username(String username)	The username to use.
T	virtualHost(String virtualHost)	The virtual host to connect to.

Field Details

SASL_MECHANISM_ANONYMOUS

static final String SASL_MECHANISM_ANONYMOUS

ANONYMOUS SASL mechanism (the default).

See Also:

• Constant Field Values

SASL_MECHANISM_PLAIN

static final String SASL_MECHANISM_PLAIN

PLAIN SASL mechanism (username and password).

See Also:

• Constant Field Values

SASL_MECHANISM_EXTERNAL

static final String SASL_MECHANISM_EXTERNAL

EXTERNAL SASL mechanism (e.g. client certificate).

See Also:

• Constant Field Values

Method Details

uri

T uri(String uri)

The URI of a node to connect to.

URI must be of the form amqp://guest:guest@localhost:5672/%2f.

Parameters:

uri - node URI

Returns:

type-parameter object

See Also:

• RabbitMQ URI Specification

uris

T uris(String... uris)

A list of URIs of nodes of the same cluster to use to connect to.

URIs must be of the form amqp://guest:guest@localhost:5672/%2f.

Parameters:

uris - list of node URIs

Returns:

type-parameter object

See Also:

• RabbitMQ URI Specification

username

T username(String username)

The username to use.

Parameters:

username - username

Returns:

type-parameter object

password

T password(String password)

The password to use.

Parameters:

password - password

Returns:

type-parameter object

virtualHost

T virtualHost(String virtualHost)

The virtual host to connect to.

Parameters:

virtualHost -

Returns:

type-parameter object.

host

T host(String host)

The host to connect to.

Parameters:

host -

Returns:

port

T port(int port)

The port to use to connect.

Parameters:

port -

Returns:

type-parameter object

credentialsProvider

T credentialsProvider(CredentialsProvider credentialsProvider)

The CredentialsProvider to use.

Parameters:

credentialsProvider - credentials provider

Returns:

type-parameter object

idleTimeout

T idleTimeout(Duration idleTimeout)

Idle timeout (heartbeat) to use.

Default is 60 seconds.

Parameters:

idleTimeout -

Returns:

type-parameter object

addressSelector

T addressSelector(AddressSelector selector)

The AddressSelector to use.

Parameters:

selector - address selector

Returns:

type-parameter object

saslMechanism

T saslMechanism(String mechanism)

SASL mechanism to use.

Supported mechanisms are SASL_MECHANISM_ANONYMOUS, SASL_MECHANISM_PLAIN, and SASL_MECHANISM_EXTERNAL.

Parameters:

mechanism - SASL mechanism

Returns:

type-parameter object

See Also:

• RabbitMQ Authentication Mechanisms

tls

ConnectionSettings.TlsSettings<? extends T> tls()

TLS settings.

Returns:

TLS settings

affinity

ConnectionSettings.Affinity<? extends T> affinity()

Connection affinity settings.

This is an experimental API, subject to change.

Returns:

affinity settings

oauth2

OAuth2Settings<? extends T> oauth2()

OAuth 2 settings.

OAuth 2 requires RabbitMQ 4.1 or more.

Returns:

OAuth 2 settings

Since:

0.4.0

See Also:

• OAuth2Settings