org.onosproject.incubator.net.virtual

Interface VirtualNetworkFlowObjectiveStore

All Superinterfaces:

VirtualStore<org.onosproject.net.flowobjective.ObjectiveEvent,org.onosproject.net.flowobjective.FlowObjectiveStoreDelegate>

public interface VirtualNetworkFlowObjectiveStore
extends VirtualStore<org.onosproject.net.flowobjective.ObjectiveEvent,org.onosproject.net.flowobjective.FlowObjectiveStoreDelegate>

The flow objective store for virtual networks.

Method Summary

Modifier and Type	Method and Description
int	allocateNextId(NetworkId networkId) Allocates a next objective id.
Map<Integer,org.onosproject.net.behaviour.NextGroup>	getAllGroups(NetworkId networkId) Fetch all groups from the store and their mapping to nextIds.
org.onosproject.net.behaviour.NextGroup	getNextGroup(NetworkId networkId, Integer nextId) Fetch a next group from the store.
void	putNextGroup(NetworkId networkId, Integer nextId, org.onosproject.net.behaviour.NextGroup group) Adds a NextGroup to the store, by mapping it to the nextId as key, and replacing any previous mapping.
org.onosproject.net.behaviour.NextGroup	removeNextGroup(NetworkId networkId, Integer nextId) Remove a next group mapping from the store.

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

hasDelegate, setDelegate, unsetDelegate

Method Detail

putNextGroup

void putNextGroup(NetworkId networkId,
                  Integer nextId,
                  org.onosproject.net.behaviour.NextGroup group)

Adds a NextGroup to the store, by mapping it to the nextId as key, and replacing any previous mapping.

Parameters:

networkId - a virtual network identifier

nextId - an integer

group - a next group opaque object

getNextGroup

org.onosproject.net.behaviour.NextGroup getNextGroup(NetworkId networkId,
                                                     Integer nextId)

Fetch a next group from the store.

Parameters:

networkId - a virtual network identifier

nextId - an integer used as key

Returns:

a next group, or null if group was not found

removeNextGroup

org.onosproject.net.behaviour.NextGroup removeNextGroup(NetworkId networkId,
                                                        Integer nextId)

Remove a next group mapping from the store.

Parameters:

networkId - a virtual network identifier

nextId - the key to remove from the store.

Returns:

the next group which mapped to the nextId and is now removed, or null if no group mapping existed in the store

getAllGroups

Map<Integer,org.onosproject.net.behaviour.NextGroup> getAllGroups(NetworkId networkId)

Fetch all groups from the store and their mapping to nextIds.

Parameters:

networkId - a virtual network identifier

Returns:

a map that represents the current snapshot of Next-ids to NextGroups

allocateNextId

int allocateNextId(NetworkId networkId)

Allocates a next objective id. This id is globally unique.

Parameters:

networkId - a virtual network identifier

Returns:

an integer