org.onosproject.incubator.net.virtual

Interface VirtualNetworkGroupStore

All Superinterfaces:

VirtualStore<GroupEvent,GroupStoreDelegate>

public interface VirtualNetworkGroupStore
extends VirtualStore<GroupEvent,GroupStoreDelegate>

Manages inventory of groups per virtual network and virtual device; not intended for direct use.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VirtualNetworkGroupStore.UpdateType

Method Summary

Modifier and Type	Method and Description
void	addOrUpdateExtraneousGroupEntry(NetworkId networkId, Group group) A group entry that is present in switch but not in the store.
void	addOrUpdateGroupEntry(NetworkId networkId, Group group) Stores a new group entry, or updates an existing entry.
void	deleteGroupDescription(NetworkId networkId, DeviceId deviceId, GroupKey appCookie) Triggers deleting the existing group entry.
void	deviceInitialAuditCompleted(NetworkId networkId, DeviceId deviceId, boolean completed) Indicates the first group audit is completed.
boolean	deviceInitialAuditStatus(NetworkId networkId, DeviceId deviceId) Retrieves the initial group audit status for a device.
java.lang.Iterable<Group>	getExtraneousGroups(NetworkId networkId, DeviceId deviceId) Returns the extraneous groups associated with a device.
Group	getGroup(NetworkId networkId, DeviceId deviceId, GroupId groupId) Returns the stored group entry for an id.
Group	getGroup(NetworkId networkId, DeviceId deviceId, GroupKey appCookie) Returns the stored group entry in a virtual network.
int	getGroupCount(NetworkId networkId, DeviceId deviceId) Returns the number of groups for the specified virtual device in the store.
java.lang.Iterable<Group>	getGroups(NetworkId networkId, DeviceId deviceId) Returns the groups associated with a virtual device.
void	groupOperationFailed(NetworkId networkId, DeviceId deviceId, GroupOperation operation) Indicates the group operations failed.
void	notifyOfFailovers(NetworkId networkId, java.util.Collection<Group> failoverGroups) Indicates failover within a failover group.
default void	purgeGroupEntries(NetworkId networkId) Removes all group entries from store.
void	purgeGroupEntry(NetworkId networkId, DeviceId deviceId) Removes all group entries of given device from store.
void	pushGroupMetrics(NetworkId networkId, DeviceId deviceId, java.util.Collection<Group> groupEntries) Submits the group metrics to store for a given device ID.
void	removeExtraneousGroupEntry(NetworkId networkId, Group group) Remove the group entry from extraneous database.
void	removeGroupEntry(NetworkId networkId, Group group) Removes the group entry from store.
void	storeGroupDescription(NetworkId networkId, GroupDescription groupDesc) Stores a new group entry using the information from group description for a virtual network.
void	updateGroupDescription(NetworkId networkId, DeviceId deviceId, GroupKey oldAppCookie, VirtualNetworkGroupStore.UpdateType type, GroupBuckets newBuckets, GroupKey newAppCookie) Updates the existing group entry with the information from group description.

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

hasDelegate, setDelegate, unsetDelegate

Method Detail

getGroupCount

int getGroupCount(NetworkId networkId,
                  DeviceId deviceId)

Returns the number of groups for the specified virtual device in the store.

Parameters:

networkId - the virtual network ID

deviceId - the device ID

Returns:

number of groups for the specified device

getGroups

java.lang.Iterable<Group> getGroups(NetworkId networkId,
                                    DeviceId deviceId)

Returns the groups associated with a virtual device.

Parameters:

networkId - the virtual network ID

deviceId - the device ID

Returns:

the group entries

getGroup

Group getGroup(NetworkId networkId,
               DeviceId deviceId,
               GroupKey appCookie)

Returns the stored group entry in a virtual network.

Parameters:

networkId - the virtual network ID

deviceId - the device ID

appCookie - the group key

Returns:

a group associated with the key

getGroup

Group getGroup(NetworkId networkId,
               DeviceId deviceId,
               GroupId groupId)

Returns the stored group entry for an id.

Parameters:

