org.elasticsearch.discovery.zen

Class NodeJoinController

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.discovery.zen.NodeJoinController

public class NodeJoinController
extends AbstractComponent

This class processes incoming join request (passed zia ZenDiscovery). Incoming nodes are directly added to the cluster state or are accumulated during master election.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NodeJoinController.ElectionCallback

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<DiscoveryNode,List<MembershipAction.JoinCallback>>	pendingJoinRequests

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
NodeJoinController(ClusterService clusterService, RoutingService routingService, DiscoverySettings discoverySettings, Settings settings)

Method Summary

Methods

Modifier and Type	Method and Description
void	handleJoinRequest(DiscoveryNode node, MembershipAction.JoinCallback callback) processes or queues an incoming join request.
void	startAccumulatingJoins() Accumulates any future incoming join request.
void	stopAccumulatingJoins(String reason) Stopped accumulating joins.
void	waitToBeElectedAsMaster(int requiredMasterJoins, TimeValue timeValue, NodeJoinController.ElectionCallback callback) waits for enough incoming joins from master eligible nodes to complete the master election

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

pendingJoinRequests

protected final Map<DiscoveryNode,List<MembershipAction.JoinCallback>> pendingJoinRequests

Constructor Detail

NodeJoinController

public NodeJoinController(ClusterService clusterService,
                  RoutingService routingService,
                  DiscoverySettings discoverySettings,
                  Settings settings)

Method Detail

waitToBeElectedAsMaster

public void waitToBeElectedAsMaster(int requiredMasterJoins,
                           TimeValue timeValue,
                           NodeJoinController.ElectionCallback callback)

waits for enough incoming joins from master eligible nodes to complete the master election

You must start accumulating joins before calling this method. See startAccumulatingJoins()

The method will return once the local node has been elected as master or some failure/timeout has happened. The exact outcome is communicated via the callback parameter, which is guaranteed to be called.

Parameters:

requiredMasterJoins - the number of joins from master eligible needed to complete the election

timeValue - how long to wait before failing. a timeout is communicated via the callback's onFailure method.

callback - the result of the election (success or failure) will be communicated by calling methods on this object

startAccumulatingJoins

public void startAccumulatingJoins()

Accumulates any future incoming join request. Pending join requests will be processed in the final steps of becoming a master or when stopAccumulatingJoins(String) is called.

stopAccumulatingJoins

public void stopAccumulatingJoins(String reason)

Stopped accumulating joins. All pending joins will be processed. Future joins will be processed immediately

handleJoinRequest

public void handleJoinRequest(DiscoveryNode node,
                     MembershipAction.JoinCallback callback)

processes or queues an incoming join request.

Note: doesn't do any validation. This should have been done before.