org.onosproject.incubator.net.virtual

Interface VirtualNetworkMastershipStore

All Superinterfaces:

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

public interface VirtualNetworkMastershipStore
extends VirtualStore<org.onosproject.mastership.MastershipEvent,org.onosproject.mastership.MastershipStoreDelegate>

Manages inventory of mastership roles for devices, across controller instances for virtual networks; not intended for direct use.

Method Summary

Modifier and Type	Method and Description
java.util.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.
java.util.concurrent.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.
java.util.concurrent.CompletableFuture<org.onosproject.net.MastershipRole>	requestRole(NetworkId networkId, org.onosproject.net.DeviceId deviceId) Requests role of the local node for the specified device.
java.util.concurrent.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.
java.util.concurrent.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 interface org.onosproject.incubator.net.virtual.VirtualStore

hasDelegate, setDelegate, unsetDelegate

Method Detail

requestRole

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

Requests role of the local node for the specified device.

Parameters:

networkId - the virtual network identifier

deviceId - the device identifier

Returns:

established or newly negotiated mastership role

getRole

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.

Parameters:

networkId - virtual network identifier

nodeId - the instance identifier

deviceId - the device identifiers

Returns:

the role

getMaster

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

Returns the master for a device.

Parameters:

networkId - virtual network identifier

deviceId - the device identifier

Returns:

the instance identifier of the master

getNodes

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

Returns the master and backup nodes for a device.

Parameters:

networkId - virtual network identifier

deviceId - the device identifier

Returns:

a RoleInfo containing controller IDs

getDevices

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

Returns the devices that a controller instance is master of.

Parameters:

networkId - virtual network identifier

nodeId - the instance identifier

Returns:

a set of device identifiers

setMaster

java.util.concurrent.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.

Parameters:

networkId - virtual network identifier

nodeId - controller instance identifier

deviceId - device identifier

Returns:

a mastership event

getTermFor

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.

Parameters:

networkId - virtual network identifier

deviceId - the device identifier

Returns:

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

setStandby

java.util.concurrent.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. If the role is MASTER, another controller instance will be selected as a candidate master.

Parameters:

networkId - virtual network identifier

nodeId - the controller instance identifier

deviceId - device to revoke mastership role for

Returns:

a mastership event

relinquishRole

java.util.concurrent.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. If the role is MASTER, another controller instance will be selected as a candidate master.

Parameters:

networkId - virtual network identifier

nodeId - the controller instance identifier

deviceId - device to revoke mastership role for

Returns:

a mastership event

relinquishAllRole

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

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

Parameters:

networkId - virtual network identifier

nodeId - the controller instance identifier