org.onosproject.net.group.impl

Class GroupManager

java.lang.Object

org.onosproject.net.provider.AbstractProviderRegistry<P,S>

org.onosproject.net.provider.AbstractListenerProviderRegistry<org.onosproject.net.group.GroupEvent,org.onosproject.net.group.GroupListener,org.onosproject.net.group.GroupProvider,org.onosproject.net.group.GroupProviderService>

org.onosproject.net.group.impl.GroupManager

All Implemented Interfaces:

org.onosproject.event.ListenerService<org.onosproject.net.group.GroupEvent,org.onosproject.net.group.GroupListener>, org.onosproject.net.group.GroupProviderRegistry, org.onosproject.net.group.GroupService, org.onosproject.net.provider.ProviderRegistry<org.onosproject.net.group.GroupProvider,org.onosproject.net.group.GroupProviderService>

@Service
public class GroupManager
extends org.onosproject.net.provider.AbstractListenerProviderRegistry<org.onosproject.net.group.GroupEvent,org.onosproject.net.group.GroupListener,org.onosproject.net.group.GroupProvider,org.onosproject.net.group.GroupProviderService>
implements org.onosproject.net.group.GroupService, org.onosproject.net.group.GroupProviderRegistry

Provides implementation of the group service APIs.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.onosproject.cfg.ComponentConfigService	cfgService
protected org.onosproject.net.device.DeviceService	deviceService
protected org.onosproject.net.group.GroupStore	store

Fields inherited from class org.onosproject.net.provider.AbstractListenerProviderRegistry

eventDispatcher, listenerRegistry

Constructor Summary

Constructors

Constructor and Description
GroupManager()

Method Summary

Modifier and Type	Method and Description
void	activate(org.osgi.service.component.ComponentContext context)
void	addBucketsToGroup(org.onosproject.net.DeviceId deviceId, org.onosproject.net.group.GroupKey oldCookie, org.onosproject.net.group.GroupBuckets buckets, org.onosproject.net.group.GroupKey newCookie, org.onosproject.core.ApplicationId appId) Append buckets to existing group.
void	addGroup(org.onosproject.net.group.GroupDescription groupDesc) Create a group in the specified device with the provided parameters.
protected org.onosproject.net.group.GroupProviderService	createProviderService(org.onosproject.net.group.GroupProvider provider)
void	deactivate()
protected org.onosproject.net.group.GroupProvider	defaultProvider()
org.onosproject.net.group.Group	getGroup(org.onosproject.net.DeviceId deviceId, org.onosproject.net.group.GroupKey appCookie) Return a group object associated to an application cookie.
Iterable<org.onosproject.net.group.Group>	getGroups(org.onosproject.net.DeviceId deviceId)
Iterable<org.onosproject.net.group.Group>	getGroups(org.onosproject.net.DeviceId deviceId, org.onosproject.core.ApplicationId appId) Retrieve all groups created by an application in the specified device as seen by current controller instance.
void	modified(org.osgi.service.component.ComponentContext context)
void	purgeGroupEntries()
void	purgeGroupEntries(org.onosproject.net.DeviceId deviceId)
void	removeBucketsFromGroup(org.onosproject.net.DeviceId deviceId, org.onosproject.net.group.GroupKey oldCookie, org.onosproject.net.group.GroupBuckets buckets, org.onosproject.net.group.GroupKey newCookie, org.onosproject.core.ApplicationId appId) Remove buckets from existing group.
void	removeGroup(org.onosproject.net.DeviceId deviceId, org.onosproject.net.group.GroupKey appCookie, org.onosproject.core.ApplicationId appId) Delete a group associated to an application cookie.

Methods inherited from class org.onosproject.net.provider.AbstractListenerProviderRegistry

addListener, bindEventDispatcher, post, removeListener, unbindEventDispatcher

Methods inherited from class org.onosproject.net.provider.AbstractProviderRegistry

getProvider, getProvider, getProvider, getProviders, register, unregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.onosproject.event.ListenerService

addListener, removeListener

Methods inherited from interface org.onosproject.net.provider.ProviderRegistry

getProviders, register, unregister

Field Detail

store

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.net.group.GroupStore store

deviceService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.net.device.DeviceService deviceService

cfgService

@Reference(cardinality=MANDATORY_UNARY)
protected org.onosproject.cfg.ComponentConfigService cfgService

Constructor Detail

GroupManager

public GroupManager()

Method Detail

activate

@Activate
public void activate(org.osgi.service.component.ComponentContext context)

deactivate

@Deactivate
public void deactivate()

modified

