org.elasticsearch.transport

Class RemoteClusterService

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.transport.RemoteClusterAware

org.elasticsearch.transport.RemoteClusterService

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class RemoteClusterService
extends RemoteClusterAware
implements java.io.Closeable

Basic service for accessing remote clusters via gateway nodes

Field Summary

Fields

Modifier and Type	Field and Description
static Setting<java.lang.Boolean>	ENABLE_REMOTE_CLUSTERS If true connecting to remote clusters is supported on this node.
static Setting.AffixSetting<java.lang.Boolean>	REMOTE_CLUSTER_SKIP_UNAVAILABLE
static Setting<java.lang.Integer>	REMOTE_CONNECTIONS_PER_CLUSTER The maximum number of connections that will be established to a remote cluster.
static Setting<TimeValue>	REMOTE_INITIAL_CONNECTION_TIMEOUT_SETTING The initial connect timeout for remote cluster connections
static Setting<java.lang.String>	REMOTE_NODE_ATTRIBUTE The name of a node attribute to select nodes that should be connected to in the remote cluster.

Fields inherited from class org.elasticsearch.transport.RemoteClusterAware

clusterNameResolver, LOCAL_CLUSTER_GROUP_KEY, REMOTE_CLUSTER_INDEX_SEPARATOR, REMOTE_CLUSTERS_SEEDS

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Method Summary

Modifier and Type	Method and Description
void	close()
void	collectNodes(java.util.Set<java.lang.String> clusters, ActionListener<java.util.function.BiFunction<java.lang.String,java.lang.String,DiscoveryNode>> listener) Collects all nodes of the given clusters and returns / passes a (clusterAlias, nodeId) to DiscoveryNode function on success.
void	collectSearchShards(IndicesOptions indicesOptions, java.lang.String preference, java.lang.String routing, java.util.Map<java.lang.String,OriginalIndices> remoteIndicesByCluster, ActionListener<java.util.Map<java.lang.String,ClusterSearchShardsResponse>> listener)
void	ensureConnected(java.lang.String clusterAlias, ActionListener<java.lang.Void> listener) Ensures that the given cluster alias is connected.
Transport.Connection	getConnection(DiscoveryNode node, java.lang.String cluster) Returns a connection to the given node on the given remote cluster
Transport.Connection	getConnection(java.lang.String cluster)
protected java.util.Set<java.lang.String>	getRemoteClusterNames()
void	getRemoteConnectionInfos(ActionListener<java.util.Collection<RemoteConnectionInfo>> listener)
java.util.Map<java.lang.String,OriginalIndices>	groupIndices(IndicesOptions indicesOptions, java.lang.String[] indices, java.util.function.Predicate<java.lang.String> indexExists)
boolean	isCrossClusterSearchEnabled() Returns true if at least one remote cluster is configured
void	listenForUpdates(ClusterSettings clusterSettings) Registers this instance to listen to updates on the cluster settings.
protected void	updateRemoteCluster(java.lang.String clusterAlias, java.util.List<java.net.InetSocketAddress> addresses) Subclasses must implement this to receive information about updated cluster aliases.

Methods inherited from class org.elasticsearch.transport.RemoteClusterAware

buildRemoteClustersSeeds, buildRemoteIndexName, groupClusterIndices

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

REMOTE_CONNECTIONS_PER_CLUSTER

public static final Setting<java.lang.Integer> REMOTE_CONNECTIONS_PER_CLUSTER

The maximum number of connections that will be established to a remote cluster. For instance if there is only a single seed node, other nodes will be discovered up to the given number of nodes in this setting. The default is 3.

REMOTE_INITIAL_CONNECTION_TIMEOUT_SETTING

public static final Setting<TimeValue> REMOTE_INITIAL_CONNECTION_TIMEOUT_SETTING

The initial connect timeout for remote cluster connections

REMOTE_NODE_ATTRIBUTE

public static final Setting<java.lang.String> REMOTE_NODE_ATTRIBUTE

The name of a node attribute to select nodes that should be connected to in the remote cluster. For instance a node can be configured with node.attr.gateway: true in order to be eligible as a gateway node between clusters. In that case search.remote.node.attr: gateway can be used to filter out other nodes in the remote cluster. The value of the setting is expected to be a boolean, true for nodes that can become gateways, false otherwise.

ENABLE_REMOTE_CLUSTERS

public static final Setting<java.lang.Boolean> ENABLE_REMOTE_CLUSTERS

If true connecting to remote clusters is supported on this node. If false this node will not establish connections to any remote clusters configured. Search requests executed against this node (where this node is the coordinating node) will fail if remote cluster syntax is used as an index pattern. The default is true

REMOTE_CLUSTER_SKIP_UNAVAILABLE

public static final Setting.AffixSetting<java.lang.Boolean> REMOTE_CLUSTER_SKIP_UNAVAILABLE

Method Detail

isCrossClusterSearchEnabled

public boolean isCrossClusterSearchEnabled()

Returns true if at least one remote cluster is configured

groupIndices

public java.util.Map<java.lang.String,OriginalIndices> groupIndices(IndicesOptions indicesOptions,
                                                                    java.lang.String[] indices,
                                                                    java.util.function.Predicate<java.lang.String> indexExists)

collectSearchShards

public void collectSearchShards(IndicesOptions indicesOptions,
                                java.lang.String preference,
                                java.lang.String routing,
                                java.util.Map<java.lang.String,OriginalIndices> remoteIndicesByCluster,
                                ActionListener<java.util.Map<java.lang.String,ClusterSearchShardsResponse>> listener)

getConnection

public Transport.Connection getConnection(DiscoveryNode node,
                                          java.lang.String cluster)

Returns a connection to the given node on the given remote cluster

Throws:

java.lang.IllegalArgumentException - if the remote cluster is unknown

ensureConnected

public void ensureConnected(java.lang.String clusterAlias,
                            ActionListener<java.lang.Void> listener)

Ensures that the given cluster alias is connected. If the cluster is connected this operation will invoke the listener immediately.

getConnection

public Transport.Connection getConnection(java.lang.String cluster)

getRemoteClusterNames

protected java.util.Set<java.lang.String> getRemoteClusterNames()

Specified by:

getRemoteClusterNames in class RemoteClusterAware

listenForUpdates

public void listenForUpdates(ClusterSettings clusterSettings)

Description copied from class: RemoteClusterAware

Registers this instance to listen to updates on the cluster settings.

Overrides:

listenForUpdates in class RemoteClusterAware

updateRemoteCluster

protected void updateRemoteCluster(java.lang.String clusterAlias,
                                   java.util.List<java.net.InetSocketAddress> addresses)

Description copied from class: RemoteClusterAware

Subclasses must implement this to receive information about updated cluster aliases. If the given address list is empty the cluster alias is unregistered and should be removed.

Specified by:

updateRemoteCluster in class RemoteClusterAware

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getRemoteConnectionInfos

public void getRemoteConnectionInfos(ActionListener<java.util.Collection<RemoteConnectionInfo>> listener)

collectNodes

public void collectNodes(java.util.Set<java.lang.String> clusters,
                         ActionListener<java.util.function.BiFunction<java.lang.String,java.lang.String,DiscoveryNode>> listener)

Collects all nodes of the given clusters and returns / passes a (clusterAlias, nodeId) to DiscoveryNode function on success.