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

  • Field Details

    • REMOTE_CLUSTER_HANDSHAKE_ACTION_NAME

      public static final String REMOTE_CLUSTER_HANDSHAKE_ACTION_NAME
      See Also:

  • Method Details

    • isRemoteClusterServerEnabled

      public boolean isRemoteClusterServerEnabled()

    • 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)
      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)
      Description copied from interface: IndicesExpressionGrouper
      See groupIndices(java.util.Set<java.lang.String>, org.elasticsearch.action.support.IndicesOptions, java.lang.String[], boolean) for details
      Specified by:
      groupIndices in interface IndicesExpressionGrouper

    • 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 Optional<Boolean> isSkipUnavailable(String clusterAlias)
      Returns whether the cluster identified by the provided alias is configured to be skipped when unavailable.
      Parameters:
      clusterAlias - Name of the cluster
      Returns:
      A boolean optional that denotes if the cluster is configured to be skipped. In CPS-like environment, it returns an empty value where we default/fall back to true.

    • crossProjectEnabled

      public boolean crossProjectEnabled()

    • shouldSkipOnFailure

      public boolean shouldSkipOnFailure(String clusterAlias, Boolean allowPartialSearchResults)
      Signifies if an error can be skipped for the specified cluster based on skip_unavailable, or, allow_partial_search_results if in CPS-like environment.
      Parameters:
      clusterAlias - Name of the cluster
      allowPartialSearchResults - If partial results can be served for the search request.
      Returns:
      boolean

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

    • skipUnavailableChanged

      public void skipUnavailableChanged(ProjectId originProjectId, ProjectId linkedProjectId, String linkedProjectAlias, boolean skipUnavailable)
      Description copied from interface: LinkedProjectConfigService.LinkedProjectConfigListener
      Called when the boolean skip_unavailable setting has changed for a linked project configuration. Note that skip_unavailable may not be supported in all contexts where linked projects are used.
      Specified by:
      skipUnavailableChanged in interface LinkedProjectConfigService.LinkedProjectConfigListener
      Parameters:
      originProjectId - The ProjectId of the owning project that has the linked project configuration.
      linkedProjectId - The ProjectId of the linked project.
      linkedProjectAlias - The alias used for the linked project.
      skipUnavailable - The new value of the skip_unavailable setting.

    • updateRemoteClusterCredentials

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

    • updateLinkedProject

      public void updateLinkedProject(LinkedProjectConfig config)
      Description copied from interface: LinkedProjectConfigService.LinkedProjectConfigListener
      Called when a linked project configuration has been added or updated.
      Specified by:
      updateLinkedProject in interface LinkedProjectConfigService.LinkedProjectConfigListener
      Parameters:
      config - The updated LinkedProjectConfig.

    • 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

    • ensureClientIsEnabled

      public void ensureClientIsEnabled()
      Verifies this node is configured to support linked project client operations.
      Throws:
      IllegalArgumentException - If this node is not configured to support client operations.