com.hp.sdn.device

Interface DeviceSupplierService

All Superinterfaces:

SupplierService

All Known Implementing Classes:

DeviceSupplierServiceAdapter

public interface DeviceSupplierService
extends SupplierService

Service for adding/removing or otherwise supplying information about infrastructure devices in the environment.

Author:

Thomas Vachuska, Shaun Humphress, Julie Britt, Steve Dean

Method Summary

Methods

Modifier and Type	Method and Description
Device	createOrUpdateDevice(DeviceId deviceId, Set<URI> uris, DeviceInfo info) Creates, or updates, a device using the supplied discovery URIs and device information populated with basic device identity data.
void	createOrUpdateInterface(DeviceId deviceId, List<InterfaceInfo> netInterfaces) Create or update the interfaces associated with the device.
SupplierId	getId() Returns the supplier id assigned by the supplier's broker.
void	removeDevice(DeviceId deviceId) Removes the specified device from the inventory.
void	setOnline(DeviceId deviceId, boolean online) Marks the device as on/off line.
void	updateInterface(DeviceId deviceId, Interface netInterface) Update a single interface.

Method Detail

createOrUpdateDevice

Device createOrUpdateDevice(DeviceId deviceId,
                          Set<URI> uris,
                          DeviceInfo info)

Creates, or updates, a device using the supplied discovery URIs and device information populated with basic device identity data. If the supplier service already knows about a device with the same unique identifier (see DeviceIdentity.getUniqueId(), that device instance will be simply updated and returned.

Note that it is the responsibility of the caller (DeviceSupplier to populate the info with the identity information beforehand.

Parameters:

deviceId - unique identifier for the device

uris - set of discovery URIs

info - device info from the initial discovery/classification

Returns:

newly created device or and updated one, or null if device creation failed

removeDevice

void removeDevice(DeviceId deviceId)

Removes the specified device from the inventory.

Parameters:

deviceId - device to be removed

setOnline

void setOnline(DeviceId deviceId,
             boolean online)

Marks the device as on/off line.

Parameters:

deviceId - device to be updated

online - true to mark device online

Throws:

NotFoundException - if device not found

getId

SupplierId getId()

Returns the supplier id assigned by the supplier's broker.

Returns:

supplier id

createOrUpdateInterface

void createOrUpdateInterface(DeviceId deviceId,
                           List<InterfaceInfo> netInterfaces)

Create or update the interfaces associated with the device. An empty list will remove all interfaces from the device.

Parameters:

deviceId - device where the interfaces are associated

netInterfaces - interfaces to associate

updateInterface

void updateInterface(DeviceId deviceId,
                   Interface netInterface)

Update a single interface. Typically used to update the model object and store the changes.

Parameters:

deviceId - Device that hosts the interface

netInterface - interface to update