org.onosproject.incubator.store.virtual.impl

Class ConsistentVirtualDeviceMastershipStore

java.lang.Object

org.onosproject.incubator.store.virtual.impl.AbstractVirtualStore<org.onosproject.mastership.MastershipEvent,org.onosproject.mastership.MastershipStoreDelegate>

org.onosproject.incubator.store.virtual.impl.ConsistentVirtualDeviceMastershipStore

All Implemented Interfaces:

VirtualNetworkMastershipStore, VirtualStore<org.onosproject.mastership.MastershipEvent,org.onosproject.mastership.MastershipStoreDelegate>

@Service
public class ConsistentVirtualDeviceMastershipStore
extends AbstractVirtualStore<org.onosproject.mastership.MastershipEvent,org.onosproject.mastership.MastershipStoreDelegate>
implements VirtualNetworkMastershipStore

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.cluster.LeadershipAdminService	leadershipAdminService
protected org.onosproject.cluster.LeadershipService	leadershipService
static org.onosproject.store.service.Serializer	SERIALIZER

Fields inherited from class org.onosproject.incubator.store.virtual.impl.AbstractVirtualStore

delegateMap

Constructor Summary

Constructors

Constructor and Description
ConsistentVirtualDeviceMastershipStore()

Method Summary

Modifier and Type	Method and Description
void	activate()
void	deactivate()
Set<org.onosproject.net.DeviceId>	getDevices(NetworkId networkId, org.onosproject.cluster.NodeId nodeId) Returns the devices that a controller instance is master of.
org.onosproject.cluster.NodeId	getMaster(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Returns the master for a device.
org.onosproject.cluster.RoleInfo	getNodes(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Returns the master and backup nodes for a device.
org.onosproject.net.MastershipRole	getRole(NetworkId networkId, org.onosproject.cluster.NodeId nodeId, org.onosproject.net.DeviceId deviceId) Returns the role of a device for a specific controller instance.
org.onosproject.mastership.MastershipTerm	getTermFor(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Returns the current master and number of past mastership hand-offs (terms) for a device.
void	relinquishAllRole(NetworkId networkId, org.onosproject.cluster.NodeId nodeId) Removes all the roles for the specified controller instance.
CompletableFuture<org.onosproject.mastership.MastershipEvent>	relinquishRole(NetworkId networkId, org.onosproject.cluster.NodeId nodeId, org.onosproject.net.DeviceId deviceId) Allows a controller instance to give up its current role for a device.
CompletableFuture<org.onosproject.net.MastershipRole>	requestRole(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Requests role of the local node for the specified device.
CompletableFuture<org.onosproject.mastership.MastershipEvent>	setMaster(NetworkId networkId, org.onosproject.cluster.NodeId nodeId, org.onosproject.net.DeviceId deviceId) Sets a device's role for a specified controller instance.
CompletableFuture<org.onosproject.mastership.MastershipEvent>	setStandby(NetworkId networkId, org.onosproject.cluster.NodeId nodeId, org.onosproject.net.DeviceId deviceId) Sets a controller instance's mastership role to STANDBY for a device.

Methods inherited from class org.onosproject.incubator.store.virtual.impl.AbstractVirtualStore

hasDelegate, notifyDelegate, notifyDelegate, setDelegate, unsetDelegate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.incubator.net.virtual.VirtualStore

hasDelegate, setDelegate, unsetDelegate

Field Detail

leadershipService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.cluster.LeadershipService leadershipService

leadershipAdminService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.cluster.LeadershipAdminService leadershipAdminService

clusterService

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

clusterCommunicator

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

SERIALIZER

public static final org.onosproject.store.service.Serializer SERIALIZER

Constructor Detail

ConsistentVirtualDeviceMastershipStore

public ConsistentVirtualDeviceMastershipStore()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

requestRole

public CompletableFuture<org.onosproject.net.MastershipRole> requestRole(NetworkId networkId,
                                                                         org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkMastershipStore

Requests role of the local node for the specified device.

Specified by:

requestRole in interface VirtualNetworkMastershipStore

Parameters:

networkId - the virtual network identifier

deviceId - the device identifier

Returns:

established or newly negotiated mastership role

getRole

public org.onosproject.net.MastershipRole getRole(NetworkId networkId,
                                                  org.onosproject.cluster.NodeId nodeId,
                                                  org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkMastershipStore

Returns the role of a device for a specific controller instance.

Specified by:

getRole in interface VirtualNetworkMastershipStore

Parameters:

networkId - virtual network identifier

nodeId - the instance identifier

deviceId - the device identifiers

Returns:

the role

getMaster

public org.onosproject.cluster.NodeId getMaster(NetworkId networkId,
                                                org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkMastershipStore

Returns the master for a device.

Specified by:

getMaster in interface VirtualNetworkMastershipStore

Parameters:

networkId - virtual network identifier

deviceId - the device identifier

Returns:

the instance identifier of the master

getNodes

public org.onosproject.cluster.RoleInfo getNodes(NetworkId networkId,
                                                 org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkMastershipStore

Returns the master and backup nodes for a device.

Specified by:

getNodes in interface VirtualNetworkMastershipStore

Parameters:

networkId - virtual network identifier

deviceId - the device identifier

Returns:

a RoleInfo containing controller IDs

getDevices

public Set<org.onosproject.net.DeviceId> getDevices(NetworkId networkId,
                                                    org.onosproject.cluster.NodeId nodeId)

Description copied from interface: VirtualNetworkMastershipStore

Returns the devices that a controller instance is master of.

Specified by:

getDevices in interface VirtualNetworkMastershipStore

Parameters:

networkId - virtual network identifier

nodeId - the instance identifier

Returns:

a set of device identifiers

setMaster

public CompletableFuture<org.onosproject.mastership.MastershipEvent> setMaster(NetworkId networkId,
                                                                               org.onosproject.cluster.NodeId nodeId,
                                                                               org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkMastershipStore

Sets a device's role for a specified controller instance.

Specified by:

setMaster in interface VirtualNetworkMastershipStore

Parameters:

networkId - virtual network identifier

nodeId - controller instance identifier

deviceId - device identifier

Returns:

a mastership event

getTermFor

public org.onosproject.mastership.MastershipTerm getTermFor(NetworkId networkId,
                                                            org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkMastershipStore

Returns the current master and number of past mastership hand-offs (terms) for a device.

Specified by:

getTermFor in interface VirtualNetworkMastershipStore

Parameters:

networkId - virtual network identifier

deviceId - the device identifier

Returns:

the current master's ID and the term value for device, or null

setStandby

public CompletableFuture<org.onosproject.mastership.MastershipEvent> setStandby(NetworkId networkId,
                                                                                org.onosproject.cluster.NodeId nodeId,
                                                                                org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkMastershipStore

Sets a controller instance's mastership role to STANDBY for a device. If the role is MASTER, another controller instance will be selected as a candidate master.

Specified by:

setStandby in interface VirtualNetworkMastershipStore

Parameters:

networkId - virtual network identifier

nodeId - the controller instance identifier

deviceId - device to revoke mastership role for

Returns:

a mastership event

relinquishRole

public CompletableFuture<org.onosproject.mastership.MastershipEvent> relinquishRole(NetworkId networkId,
                                                                                    org.onosproject.cluster.NodeId nodeId,
                                                                                    org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkMastershipStore

Allows a controller instance to give up its current role for a device. If the role is MASTER, another controller instance will be selected as a candidate master.

Specified by:

relinquishRole in interface VirtualNetworkMastershipStore

Parameters:

networkId - virtual network identifier

nodeId - the controller instance identifier

deviceId - device to revoke mastership role for

Returns:

a mastership event

relinquishAllRole

public void relinquishAllRole(NetworkId networkId,
                              org.onosproject.cluster.NodeId nodeId)

Description copied from interface: VirtualNetworkMastershipStore

Removes all the roles for the specified controller instance. If the role was MASTER, another controller instance will be selected as a candidate master.

Specified by:

relinquishAllRole in interface VirtualNetworkMastershipStore

Parameters:

networkId - virtual network identifier

nodeId - the controller instance identifier