org.onosproject.store.primitives.impl

Class PartitionedAsyncLeaderElector

java.lang.Object

org.onosproject.store.primitives.impl.PartitionedAsyncLeaderElector

All Implemented Interfaces:

AsyncLeaderElector, DistributedPrimitive

public class PartitionedAsyncLeaderElector
extends Object
implements AsyncLeaderElector

AsyncLeaderElector that has its topics partitioned horizontally across several leader electors.

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.store.service.DistributedPrimitive

DistributedPrimitive.Status, DistributedPrimitive.Type

Field Summary

Fields inherited from interface org.onosproject.store.service.DistributedPrimitive

DEFAULT_OPERTATION_TIMEOUT_MILLIS

Constructor Summary

Constructors

Constructor and Description
PartitionedAsyncLeaderElector(String name, Map<PartitionId,AsyncLeaderElector> partitions, Hasher<String> topicHasher)

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	addChangeListener(Consumer<Change<Leadership>> listener) Registers a listener to be notified of Leadership changes for all topics.
void	addStatusChangeListener(Consumer<DistributedPrimitive.Status> listener) Registers a listener to be called when the primitive's status changes.
CompletableFuture<Boolean>	anoint(String topic, NodeId nodeId) Attempts to promote a node to leadership displacing the current leader.
CompletableFuture<Void>	evict(NodeId nodeId) Attempts to evict a node from all leadership elections it is registered for.
CompletableFuture<Leadership>	getLeadership(String topic) Returns the Leadership for the specified topic.
CompletableFuture<Map<String,Leadership>>	getLeaderships() Returns the current Leaderships for all topics.
String	name() Returns the name of this primitive.
CompletableFuture<Boolean>	promote(String topic, NodeId nodeId) Attempts to promote a node to top of candidate list without displacing the current leader.
CompletableFuture<Void>	removeChangeListener(Consumer<Change<Leadership>> listener) Unregisters a previously registered change notification listener.
void	removeStatusChangeListener(Consumer<DistributedPrimitive.Status> listener) Unregisters a previously registered listener to be called when the primitive's status changes.
CompletableFuture<Leadership>	run(String topic, NodeId nodeId) Attempts to become leader for a topic.
Collection<Consumer<DistributedPrimitive.Status>>	statusChangeListeners() Returns the collection of status change listeners previously registered.
CompletableFuture<Void>	withdraw(String topic) Withdraws from leadership race for a topic.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.store.service.AsyncLeaderElector

asLeaderElector, asLeaderElector, primitiveType

Methods inherited from interface org.onosproject.store.service.DistributedPrimitive

applicationId, destroy

Constructor Detail

PartitionedAsyncLeaderElector

public PartitionedAsyncLeaderElector(String name,
                                     Map<PartitionId,AsyncLeaderElector> partitions,
                                     Hasher<String> topicHasher)

Method Detail

name

public String name()

Description copied from interface: DistributedPrimitive

Returns the name of this primitive.

Specified by:

name in interface DistributedPrimitive

Returns:

name

run

public CompletableFuture<Leadership> run(String topic,
                                         NodeId nodeId)

Description copied from interface: AsyncLeaderElector

Attempts to become leader for a topic.

Specified by:

run in interface AsyncLeaderElector

Parameters:

topic - leadership topic

nodeId - instance identifier of the node

Returns:

CompletableFuture that is completed with the current Leadership state of the topic

withdraw

public CompletableFuture<Void> withdraw(String topic)

Description copied from interface: AsyncLeaderElector

Withdraws from leadership race for a topic.

Specified by:

withdraw in interface AsyncLeaderElector

Parameters:

topic - leadership topic

Returns:

CompletableFuture that is completed when the withdraw is done

anoint

public CompletableFuture<Boolean> anoint(String topic,
                                         NodeId nodeId)

Description copied from interface: AsyncLeaderElector

Attempts to promote a node to leadership displacing the current leader.

Specified by:

anoint in interface AsyncLeaderElector

Parameters:

topic - leadership topic

nodeId - instance identifier of the new leader

Returns:

CompletableFuture that is completed with a boolean when the operation is done. Boolean is true if leadership transfer was successfully executed; false if it failed. This operation can fail (i.e. return false) if the node to be made new leader is not registering to run for election for the topic.

promote

public CompletableFuture<Boolean> promote(String topic,
                                          NodeId nodeId)

Description copied from interface: AsyncLeaderElector

Attempts to promote a node to top of candidate list without displacing the current leader.

Specified by:

promote in interface AsyncLeaderElector

Parameters:

topic - leadership topic

nodeId - instance identifier of the new top candidate

Returns:

CompletableFuture that is completed with a boolean when the operation is done. Boolean is true if node is now the top candidate. This operation can fail (i.e. return false) if the node is not registered to run for election for the topic.

evict

public CompletableFuture<Void> evict(NodeId nodeId)

Description copied from interface: AsyncLeaderElector

Attempts to evict a node from all leadership elections it is registered for.

If the node is the current leader for a topic, this call will promote the next top candidate (if one exists) to leadership.

Specified by:

evict in interface AsyncLeaderElector

Parameters:

nodeId - node instance identifier

Returns:

CompletableFuture that is completed when the operation is done.

getLeadership

public CompletableFuture<Leadership> getLeadership(String topic)

Description copied from interface: AsyncLeaderElector

Returns the Leadership for the specified topic.

Specified by:

getLeadership in interface AsyncLeaderElector

Parameters:

topic - leadership topic

Returns:

CompletableFuture that is completed with the current Leadership state of the topic

getLeaderships

public CompletableFuture<Map<String,Leadership>> getLeaderships()

Description copied from interface: AsyncLeaderElector

Returns the current Leaderships for all topics.

Specified by:

getLeaderships in interface AsyncLeaderElector

Returns:

CompletableFuture that is completed with the topic to Leadership mapping

addChangeListener

public CompletableFuture<Void> addChangeListener(Consumer<Change<Leadership>> listener)

Description copied from interface: AsyncLeaderElector

Registers a listener to be notified of Leadership changes for all topics.

Specified by:

addChangeListener in interface AsyncLeaderElector

Parameters:

listener - listener to notify

Returns:

CompletableFuture that is completed when the operation completes

removeChangeListener

public CompletableFuture<Void> removeChangeListener(Consumer<Change<Leadership>> listener)

Description copied from interface: AsyncLeaderElector

Unregisters a previously registered change notification listener.

If the specified listener was not previously registered, this operation will be a noop.

Specified by:

removeChangeListener in interface AsyncLeaderElector

Parameters:

listener - listener to remove

Returns:

CompletableFuture that is completed when the operation completes

addStatusChangeListener

public void addStatusChangeListener(Consumer<DistributedPrimitive.Status> listener)

Description copied from interface: DistributedPrimitive

Registers a listener to be called when the primitive's status changes.

Specified by:

addStatusChangeListener in interface DistributedPrimitive

Parameters:

listener - The listener to be called when the status changes.

removeStatusChangeListener

public void removeStatusChangeListener(Consumer<DistributedPrimitive.Status> listener)

Description copied from interface: DistributedPrimitive

Unregisters a previously registered listener to be called when the primitive's status changes.

Specified by:

removeStatusChangeListener in interface DistributedPrimitive

Parameters:

listener - The listener to unregister

statusChangeListeners

public Collection<Consumer<DistributedPrimitive.Status>> statusChangeListeners()

Description copied from interface: DistributedPrimitive

Returns the collection of status change listeners previously registered.

Specified by:

statusChangeListeners in interface DistributedPrimitive

Returns:

collection of status change listeners