com.hp.sdn.device

Class DeviceServiceAdapter

java.lang.Object

com.hp.sdn.device.DeviceServiceAdapter

All Implemented Interfaces:

DeviceService

public class DeviceServiceAdapter
extends Object
implements DeviceService

An adapter for the DeviceService API, provided specifically for unit tests and implementers to use, to insulate from changes in the API.

Author:

Shaun Wackerly

Constructor Summary

Constructors

Constructor and Description
DeviceServiceAdapter()

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeviceServiceAdapter

public DeviceServiceAdapter()

Method Detail

getDevices

public Iterator<Device> getDevices()

Description copied from interface: DeviceService

Returns set of all devices known to the system.

Specified by:

getDevices in interface DeviceService

Returns:

set of all devices

getDevices

public Iterator<Device> getDevices(DeviceFilter filter)

Description copied from interface: DeviceService

Returns set of all devices that match the supplied filter.

Specified by:

getDevices in interface DeviceService

Parameters:

filter - device filter

Returns:

set of all devices

getDevice

public Device getDevice(DeviceId id)

Description copied from interface: DeviceService

Returns the device with the specified id.

Specified by:

getDevice in interface DeviceService

Parameters:

id - device id

Returns:

device, null if not found

getDevices

public Set<Device> getDevices(IpAddress deviceIp)

Description copied from interface: DeviceService

Returns the device with the specified management IP address.

Specified by:

getDevices in interface DeviceService

Parameters:

deviceIp - management IP

Returns:

devices, empty set if none found

getDevice

public Device getDevice(DataPathId dpid)

Description copied from interface: DeviceService

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

Specified by:

getDevice in interface DeviceService

Parameters:

dpid - management Data Path Id

Returns:

device, null if not found

getDevice

public Device getDevice(URI uri)

Description copied from interface: DeviceService

Returns the device with the specified URI.

Specified by:

getDevice in interface DeviceService

Parameters:

uri - URI identifier

Returns:

device, null if not found

getDevices

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

Description copied from interface: DeviceService

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

Specified by:

getDevices in interface DeviceService

Parameters:

facetClass - facet class to filter by

Returns:

device iterator, empty iterator if none found

getInterfaces

public List<Interface> getInterfaces(Device device)

Description copied from interface: DeviceService

Returns the list of interfaces hosted on this device.

Specified by:

getInterfaces in interface DeviceService

Parameters:

device - device descriptor

Returns:

list of interfaces/ports

getInterface

public Interface getInterface(DeviceId deviceId,
                     InterfaceId interfaceId)

Description copied from interface: DeviceService

Returns the interface requested with the device and interface ids.

Specified by:

getInterface in interface DeviceService

Parameters:

deviceId - device id

interfaceId - interface id

Returns:

requested interface, null if not found

addListener

public void addListener(DeviceListener listener)

Description copied from interface: DeviceService

Add the specified listener...

Specified by:

addListener in interface DeviceService

Parameters:

listener - listener to be added

removeListener

public void removeListener(DeviceListener listener)

Description copied from interface: DeviceService

Remove the specified listener...

Specified by:

removeListener in interface DeviceService

Parameters:

listener - listener to be removed

getListeners

public Set<DeviceListener> getListeners()

Description copied from interface: DeviceService

Returns the set of all device update listeners.

Specified by:

getListeners in interface DeviceService

Returns:

all device listeners

setName

public void setName(Device device,
           String name)

Description copied from interface: DeviceService

Assign a user provided friendly name to the device.

Specified by:

setName in interface DeviceService

Parameters:

device - to modify

name - user provided friendly name

getLinkDiscoveryVlan

public VlanId getLinkDiscoveryVlan(DeviceId deviceId)

Description copied from interface: DeviceService

Get the linkDiscoveryVlan configured for the device.

Specified by:

getLinkDiscoveryVlan in interface DeviceService

Parameters:

deviceId - containing linkDiscoveryVlan

Returns:

linkDiscoveryVlan stored for the device

setLinkDiscoveryVlan

public void setLinkDiscoveryVlan(DeviceId deviceId,
                        VlanId linkDiscoveryVlan)

Description copied from interface: DeviceService

Assign a user provided linkDiscoveryVlan to the device.

Specified by:

setLinkDiscoveryVlan in interface DeviceService

Parameters:

deviceId - to set linkDiscoveryVlan for

linkDiscoveryVlan - user provided linkDiscoveryVlan id