Module org.elasticsearch.server
Package org.elasticsearch.cluster.coordination

Class NodeJoinExecutor

java.lang.Object
org.elasticsearch.cluster.coordination.NodeJoinExecutor
All Implemented Interfaces:
ClusterStateTaskExecutor<JoinTask>
public class NodeJoinExecutor extends Object implements ClusterStateTaskExecutor<JoinTask>

  • Constructor Details

  • Method Details

    • execute

      public ClusterState execute(ClusterStateTaskExecutor.BatchExecutionContext<JoinTask> batchExecutionContext) throws Exception
      Description copied from interface: ClusterStateTaskExecutor
      Update the cluster state based on the current state and the given tasks. Return batchExecutionContext.initialState() to avoid publishing any update.

      If this method throws an exception then the cluster state is unchanged and every task's ClusterStateTaskListener.onFailure(java.lang.Exception) method is called.

      A common implementation pattern is to iterate through the tasks, constructing a new and updated ClusterState for each one. This works ok but beware that constructing a whole new ClusterState can be somewhat expensive, and there may sometimes be surprisingly many tasks to process in the batch. If it's possible to accumulate the effects of the tasks at a lower level then you should do that instead.

      Returning batchExecutionContext.initialState() is an important and useful optimisation in most cases, but note that this fast-path exposes APIs to the risk of stale reads in the vicinity of a master failover: a node N that handles such a no-op task batch does not verify with its peers that it's still the master, and if it's not the master then another node M may already have become master and updated the state in a way that would be inconsistent with the response that N sends back to clients.

      Specified by:
      execute in interface ClusterStateTaskExecutor<JoinTask>
      Returns:
      The resulting cluster state after executing all the tasks. If batchExecutionContext.initialState() is returned then no update is published.
      Throws:
      Exception

    • becomeMasterAndTrimConflictingNodes

      protected ClusterState.Builder becomeMasterAndTrimConflictingNodes(ClusterState currentState, List<? extends ClusterStateTaskExecutor.TaskContext<JoinTask>> taskContexts, long term)

    • runOnlyOnMaster

      public boolean runOnlyOnMaster()
      Specified by:
      runOnlyOnMaster in interface ClusterStateTaskExecutor<JoinTask>
      Returns:
      true iff this executor should only run on the elected master.

    • ensureIndexCompatibility

      public static void ensureIndexCompatibility(IndexVersion minSupportedVersion, IndexVersion maxSupportedVersion, Metadata metadata)
      Ensures that all indices are compatible with the given index version. This will ensure that all indices in the given metadata will not be created with a newer version of elasticsearch as well as that all indices are newer or equal to the minimum index compatibility version.
      Throws:
      IllegalStateException - if any index is incompatible with the given version
      See Also:

    • ensureNodesCompatibility

      public static void ensureNodesCompatibility(Version joiningNodeVersion, DiscoveryNodes currentNodes)
      ensures that the joining node has a version that's compatible with all current nodes

    • ensureNodesCompatibility

      public static void ensureNodesCompatibility(Version joiningNodeVersion, Version minClusterNodeVersion, Version maxClusterNodeVersion)
      ensures that the joining node has a version that's compatible with a given version range

    • ensureVersionBarrier

      public static void ensureVersionBarrier(Version joiningNodeVersion, Version minClusterNodeVersion)
      ensures that the joining node's version is equal or higher to the minClusterNodeVersion. This is needed to ensure that if the master is already fully operating under the new version, it doesn't go back to mixed version mode

    • addBuiltInJoinValidators

      public static Collection<BiConsumer<DiscoveryNode,ClusterState>> addBuiltInJoinValidators(Collection<BiConsumer<DiscoveryNode,ClusterState>> onJoinValidators)