Package org.onosproject.net.region
Interface RegionAdminService
-
- All Superinterfaces:
ListenerService<RegionEvent,RegionListener>
,RegionService
public interface RegionAdminService extends RegionService
Service for interacting with inventory of network control regions.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addDevices(RegionId regionId, java.util.Collection<DeviceId> deviceIds)
Adds the specified collection of devices to the region.Region
createRegion(RegionId regionId, java.lang.String name, Region.Type type, java.util.List<java.util.Set<NodeId>> masterNodeIds)
Creates a new region using the supplied data.void
removeDevices(RegionId regionId, java.util.Collection<DeviceId> deviceIds)
Removes the specified collection of devices from the region.void
removeRegion(RegionId regionId)
Removes the specified region using the new set of data.Region
updateRegion(RegionId regionId, java.lang.String name, Region.Type type, java.util.List<java.util.Set<NodeId>> masterNodeIds)
Update the specified region using the new set of data.-
Methods inherited from interface org.onosproject.event.ListenerService
addListener, removeListener
-
Methods inherited from interface org.onosproject.net.region.RegionService
getRegion, getRegionDevices, getRegionForDevice, getRegionHosts, getRegions
-
-
-
-
Method Detail
-
createRegion
Region createRegion(RegionId regionId, java.lang.String name, Region.Type type, java.util.List<java.util.Set<NodeId>> masterNodeIds)
Creates a new region using the supplied data.- Parameters:
regionId
- region identifiername
- friendly nametype
- region typemasterNodeIds
- list of sets of master nodes; null implies empty list- Returns:
- new region descriptor
- Throws:
java.lang.IllegalArgumentException
- if region already exists
-
updateRegion
Region updateRegion(RegionId regionId, java.lang.String name, Region.Type type, java.util.List<java.util.Set<NodeId>> masterNodeIds)
Update the specified region using the new set of data.- Parameters:
regionId
- region identifiername
- friendly nametype
- region typemasterNodeIds
- list of sets of master nodes; null implies empty list- Returns:
- new region descriptor
-
removeRegion
void removeRegion(RegionId regionId)
Removes the specified region using the new set of data.- Parameters:
regionId
- region identifier
-
addDevices
void addDevices(RegionId regionId, java.util.Collection<DeviceId> deviceIds)
Adds the specified collection of devices to the region.- Parameters:
regionId
- region identifierdeviceIds
- list of device identifiers
-
-