org.onosproject.store.consistent.impl

Class DistributedLeadershipManager

java.lang.Object

org.onosproject.store.consistent.impl.DistributedLeadershipManager

All Implemented Interfaces:

org.onosproject.cluster.LeadershipService

@Service
public class DistributedLeadershipManager
extends Object
implements org.onosproject.cluster.LeadershipService

Distributed Lock Manager implemented on top of ConsistentMap.

This implementation makes use of ClusterService's failure detection capabilities to detect and purge stale locks. TODO: Ensure lock safety and liveness.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.store.cluster.messaging.ClusterCommunicationService	clusterCommunicator
protected org.onosproject.cluster.ClusterService	clusterService
protected org.onosproject.event.EventDeliveryService	eventDispatcher
protected org.onosproject.store.service.StorageService	storageService

Constructor Summary

Constructors

Constructor and Description
DistributedLeadershipManager()

Method Summary

Modifier and Type	Method and Description
void	activate()
void	addListener(org.onosproject.cluster.LeadershipEventListener listener)
void	deactivate()
Map<String,List<org.onosproject.cluster.NodeId>>	getCandidates()
List<org.onosproject.cluster.NodeId>	getCandidates(String path)
org.onosproject.cluster.NodeId	getLeader(String path)
Map<String,org.onosproject.cluster.Leadership>	getLeaderBoard()
org.onosproject.cluster.Leadership	getLeadership(String path)
boolean	makeTopCandidate(String path, org.onosproject.cluster.NodeId nodeId)
Set<String>	ownedTopics(org.onosproject.cluster.NodeId nodeId)
void	removeListener(org.onosproject.cluster.LeadershipEventListener listener)
CompletableFuture<org.onosproject.cluster.Leadership>	runForLeadership(String path)
boolean	stepdown(String path)
CompletableFuture<Void>	withdraw(String path)

Methods inherited from class java.lang.Object

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

Field Detail

storageService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.store.service.StorageService storageService

clusterService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.cluster.ClusterService clusterService

clusterCommunicator

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.store.cluster.messaging.ClusterCommunicationService clusterCommunicator

eventDispatcher

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.event.EventDeliveryService eventDispatcher

Constructor Detail

DistributedLeadershipManager

public DistributedLeadershipManager()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

getLeaderBoard

public Map<String,org.onosproject.cluster.Leadership> getLeaderBoard()

Specified by:

getLeaderBoard in interface org.onosproject.cluster.LeadershipService

getCandidates

public Map<String,List<org.onosproject.cluster.NodeId>> getCandidates()

Specified by:

getCandidates in interface org.onosproject.cluster.LeadershipService

getCandidates

public List<org.onosproject.cluster.NodeId> getCandidates(String path)

Specified by:

getCandidates in interface org.onosproject.cluster.LeadershipService

getLeader

public org.onosproject.cluster.NodeId getLeader(String path)

Specified by:

getLeader in interface org.onosproject.cluster.LeadershipService

getLeadership

public org.onosproject.cluster.Leadership getLeadership(String path)

Specified by:

getLeadership in interface org.onosproject.cluster.LeadershipService

ownedTopics

public Set<String> ownedTopics(org.onosproject.cluster.NodeId nodeId)

Specified by:

ownedTopics in interface org.onosproject.cluster.LeadershipService

runForLeadership

public CompletableFuture<org.onosproject.cluster.Leadership> runForLeadership(String path)

Specified by:

runForLeadership in interface org.onosproject.cluster.LeadershipService

withdraw

public CompletableFuture<Void> withdraw(String path)

Specified by:

withdraw in interface org.onosproject.cluster.LeadershipService

stepdown

public boolean stepdown(String path)

Specified by:

stepdown in interface org.onosproject.cluster.LeadershipService

addListener

public void addListener(org.onosproject.cluster.LeadershipEventListener listener)

Specified by:

addListener in interface org.onosproject.cluster.LeadershipService

removeListener

public void removeListener(org.onosproject.cluster.LeadershipEventListener listener)

Specified by:

removeListener in interface org.onosproject.cluster.LeadershipService

makeTopCandidate

public boolean makeTopCandidate(String path,
                                org.onosproject.cluster.NodeId nodeId)

Specified by:

makeTopCandidate in interface org.onosproject.cluster.LeadershipService