Module org.elasticsearch.server

Package org.elasticsearch.transport

Class RemoteClusterService

java.lang.Object

org.elasticsearch.transport.RemoteClusterAware

org.elasticsearch.transport.RemoteClusterService

All Implemented Interfaces:

Closeable, AutoCloseable, ReportingService<RemoteClusterServerInfo>

public final class RemoteClusterService
extends RemoteClusterAware
implements Closeable, ReportingService<RemoteClusterServerInfo>

Basic service for accessing remote clusters via gateway nodes

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.node.ReportingService

ReportingService.Info

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting.AffixSetting<Compression.Enabled>	REMOTE_CLUSTER_COMPRESS
static final Setting.AffixSetting<Compression.Scheme>	REMOTE_CLUSTER_COMPRESSION_SCHEME
static final Setting.AffixSetting<SecureString>	REMOTE_CLUSTER_CREDENTIALS
static final String	REMOTE_CLUSTER_HANDSHAKE_ACTION_NAME
static final Setting.AffixSetting<TimeValue>	REMOTE_CLUSTER_PING_SCHEDULE
static final Setting.AffixSetting<Boolean>	REMOTE_CLUSTER_SKIP_UNAVAILABLE
static final Setting<TimeValue>	REMOTE_INITIAL_CONNECTION_TIMEOUT_SETTING	The initial connect timeout for remote cluster connections
static final Setting<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

LOCAL_CLUSTER_GROUP_KEY, REMOTE_CLUSTER_INDEX_SEPARATOR, settings

Method Summary

Modifier and Type	Method	Description
void	close()
void	collectNodes(Set<String> clusters, ActionListener<BiFunction<String,String,DiscoveryNode>> listener)	Collects all nodes of the given clusters and returns / passes a (clusterAlias, nodeId) to DiscoveryNode function on success.
Transport.Connection	getConnection(String cluster)
Transport.Connection	getConnection(DiscoveryNode node, String cluster)	Returns a connection to the given node on the given remote cluster
DiscoveryNode	getLocalNode()
Set<String>	getRegisteredRemoteClusterNames()	Returns the registered remote cluster names.
Client	getRemoteClusterClient(ThreadPool threadPool, String clusterAlias)	Returns a client to the remote cluster if the given cluster alias exists.
Client	getRemoteClusterClient(ThreadPool threadPool, String clusterAlias, boolean ensureConnected)	Returns a client to the remote cluster if the given cluster alias exists.
Stream<RemoteConnectionInfo>	getRemoteConnectionInfos()
Map<String,OriginalIndices>	groupIndices(IndicesOptions indicesOptions, String[] indices)
RemoteClusterServerInfo	info()
boolean	isCrossClusterSearchEnabled()	Returns true if at least one remote cluster is configured
boolean	isEnabled()
boolean	isRemoteClusterServerEnabled()
boolean	isSkipUnavailable(String clusterAlias)	Returns whether the cluster identified by the provided alias is configured to be skipped when unavailable
void	listenForUpdates(ClusterSettings clusterSettings)	Registers this instance to listen to updates on the cluster settings.
protected void	updateRemoteCluster(String clusterAlias, Settings settings)	Subclasses must implement this to receive information about updated cluster aliases.

Methods inherited from class org.elasticsearch.transport.RemoteClusterAware

buildRemoteIndexName, getEnabledRemoteClusters, groupClusterIndices

Methods inherited from class java.lang.Object

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

Field Details

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<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 cluster.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.

REMOTE_CLUSTER_SKIP_UNAVAILABLE

public static final Setting.AffixSetting<Boolean> REMOTE_CLUSTER_SKIP_UNAVAILABLE

REMOTE_CLUSTER_PING_SCHEDULE

public static final Setting.AffixSetting<TimeValue> REMOTE_CLUSTER_PING_SCHEDULE

REMOTE_CLUSTER_COMPRESS

public static final Setting.AffixSetting<Compression.Enabled> REMOTE_CLUSTER_COMPRESS

REMOTE_CLUSTER_COMPRESSION_SCHEME

public static final Setting.AffixSetting<Compression.Scheme> REMOTE_CLUSTER_COMPRESSION_SCHEME

REMOTE_CLUSTER_CREDENTIALS

public static final Setting.AffixSetting<SecureString> REMOTE_CLUSTER_CREDENTIALS

REMOTE_CLUSTER_HANDSHAKE_ACTION_NAME

public static final String REMOTE_CLUSTER_HANDSHAKE_ACTION_NAME

See Also:

• Constant Field Values

Method Details

isEnabled

public boolean isEnabled()

isRemoteClusterServerEnabled

public boolean isRemoteClusterServerEnabled()

getLocalNode

public DiscoveryNode getLocalNode()

isCrossClusterSearchEnabled

public boolean isCrossClusterSearchEnabled()

Returns true if at least one remote cluster is configured

groupIndices

public Map<String,OriginalIndices> groupIndices(IndicesOptions indicesOptions,
 String[] indices)

getRegisteredRemoteClusterNames

public Set<String> getRegisteredRemoteClusterNames()

Returns the registered remote cluster names.

getConnection

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

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

Throws:

IllegalArgumentException - if the remote cluster is unknown

isSkipUnavailable

public boolean isSkipUnavailable(String clusterAlias)

Returns whether the cluster identified by the provided alias is configured to be skipped when unavailable

getConnection

public Transport.Connection getConnection(String cluster)

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(String clusterAlias,
 Settings settings)

Description copied from class: RemoteClusterAware

Subclasses must implement this to receive information about updated cluster aliases.

Specified by:

updateRemoteCluster in class RemoteClusterAware

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getRemoteConnectionInfos

public Stream<RemoteConnectionInfo> getRemoteConnectionInfos()

info

public RemoteClusterServerInfo info()

Specified by:

info in interface ReportingService<RemoteClusterServerInfo>

collectNodes

public void collectNodes(Set<String> clusters,
 ActionListener<BiFunction<String,String,DiscoveryNode>> listener)

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

getRemoteClusterClient

public Client getRemoteClusterClient(ThreadPool threadPool,
 String clusterAlias,
 boolean ensureConnected)

Returns a client to the remote cluster if the given cluster alias exists.

Parameters:

threadPool - the ThreadPool for the client

clusterAlias - the cluster alias the remote cluster is registered under

ensureConnected - whether requests should wait for a connection attempt when there isn't a connection available

Throws:

IllegalArgumentException - if the given clusterAlias doesn't exist

getRemoteClusterClient

public Client getRemoteClusterClient(ThreadPool threadPool,
 String clusterAlias)

Returns a client to the remote cluster if the given cluster alias exists.

Parameters:

threadPool - the ThreadPool for the client

clusterAlias - the cluster alias the remote cluster is registered under

Throws:

IllegalArgumentException - if the given clusterAlias doesn't exist