com.hp.sdn.device

Interface DeviceService

All Known Implementing Classes:

DeviceServiceAdapter

public interface DeviceService

Provides information about infrastructure devices known to the system.

Author:

Thomas Vachuska, Shaun Humphress, Julie Britt, Steve Dean

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(DeviceListener listener) Add the specified listener...
Device	getDevice(DataPathId dpid) Returns the device with the specified management Data Path Id (dpid).
Device	getDevice(DeviceId id) Returns the device with the specified id.
Device	getDevice(URI uri) Returns the device with the specified URI.
Iterator<Device>	getDevices() Returns set of all devices known to the system.
Iterator<Device>	getDevices(Class<? extends Facet> facetClass) Returns a list of all devices that support the specified device driver facet.
Iterator<Device>	getDevices(DeviceFilter filter) Returns set of all devices that match the supplied filter.
Set<Device>	getDevices(IpAddress deviceIp) Returns the device with the specified management IP address.
Interface	getInterface(DeviceId deviceId, InterfaceId interfaceId) Returns the interface requested with the device and interface ids.
List<Interface>	getInterfaces(Device device) Returns the list of interfaces hosted on this device.
VlanId	getLinkDiscoveryVlan(DeviceId deviceId) Get the linkDiscoveryVlan configured for the device.
Set<DeviceListener>	getListeners() Returns the set of all device update listeners.
void	removeListener(DeviceListener listener) Remove the specified listener...
void	setLinkDiscoveryVlan(DeviceId deviceId, VlanId linkDiscoveryVlan) Assign a user provided linkDiscoveryVlan to the device.
void	setName(Device device, String name) Assign a user provided friendly name to the device.

Method Detail

getDevices

Iterator<Device> getDevices()

Returns set of all devices known to the system.

Returns:

set of all devices

getDevices

Iterator<Device> getDevices(DeviceFilter filter)

Returns set of all devices that match the supplied filter.

Parameters:

filter - device filter

Returns:

set of all devices

getDevice

Device getDevice(DeviceId id)

Returns the device with the specified id.

Parameters:

id - device id

Returns:

device, null if not found

getDevices

Set<Device> getDevices(IpAddress deviceIp)

Returns the device with the specified management IP address.

Parameters:

deviceIp - management IP

Returns:

devices, empty set if none found

getDevice

Device getDevice(DataPathId dpid)

Returns the device with the specified management Data Path Id (dpid).

Parameters:

dpid - management Data Path Id

Returns:

device, null if not found

getDevice

Device getDevice(URI uri)

Returns the device with the specified URI.

Parameters:

uri - URI identifier

Returns:

device, null if not found

getDevices

Iterator<Device> getDevices(Class<? extends Facet> facetClass)

Returns a list of all devices that support the specified device driver facet.

Parameters:

facetClass - facet class to filter by

Returns:

device iterator, empty iterator if none found

getInterfaces

List<Interface> getInterfaces(Device device)

Returns the list of interfaces hosted on this device.

Parameters:

device - device descriptor

Returns:

list of interfaces/ports

getInterface

Interface getInterface(DeviceId deviceId,
                     InterfaceId interfaceId)

Returns the interface requested with the device and interface ids.

Parameters:

deviceId - device id

interfaceId - interface id

Returns:

requested interface, null if not found

addListener

void addListener(DeviceListener listener)

Add the specified listener...

Parameters:

listener - listener to be added

removeListener

void removeListener(DeviceListener listener)

Remove the specified listener...

Parameters:

listener - listener to be removed

getListeners

Set<DeviceListener> getListeners()

Returns the set of all device update listeners.

Returns:

all device listeners

setName

void setName(Device device,
           String name)

Assign a user provided friendly name to the device.

Parameters:

device - to modify

name - user provided friendly name

Throws:

NotFoundException - if device not found

setLinkDiscoveryVlan

void setLinkDiscoveryVlan(DeviceId deviceId,
                        VlanId linkDiscoveryVlan)

Assign a user provided linkDiscoveryVlan to the device.

Parameters:

deviceId - to set linkDiscoveryVlan for

linkDiscoveryVlan - user provided linkDiscoveryVlan id

Throws:

NotFoundException - if device not found

getLinkDiscoveryVlan

VlanId getLinkDiscoveryVlan(DeviceId deviceId)

Get the linkDiscoveryVlan configured for the device.

Parameters:

deviceId - containing linkDiscoveryVlan

Returns:

linkDiscoveryVlan stored for the device

Throws:

NotFoundException - if device not found