@Modified
public void modified(org.osgi.service.component.ComponentContext context)

defaultProvider

protected org.onosproject.net.group.GroupProvider defaultProvider()

Overrides:

defaultProvider in class org.onosproject.net.provider.AbstractProviderRegistry<org.onosproject.net.group.GroupProvider,org.onosproject.net.group.GroupProviderService>

addGroup

public void addGroup(org.onosproject.net.group.GroupDescription groupDesc)

Create a group in the specified device with the provided parameters.

Specified by:

addGroup in interface org.onosproject.net.group.GroupService

Parameters:

groupDesc - group creation parameters

getGroup

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

Return a group object associated to an application cookie.

NOTE1: The presence of group object in the system does not guarantee that the "group" is actually created in device. GROUP_ADDED notification would confirm the creation of this group in data plane.

Specified by:

getGroup in interface org.onosproject.net.group.GroupService

Parameters:

deviceId - device identifier

appCookie - application cookie to be used for lookup

Returns:

group associated with the application cookie or NULL if Group is not found for the provided cookie

addBucketsToGroup

public void addBucketsToGroup(org.onosproject.net.DeviceId deviceId,
                              org.onosproject.net.group.GroupKey oldCookie,
                              org.onosproject.net.group.GroupBuckets buckets,
                              org.onosproject.net.group.GroupKey newCookie,
                              org.onosproject.core.ApplicationId appId)

Append buckets to existing group. The caller can optionally associate a new cookie during this updation. GROUP_UPDATED or GROUP_UPDATE_FAILED notifications would be provided along with cookie depending on the result of the operation on the device.

Specified by:

addBucketsToGroup in interface org.onosproject.net.group.GroupService

Parameters:

deviceId - device identifier

oldCookie - cookie to be used to retrieve the existing group

buckets - immutable list of group bucket to be added

newCookie - immutable cookie to be used post update operation

appId - Application Id

removeBucketsFromGroup

public void removeBucketsFromGroup(org.onosproject.net.DeviceId deviceId,
                                   org.onosproject.net.group.GroupKey oldCookie,
                                   org.onosproject.net.group.GroupBuckets buckets,
                                   org.onosproject.net.group.GroupKey newCookie,
                                   org.onosproject.core.ApplicationId appId)

Remove buckets from existing group. The caller can optionally associate a new cookie during this updation. GROUP_UPDATED or GROUP_UPDATE_FAILED notifications would be provided along with cookie depending on the result of the operation on the device.

Specified by:

removeBucketsFromGroup in interface org.onosproject.net.group.GroupService

Parameters:

deviceId - device identifier

oldCookie - cookie to be used to retrieve the existing group

buckets - immutable list of group bucket to be removed

newCookie - immutable cookie to be used post update operation

appId - Application Id

purgeGroupEntries

public void purgeGroupEntries(org.onosproject.net.DeviceId deviceId)

Specified by:

purgeGroupEntries in interface org.onosproject.net.group.GroupService

purgeGroupEntries

public void purgeGroupEntries()

Specified by:

purgeGroupEntries in interface org.onosproject.net.group.GroupService

removeGroup

public void removeGroup(org.onosproject.net.DeviceId deviceId,
                        org.onosproject.net.group.GroupKey appCookie,
                        org.onosproject.core.ApplicationId appId)

Delete a group associated to an application cookie. GROUP_DELETED or GROUP_DELETE_FAILED notifications would be provided along with cookie depending on the result of the operation on the device.

Specified by:

removeGroup in interface org.onosproject.net.group.GroupService

Parameters:

deviceId - device identifier

appCookie - application cookie to be used for lookup

appId - Application Id

getGroups

public Iterable<org.onosproject.net.group.Group> getGroups(org.onosproject.net.DeviceId deviceId,
                                                           org.onosproject.core.ApplicationId appId)

Retrieve all groups created by an application in the specified device as seen by current controller instance.

Specified by:

getGroups in interface org.onosproject.net.group.GroupService

Parameters:

deviceId - device identifier

appId - application id

Returns:

collection of immutable group objects created by the application

getGroups

public Iterable<org.onosproject.net.group.Group> getGroups(org.onosproject.net.DeviceId deviceId)

Specified by:

getGroups in interface org.onosproject.net.group.GroupService

createProviderService

protected org.onosproject.net.group.GroupProviderService createProviderService(org.onosproject.net.group.GroupProvider provider)

Specified by:

createProviderService in class org.onosproject.net.provider.AbstractProviderRegistry<org.onosproject.net.group.GroupProvider,org.onosproject.net.group.GroupProviderService>