Class RemoteClusterService

  • All Implemented Interfaces:, java.lang.AutoCloseable

    public final class RemoteClusterService
    extends RemoteClusterAware
    Basic service for accessing remote clusters via gateway nodes
    • Field Detail


        public static final Setting<java.lang.Integer> SEARCH_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.

        public static final Setting<TimeValue> SEARCH_REMOTE_INITIAL_CONNECTION_TIMEOUT_SETTING

        public static final Setting<TimeValue> REMOTE_INITIAL_CONNECTION_TIMEOUT_SETTING
        The initial connect timeout for remote cluster connections

        public static final Setting<java.lang.String> SEARCH_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.

        public static final Setting<java.lang.Boolean> SEARCH_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

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

        public static final SettingUpgrader<java.lang.Boolean> SEARCH_REMOTE_CLUSTER_SKIP_UNAVAILABLE_UPGRADER

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

        public static final Setting.AffixSetting<java.lang.Boolean> REMOTE_CLUSTER_COMPRESS
    • 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)
      • getRegisteredRemoteClusterNames

        public java.util.Set<java.lang.String> getRegisteredRemoteClusterNames()
        Returns the registered remote cluster names.
      • getConnection

        public Transport.Connection getConnection​(DiscoveryNode node,
                                                  java.lang.String cluster)
        Returns a connection to the given node on the given remote cluster
        java.lang.IllegalArgumentException - if the remote cluster is unknown
      • updateRemoteCluster

        protected void updateRemoteCluster​(java.lang.String clusterAlias,
                                           java.util.List<java.lang.String> addresses,
                                           java.lang.String proxyAddress,
                                           boolean compressionEnabled,
                                           TimeValue pingSchedule)
        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()
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface
      • 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.
      • getRemoteClusterClient

        public Client getRemoteClusterClient​(ThreadPool threadPool,
                                             java.lang.String clusterAlias)
        Returns a client to the remote cluster if the given cluster alias exists.
        threadPool - the ThreadPool for the client
        clusterAlias - the cluster alias the remote cluster is registered under
        java.lang.IllegalArgumentException - if the given clusterAlias doesn't exist