io.atomix.cluster.discovery

Class BootstrapDiscoveryProvider

java.lang.Object

io.atomix.utils.event.AbstractListenerManager<NodeDiscoveryEvent,NodeDiscoveryEventListener>

io.atomix.cluster.discovery.BootstrapDiscoveryProvider

All Implemented Interfaces:

NodeDiscoveryProvider, io.atomix.utils.config.Configured<NodeDiscoveryConfig>, io.atomix.utils.event.ListenerService<NodeDiscoveryEvent,NodeDiscoveryEventListener>

public class BootstrapDiscoveryProvider
extends io.atomix.utils.event.AbstractListenerManager<NodeDiscoveryEvent,NodeDiscoveryEventListener>
implements NodeDiscoveryProvider

Cluster membership provider that bootstraps membership from a pre-defined set of peers.

The bootstrap member provider takes a set of peer addresses and uses them to join the cluster. Using the MessagingService, each node sends a heartbeat to its configured bootstrap peers. Peers respond to each heartbeat message with a list of all known peers, thus propagating membership information using a gossip style protocol.

A phi accrual failure detector is used to detect failures and remove peers from the configuration. In order to avoid flapping of membership following a ClusterMembershipEvent.Type#MEMBER_ADDED event, the implementation attempts to heartbeat all newly discovered peers before triggering a ClusterMembershipEvent.Type#MEMBER_REMOVED event.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BootstrapDiscoveryProvider.Type Bootstrap member location provider type.

Field Summary

Fields

Modifier and Type	Field and Description
static BootstrapDiscoveryProvider.Type	TYPE

Constructor Summary

Constructors

Constructor and Description
BootstrapDiscoveryProvider(Collection<Node> bootstrapNodes)
BootstrapDiscoveryProvider(Node... bootstrapNodes)

Method Summary

Modifier and Type	Method and Description
static BootstrapDiscoveryBuilder	builder() Creates a new bootstrap provider builder.
BootstrapDiscoveryConfig	config()
Set<Node>	getNodes() Returns the set of active nodes.
CompletableFuture<Void>	join(BootstrapService bootstrap, Node localNode) Joins the cluster.
CompletableFuture<Void>	leave(Node localNode) Leaves the cluster.

Methods inherited from class io.atomix.utils.event.AbstractListenerManager

addListener, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.atomix.utils.event.ListenerService

addListener, removeListener

Field Detail

TYPE

public static final BootstrapDiscoveryProvider.Type TYPE

Constructor Detail

BootstrapDiscoveryProvider

public BootstrapDiscoveryProvider(Node... bootstrapNodes)

BootstrapDiscoveryProvider

public BootstrapDiscoveryProvider(Collection<Node> bootstrapNodes)

Method Detail

builder

public static BootstrapDiscoveryBuilder builder()

Creates a new bootstrap provider builder.

Returns:

a new bootstrap provider builder

config

public BootstrapDiscoveryConfig config()

Specified by:

config in interface io.atomix.utils.config.Configured<NodeDiscoveryConfig>

getNodes

public Set<Node> getNodes()

Description copied from interface: NodeDiscoveryProvider

Returns the set of active nodes.

Specified by:

getNodes in interface NodeDiscoveryProvider

Returns:

the set of active nodes

join

public CompletableFuture<Void> join(BootstrapService bootstrap,
                                    Node localNode)

Description copied from interface: NodeDiscoveryProvider

Joins the cluster.

Specified by:

join in interface NodeDiscoveryProvider

Parameters:

bootstrap - the bootstrap service

localNode - the local node info

Returns:

a future to be completed once the join is complete

leave

public CompletableFuture<Void> leave(Node localNode)

Description copied from interface: NodeDiscoveryProvider

Leaves the cluster.

Specified by:

leave in interface NodeDiscoveryProvider

Parameters:

localNode - the local node info

Returns:

a future to be completed once the leave is complete