Package org.opensearch.cluster.coordination

Class ElectionStrategy

java.lang.Object

org.opensearch.cluster.coordination.ElectionStrategy

public abstract class ElectionStrategy
extends java.lang.Object

Allows plugging in a custom election strategy, restricting the notion of an election quorum. Custom additional quorum restrictions can be defined by implementing the satisfiesAdditionalQuorumConstraints(org.opensearch.cluster.node.DiscoveryNode, long, long, long, org.opensearch.cluster.coordination.CoordinationMetadata.VotingConfiguration, org.opensearch.cluster.coordination.CoordinationMetadata.VotingConfiguration, org.opensearch.cluster.coordination.CoordinationState.VoteCollection) method.

Field Summary

Fields

Modifier and Type	Field	Description
static ElectionStrategy	DEFAULT_INSTANCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ElectionStrategy()

Method Summary

Modifier and Type	Method	Description
boolean	isElectionQuorum(DiscoveryNode localNode, long localCurrentTerm, long localAcceptedTerm, long localAcceptedVersion, CoordinationMetadata.VotingConfiguration lastCommittedConfiguration, CoordinationMetadata.VotingConfiguration lastAcceptedConfiguration, CoordinationState.VoteCollection joinVotes)	Whether there is an election quorum from the point of view of the given local node under the provided voting configurations
protected abstract boolean	satisfiesAdditionalQuorumConstraints(DiscoveryNode localNode, long localCurrentTerm, long localAcceptedTerm, long localAcceptedVersion, CoordinationMetadata.VotingConfiguration lastCommittedConfiguration, CoordinationMetadata.VotingConfiguration lastAcceptedConfiguration, CoordinationState.VoteCollection joinVotes)	The extension point to be overridden by plugins.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_INSTANCE

public static final ElectionStrategy DEFAULT_INSTANCE

Constructor Details

ElectionStrategy

protected ElectionStrategy()

Method Details

isElectionQuorum

public final boolean isElectionQuorum(DiscoveryNode localNode, long localCurrentTerm, long localAcceptedTerm, long localAcceptedVersion, CoordinationMetadata.VotingConfiguration lastCommittedConfiguration, CoordinationMetadata.VotingConfiguration lastAcceptedConfiguration, CoordinationState.VoteCollection joinVotes)

Whether there is an election quorum from the point of view of the given local node under the provided voting configurations

satisfiesAdditionalQuorumConstraints

protected abstract boolean satisfiesAdditionalQuorumConstraints(DiscoveryNode localNode, long localCurrentTerm, long localAcceptedTerm, long localAcceptedVersion, CoordinationMetadata.VotingConfiguration lastCommittedConfiguration, CoordinationMetadata.VotingConfiguration lastAcceptedConfiguration, CoordinationState.VoteCollection joinVotes)

The extension point to be overridden by plugins. Defines additional constraints on the election quorum.

Parameters:

localNode - the local node for the election quorum

localCurrentTerm - the current term of the local node

localAcceptedTerm - the last accepted term of the local node

localAcceptedVersion - the last accepted version of the local node

lastCommittedConfiguration - the last committed configuration for the election quorum

lastAcceptedConfiguration - the last accepted configuration for the election quorum

joinVotes - the votes that were provided so far

Returns:

true iff the additional quorum constraints are satisfied