Module org.elasticsearch.server

Package org.elasticsearch.transport

Class RemoteConnectionManager

java.lang.Object

org.elasticsearch.transport.RemoteConnectionManager

All Implemented Interfaces:

Closeable, AutoCloseable, ConnectionManager

public class RemoteConnectionManager
extends Object
implements ConnectionManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RemoteConnectionManager.RemoteClusterAliasWithCredentials

Nested classes/interfaces inherited from interface org.elasticsearch.transport.ConnectionManager

ConnectionManager.ConnectionValidator, ConnectionManager.DelegatingNodeConnectionListener

Method Summary

Modifier and Type	Method	Description
void	addListener(TransportConnectionListener listener)
void	close()
void	closeNoBlock()
final void	connectToNode(DiscoveryNode node, ConnectionProfile connectionProfile, ConnectionManager.ConnectionValidator connectionValidator, ActionListener<Releasable> listener)	Remote cluster connections have a different lifecycle from intra-cluster connections.
void	connectToRemoteClusterNode(DiscoveryNode node, ConnectionManager.ConnectionValidator connectionValidator, ActionListener<Void> listener)
void	disconnectFromNode(DiscoveryNode node)
Set<DiscoveryNode>	getAllConnectedNodes()
Transport.Connection	getAnyRemoteConnection()
Transport.Connection	getConnection(DiscoveryNode node)
ConnectionProfile	getConnectionProfile()
RemoteClusterCredentialsManager	getCredentialsManager()
boolean	nodeConnected(DiscoveryNode node)
void	openConnection(DiscoveryNode node, ConnectionProfile profile, ActionListener<Transport.Connection> listener)
void	removeListener(TransportConnectionListener listener)
static Optional<String>	resolveRemoteClusterAlias(Transport.Connection connection)	This method returns a remote cluster alias for the given transport connection if it targets a node in the remote cluster.
static Optional<RemoteConnectionManager.RemoteClusterAliasWithCredentials>	resolveRemoteClusterAliasWithCredentials(Transport.Connection connection)	This method returns information (alias and credentials) for remote cluster for the given transport connection.
int	size()

Methods inherited from class java.lang.Object

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

Method Details

getCredentialsManager

public RemoteClusterCredentialsManager getCredentialsManager()

connectToNode

public final void connectToNode(DiscoveryNode node,
 ConnectionProfile connectionProfile,
 ConnectionManager.ConnectionValidator connectionValidator,
 ActionListener<Releasable> listener)
                         throws ConnectTransportException

Remote cluster connections have a different lifecycle from intra-cluster connections. Use connectToRemoteClusterNode(org.elasticsearch.cluster.node.DiscoveryNode, org.elasticsearch.transport.ConnectionManager.ConnectionValidator, org.elasticsearch.action.ActionListener<java.lang.Void>) instead of this method.

Specified by:

connectToNode in interface ConnectionManager

Throws:

ConnectTransportException

connectToRemoteClusterNode

public void connectToRemoteClusterNode(DiscoveryNode node,
 ConnectionManager.ConnectionValidator connectionValidator,
 ActionListener<Void> listener)
                                throws ConnectTransportException

Throws:

ConnectTransportException

addListener

public void addListener(TransportConnectionListener listener)

Specified by:

addListener in interface ConnectionManager

removeListener

public void removeListener(TransportConnectionListener listener)

Specified by:

removeListener in interface ConnectionManager

openConnection

public void openConnection(DiscoveryNode node,
 @Nullable
 ConnectionProfile profile,
 ActionListener<Transport.Connection> listener)

Specified by:

openConnection in interface ConnectionManager

getConnection

public Transport.Connection getConnection(DiscoveryNode node)

Specified by:

getConnection in interface ConnectionManager

nodeConnected

public boolean nodeConnected(DiscoveryNode node)

Specified by:

nodeConnected in interface ConnectionManager

disconnectFromNode

public void disconnectFromNode(DiscoveryNode node)

Specified by:

disconnectFromNode in interface ConnectionManager

getConnectionProfile

public ConnectionProfile getConnectionProfile()

Specified by:

getConnectionProfile in interface ConnectionManager

getAnyRemoteConnection

public Transport.Connection getAnyRemoteConnection()

getAllConnectedNodes

public Set<DiscoveryNode> getAllConnectedNodes()

Specified by:

getAllConnectedNodes in interface ConnectionManager

size

public int size()

Specified by:

size in interface ConnectionManager

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ConnectionManager

closeNoBlock

public void closeNoBlock()

Specified by:

closeNoBlock in interface ConnectionManager

resolveRemoteClusterAlias

public static Optional<String> resolveRemoteClusterAlias(Transport.Connection connection)

This method returns a remote cluster alias for the given transport connection if it targets a node in the remote cluster. This method will return an optional empty in case the connection targets the local node or the node in the local cluster.

Parameters:

connection - the transport connection for which to resolve a remote cluster alias

Returns:

a cluster alias if the connection target a node in the remote cluster, otherwise an empty result

resolveRemoteClusterAliasWithCredentials

public static Optional<RemoteConnectionManager.RemoteClusterAliasWithCredentials> resolveRemoteClusterAliasWithCredentials(Transport.Connection connection)

This method returns information (alias and credentials) for remote cluster for the given transport connection. Either or both of alias and credentials can be null depending on the connection.

Parameters:

connection - the transport connection for which to resolve a remote cluster alias