com.rabbitmq.client.amqp.ConnectionSettings Maven / Gradle / Ivy
Show all versions of amqp-client Show documentation
// Copyright (c) 2024 Broadcom. All Rights Reserved.
// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// If you have any questions regarding licensing, please contact us at
// [email protected].
package com.rabbitmq.client.amqp;
import java.time.Duration;
import java.util.List;
import javax.net.ssl.SSLContext;
/**
* Settings for a connection.
*
* @param the type of object returned by methods, usually the object itself
*/
public interface ConnectionSettings {
/** ANONYMOUS SASL mechanism (the default). */
String SASL_MECHANISM_ANONYMOUS = "ANONYMOUS";
/** PLAIN SASL mechanism (username and password). */
String SASL_MECHANISM_PLAIN = "PLAIN";
/** EXTERNAL SASL mechanism (e.g. client certificate). */
String SASL_MECHANISM_EXTERNAL = "EXTERNAL";
/**
* The URI of a node to connect to.
*
* URI must be of the form amqp://guest:guest@localhost:5672/%2f.
*
* @param uri node URI
* @return type-parameter object
* @see RabbitMQ URI Specification
*/
T uri(String uri);
/**
* 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.
*
* @param uris list of node URIs
* @return type-parameter object
* @see RabbitMQ URI Specification
*/
T uris(String... uris);
/**
* The username to use.
*
* @param username username
* @return type-parameter object
*/
T username(String username);
/**
* The password to use.
*
* @param password password
* @return type-parameter object
*/
T password(String password);
/**
* The virtual host to connect to.
*
* @param virtualHost
* @return type-parameter object.
*/
T virtualHost(String virtualHost);
/**
* The host to connect to.
*
* @param host
* @return
*/
T host(String host);
/**
* The port to use to connect.
*
* @param port
* @return type-parameter object
*/
T port(int port);
/**
* The {@link CredentialsProvider} to use.
*
* @param credentialsProvider credentials provider
* @return type-parameter object
*/
T credentialsProvider(CredentialsProvider credentialsProvider);
/**
* Idle timeout (heartbeat) to use.
*
*
Default is 60 seconds.
*
* @param idleTimeout
* @return type-parameter object
*/
T idleTimeout(Duration idleTimeout);
/**
* The {@link AddressSelector} to use.
*
* @param selector address selector
* @return type-parameter object
*/
T addressSelector(AddressSelector selector);
/**
* SASL mechanism to use.
*
*
Supported mechanisms are {@link #SASL_MECHANISM_ANONYMOUS}, {@link #SASL_MECHANISM_PLAIN},
* and {@link #SASL_MECHANISM_EXTERNAL}.
*
* @param mechanism SASL mechanism
* @return type-parameter object
* @see RabbitMQ Authentication
* Mechanisms
*/
T saslMechanism(String mechanism);
/**
* TLS settings.
*
* @return TLS settings
*/
TlsSettings tls();
/**
* Connection affinity settings.
*
*
This is an experimental API, subject to change.
*
* @return affinity settings
*/
Affinity affinity();
/**
* TLS settings.
*
* @param
*/
interface TlsSettings {
/**
* Activate hostname verification.
*
* Activated by default.
*
* @return TLS settings
*/
TlsSettings hostnameVerification();
/**
* Whether to activate hostname verification or not.
*
* Activated by default.
*
* @param hostnameVerification activation flag
* @return TLS settings
*/
TlsSettings hostnameVerification(boolean hostnameVerification);
/**
* {@link SSLContext} to use.
*
* @param sslContext the SSL context to use
* @return TLS settings
*/
TlsSettings sslContext(SSLContext sslContext);
/**
* Convenience method to set a {@link SSLContext} that trusts all servers.
*
* When this feature is enabled, no peer verification is performed, which provides no
* protection against Man-in-the-Middle (MITM) attacks.
*
*
Use this only in development and QA environments.
*
* @return TLS settings
*/
TlsSettings trustEverything();
/**
* The connection builder.
*
* @return connection builder
*/
T connection();
}
/**
* Connection affinity settings.
*
* This is an experimental API, subject to change.
*
* @param type of the owning object
*/
interface Affinity {
/**
* The queue to have affinity with.
*
* @param queue queue
* @return affinity settings
*/
Affinity queue(String queue);
/**
* The type of operation to look affinity with.
*
* {@link Operation#PUBLISH} will favor the node with the queue leader on it.
*
*
{@link Operation#CONSUME} will favor a node with a queue member (replica) on it.
*
* @param operation type of operation
* @return affinity settings
*/
Affinity operation(Operation operation);
/**
* Whether an open connection with the same affinity should reused.
*
* Default is false (open a new connection, do not reuse).
*
* @param reuse true to reuse, false to open a new connection
* @return affinity settings
*/
Affinity reuse(boolean reuse);
/**
* Set the {@link AffinityStrategy}.
*
* @param strategy affinity strategy
* @return affinity settings
*/
Affinity strategy(AffinityStrategy strategy);
/**
* Return the connection builder.
*
* @return connection builder
*/
T connection();
/** Affinity operation. */
enum Operation {
PUBLISH,
CONSUME
}
}
/** Context for the {@link AffinityStrategy}. */
interface AffinityContext {
/**
* Queue to have affinity with.
*
* @return the queue
*/
String queue();
/**
* Operation for affinity.
*
* @return operation
*/
Affinity.Operation operation();
}
/** Strategy to pick candidate nodes with an affinity with a queue. */
@FunctionalInterface
interface AffinityStrategy {
/**
* Pick affinity.
*
* @param context the affinity requirements
* @param info information about the target queue
* @return the candidate nodes
*/
List nodesWithAffinity(AffinityContext context, Management.QueueInfo info);
}
}