org.onosproject.incubator.store.virtual.impl

Class SimpleVirtualGroupStore

java.lang.Object

org.onosproject.incubator.store.virtual.impl.AbstractVirtualStore<org.onosproject.net.group.GroupEvent,org.onosproject.net.group.GroupStoreDelegate>

org.onosproject.incubator.store.virtual.impl.SimpleVirtualGroupStore

All Implemented Interfaces:

VirtualNetworkGroupStore, VirtualStore<org.onosproject.net.group.GroupEvent,org.onosproject.net.group.GroupStoreDelegate>

@Service
public class SimpleVirtualGroupStore
extends AbstractVirtualStore<org.onosproject.net.group.GroupEvent,org.onosproject.net.group.GroupStoreDelegate>
implements VirtualNetworkGroupStore

Manages inventory of virtual group entries using trivial in-memory implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.incubator.net.virtual.VirtualNetworkGroupStore

VirtualNetworkGroupStore.UpdateType

Field Summary

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

delegateMap

Constructor Summary

Constructors

Constructor and Description
SimpleVirtualGroupStore()

Method Summary

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

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

Constructor Detail

SimpleVirtualGroupStore

public SimpleVirtualGroupStore()

Method Detail

activate

@Activate
public void activate()

deactivate

@Deactivate
public void deactivate()

getGroupCount

public int getGroupCount(NetworkId networkId,
                         org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkGroupStore

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

Specified by:

getGroupCount in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

deviceId - the device ID

Returns:

number of groups for the specified device

getGroups

public java.lang.Iterable<org.onosproject.net.group.Group> getGroups(NetworkId networkId,
                                                                     org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkGroupStore

Returns the groups associated with a virtual device.

Specified by:

getGroups in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

deviceId - the device ID

Returns:

the group entries

getGroup

public org.onosproject.net.group.Group getGroup(NetworkId networkId,
                                                org.onosproject.net.DeviceId deviceId,
                                                org.onosproject.net.group.GroupKey appCookie)

Description copied from interface: VirtualNetworkGroupStore

Returns the stored group entry in a virtual network.

Specified by:

getGroup in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

deviceId - the device ID

appCookie - the group key

Returns:

a group associated with the key

getGroup

public org.onosproject.net.group.Group getGroup(NetworkId networkId,
                                                org.onosproject.net.DeviceId deviceId,
                                                org.onosproject.core.GroupId groupId)

Description copied from interface: VirtualNetworkGroupStore

Returns the stored group entry for an id.

Specified by:

getGroup in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

deviceId - the device ID

groupId - the group identifier

Returns:

a group associated with the key

storeGroupDescription

public void storeGroupDescription(NetworkId networkId,
                                  org.onosproject.net.group.GroupDescription groupDesc)

Description copied from interface: VirtualNetworkGroupStore

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

Specified by:

storeGroupDescription in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

groupDesc - group description to be used to store group entry

updateGroupDescription

public void updateGroupDescription(NetworkId networkId,
                                   org.onosproject.net.DeviceId deviceId,
                                   org.onosproject.net.group.GroupKey oldAppCookie,
                                   VirtualNetworkGroupStore.UpdateType type,
                                   org.onosproject.net.group.GroupBuckets newBuckets,
                                   org.onosproject.net.group.GroupKey newAppCookie)

Description copied from interface: VirtualNetworkGroupStore

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

Specified by:

updateGroupDescription in interface VirtualNetworkGroupStore

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

public void deleteGroupDescription(NetworkId networkId,
                                   org.onosproject.net.DeviceId deviceId,
                                   org.onosproject.net.group.GroupKey appCookie)

Description copied from interface: VirtualNetworkGroupStore

Triggers deleting the existing group entry.

Specified by:

deleteGroupDescription in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

deviceId - the device ID

appCookie - the group key

addOrUpdateGroupEntry

public void addOrUpdateGroupEntry(NetworkId networkId,
                                  org.onosproject.net.group.Group group)

Description copied from interface: VirtualNetworkGroupStore

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

Specified by:

addOrUpdateGroupEntry in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

group - group entry

removeGroupEntry

public void removeGroupEntry(NetworkId networkId,
                             org.onosproject.net.group.Group group)

Description copied from interface: VirtualNetworkGroupStore

Removes the group entry from store.

Specified by:

removeGroupEntry in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

group - group entry

purgeGroupEntry

public void purgeGroupEntry(NetworkId networkId,
                            org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkGroupStore

Removes all group entries of given device from store.

Specified by:

purgeGroupEntry in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

deviceId - device id

purgeGroupEntries

public void purgeGroupEntries(NetworkId networkId)

Description copied from interface: VirtualNetworkGroupStore

Removes all group entries from store.

Specified by:

purgeGroupEntries in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

addOrUpdateExtraneousGroupEntry

public void addOrUpdateExtraneousGroupEntry(NetworkId networkId,
                                            org.onosproject.net.group.Group group)

Description copied from interface: VirtualNetworkGroupStore

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

Specified by:

addOrUpdateExtraneousGroupEntry in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

group - group entry

removeExtraneousGroupEntry

public void removeExtraneousGroupEntry(NetworkId networkId,
                                       org.onosproject.net.group.Group group)

Description copied from interface: VirtualNetworkGroupStore

Remove the group entry from extraneous database.

Specified by:

removeExtraneousGroupEntry in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

group - group entry

getExtraneousGroups

public java.lang.Iterable<org.onosproject.net.group.Group> getExtraneousGroups(NetworkId networkId,
                                                                               org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkGroupStore

Returns the extraneous groups associated with a device.

Specified by:

getExtraneousGroups in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

deviceId - the device ID

Returns:

the extraneous group entries

deviceInitialAuditCompleted

public void deviceInitialAuditCompleted(NetworkId networkId,
                                        org.onosproject.net.DeviceId deviceId,
                                        boolean completed)

Description copied from interface: VirtualNetworkGroupStore

Indicates the first group audit is completed.

Specified by:

deviceInitialAuditCompleted in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

deviceId - the device ID

completed - initial audit status

deviceInitialAuditStatus

public boolean deviceInitialAuditStatus(NetworkId networkId,
                                        org.onosproject.net.DeviceId deviceId)

Description copied from interface: VirtualNetworkGroupStore

Retrieves the initial group audit status for a device.

Specified by:

deviceInitialAuditStatus in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

deviceId - the device ID

Returns:

initial group audit status

groupOperationFailed

public void groupOperationFailed(NetworkId networkId,
                                 org.onosproject.net.DeviceId deviceId,
                                 org.onosproject.net.group.GroupOperation operation)

Description copied from interface: VirtualNetworkGroupStore

Indicates the group operations failed.

Specified by:

groupOperationFailed in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

deviceId - the device ID

operation - the group operation failed

pushGroupMetrics

public void pushGroupMetrics(NetworkId networkId,
                             org.onosproject.net.DeviceId deviceId,
                             java.util.Collection<org.onosproject.net.group.Group> groupEntries)

Description copied from interface: VirtualNetworkGroupStore

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

Specified by:

pushGroupMetrics in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

deviceId - the device ID

groupEntries - the group entries as received from southbound

notifyOfFailovers

public void notifyOfFailovers(NetworkId networkId,
                              java.util.Collection<org.onosproject.net.group.Group> failoverGroups)

Description copied from interface: VirtualNetworkGroupStore

Indicates failover within a failover group.

Specified by:

notifyOfFailovers in interface VirtualNetworkGroupStore

Parameters:

networkId - the virtual network ID

failoverGroups - groups to notify