networkId - the virtual network ID

deviceId - the device ID

groupId - the group identifier

Returns:

a group associated with the key

storeGroupDescription

void storeGroupDescription(NetworkId networkId,
                           GroupDescription groupDesc)

Stores a new group entry using the information from group description for a virtual network.

Parameters:

networkId - the virtual network ID

groupDesc - group description to be used to store group entry

updateGroupDescription

void updateGroupDescription(NetworkId networkId,
                            DeviceId deviceId,
                            GroupKey oldAppCookie,
                            VirtualNetworkGroupStore.UpdateType type,
                            GroupBuckets newBuckets,
                            GroupKey newAppCookie)

Updates the existing group entry with the information from group description.

Parameters:

networkId - the virtual network ID

deviceId - the device ID

oldAppCookie - the current group key

type - update type

newBuckets - group buckets for updates

newAppCookie - optional new group key

deleteGroupDescription

void deleteGroupDescription(NetworkId networkId,
                            DeviceId deviceId,
                            GroupKey appCookie)

Triggers deleting the existing group entry.

Parameters:

networkId - the virtual network ID

deviceId - the device ID

appCookie - the group key

addOrUpdateGroupEntry

void addOrUpdateGroupEntry(NetworkId networkId,
                           Group group)

Stores a new group entry, or updates an existing entry.

Parameters:

networkId - the virtual network ID

group - group entry

removeGroupEntry

void removeGroupEntry(NetworkId networkId,
                      Group group)

Removes the group entry from store.

Parameters:

networkId - the virtual network ID

group - group entry

purgeGroupEntry

void purgeGroupEntry(NetworkId networkId,
                     DeviceId deviceId)

Removes all group entries of given device from store.

Parameters:

networkId - the virtual network ID

deviceId - device id

purgeGroupEntries

default void purgeGroupEntries(NetworkId networkId)

Removes all group entries from store.

Parameters:

networkId - the virtual network ID

addOrUpdateExtraneousGroupEntry

void addOrUpdateExtraneousGroupEntry(NetworkId networkId,
                                     Group group)

A group entry that is present in switch but not in the store.

Parameters:

networkId - the virtual network ID

group - group entry

removeExtraneousGroupEntry

void removeExtraneousGroupEntry(NetworkId networkId,
                                Group group)

Remove the group entry from extraneous database.

Parameters:

networkId - the virtual network ID

group - group entry

getExtraneousGroups

java.lang.Iterable<Group> getExtraneousGroups(NetworkId networkId,
                                              DeviceId deviceId)

Returns the extraneous groups associated with a device.

Parameters:

networkId - the virtual network ID

deviceId - the device ID

Returns:

the extraneous group entries

deviceInitialAuditCompleted

void deviceInitialAuditCompleted(NetworkId networkId,
                                 DeviceId deviceId,
                                 boolean completed)

Indicates the first group audit is completed.

Parameters:

networkId - the virtual network ID

deviceId - the device ID

completed - initial audit status

deviceInitialAuditStatus

boolean deviceInitialAuditStatus(NetworkId networkId,
                                 DeviceId deviceId)

Retrieves the initial group audit status for a device.

Parameters:

networkId - the virtual network ID

deviceId - the device ID

Returns:

initial group audit status

groupOperationFailed

void groupOperationFailed(NetworkId networkId,
                          DeviceId deviceId,
                          GroupOperation operation)

Indicates the group operations failed.

Parameters:

networkId - the virtual network ID

deviceId - the device ID

operation - the group operation failed

pushGroupMetrics

void pushGroupMetrics(NetworkId networkId,
                      DeviceId deviceId,
                      java.util.Collection<Group> groupEntries)

Submits the group metrics to store for a given device ID.

Parameters:

networkId - the virtual network ID

deviceId - the device ID

groupEntries - the group entries as received from southbound

notifyOfFailovers

void notifyOfFailovers(NetworkId networkId,
                       java.util.Collection<Group> failoverGroups)

Indicates failover within a failover group.

Parameters:

networkId - the virtual network ID

failoverGroups - groups to notify