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, IndicesExpressionGrouper, ReportingService<RemoteClusterServerInfo>
public final class RemoteClusterService extends RemoteClusterAware implements Closeable, ReportingService<RemoteClusterServerInfo>, IndicesExpressionGrouper
Basic service for accessing remote clusters via gateway nodes

  • 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:

  • 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(Set<String> remoteClusterNames, IndicesOptions indicesOptions, String[] indices, boolean returnLocalAll)
      Group indices by cluster alias mapped to OriginalIndices for that cluster.
      Parameters:
      remoteClusterNames - Set of configured remote cluster names.
      indicesOptions - IndicesOptions to clarify how the index expressions should be parsed/applied
      indices - Multiple index expressions as string[].
      returnLocalAll - whether to support the _all functionality needed by _search (See https://github.com/elastic/elasticsearch/pull/33899). If true, and no indices are specified, then a Map with one entry for the local cluster with an empty index array is returned. If false, an empty map is returned when no indices are specified.
      Returns:
      Map keyed by cluster alias having OriginalIndices as the map value parsed from the String[] indices argument

    • groupIndices

      public Map<String,OriginalIndices> groupIndices(Set<String> remoteClusterNames, IndicesOptions indicesOptions, String[] indices)
      If no indices are specified, then a Map with one entry for the local cluster with an empty index array is returned. For details see groupIndices(IndicesOptions indicesOptions, String[] indices, boolean returnLocalAll)
      Specified by:
      groupIndices in interface IndicesExpressionGrouper
      Parameters:
      remoteClusterNames - Set of configured remote cluster names.
      indicesOptions - IndicesOptions to clarify how the index expressions should be parsed/applied
      indices - Multiple index expressions as string[].
      Returns:
      Map keyed by cluster alias having OriginalIndices as the map value parsed from the String[] indices argument

    • groupIndices

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

    • groupIndices

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

    • getConfiguredClusters

      public Set<String> getConfiguredClusters()
      Description copied from interface: IndicesExpressionGrouper
      Returns a set of currently configured remote clusters.
      Specified by:
      getConfiguredClusters in interface IndicesExpressionGrouper

    • 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)

    • maybeEnsureConnectedAndGetConnection

      public void maybeEnsureConnectedAndGetConnection(String clusterAlias, boolean ensureConnected, ActionListener<Transport.Connection> listener)
      Unlike getConnection(String) this method might attempt to re-establish a remote connection if there is no connection available before returning a connection to the remote cluster.
      Parameters:
      clusterAlias - the remote cluster
      ensureConnected - whether requests should wait for a connection attempt when there isn't available connection
      listener - a listener that will be notified the connection or failure

    • getRemoteClusterConnection

      public RemoteClusterConnection getRemoteClusterConnection(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

    • updateRemoteClusterCredentials

      public void updateRemoteClusterCredentials(Supplier<Settings> settingsSupplier, ActionListener<Void> listener)

    • 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 RemoteClusterClient getRemoteClusterClient(String clusterAlias, Executor responseExecutor, RemoteClusterService.DisconnectedStrategy disconnectedStrategy)
      Returns a client to the remote cluster if the given cluster alias exists.
      Parameters:
      clusterAlias - the cluster alias the remote cluster is registered under
      responseExecutor - the executor to use to process the response
      disconnectedStrategy - how to handle the situation where the remote cluster is disconnected when executing a request
      Throws:
      IllegalArgumentException - if the given clusterAlias doesn't exist