com.hp.sdn.model

Class DefaultDevice

java.lang.Object

com.hp.sdn.model.DefaultDevice

All Implemented Interfaces:

Device, Model, NetworkElement

public class DefaultDevice
extends Object
implements Device

Provides a default implementation of the Device API.

Author:

Steve Dean

Nested Class Summary

Nested classes/interfaces inherited from interface com.hp.sdn.model.NetworkElement

NetworkElement.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected DeviceInfo	deviceInfo Information about this device.
protected boolean	isOnline Indicates whether this device is online.
protected Set<URI>	managementURIs The set of URIs given by the supplier describing the mechanisms through which this device is known.

Constructor Summary

Constructors

Constructor and Description
DefaultDevice(Device device) Copy constructor Only need to static value the online value, info and uris to be saved later.
DefaultDevice(DeviceId deviceId, Set<URI> uris, DeviceInfo info, SupplierId supplierId) Constructs a device object given information.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addManagementURI(URI uri) Add a management URI to the list of possible ways to communicate with this device.
DataPathId	dpid() Returns the data path id for this device or null if the device is not an OpenFlow datapath.
boolean	equals(Object o)
String	getDeviceInfo(DeviceInfo devInfo) Provides a stringified representation of this device's device info.
int	hashCode()
DeviceId	id() Returns the device ID for this device.
DeviceInfo	info() Set of information accrued about the device through the use of device drivers.
boolean	isOnline() Indicates whether the device is presently online.
Set<URI>	managementURIs() Set of URIs that can be used to communicate with the device via device drivers.
String	name() Returns the friendly name of the network element.
Device	realizedBy() Optional reference to a device that is used to realize this one.
void	setName(String name)
void	setOnline(boolean state) Indicates that the device is on or offline.
SupplierId	supplierId() Returns the id of the supplier that provided this model entity.
String	toDebugString() Provides a little more detailed information about this object.
String	toString()
NetworkElement.Type	type() Returns the network element type, e.g.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

deviceInfo

protected DeviceInfo deviceInfo

Information about this device.

isOnline

protected boolean isOnline

Indicates whether this device is online.

managementURIs

protected Set<URI> managementURIs

The set of URIs given by the supplier describing the mechanisms through which this device is known.

Constructor Detail

DefaultDevice

public DefaultDevice(DeviceId deviceId,
             Set<URI> uris,
             DeviceInfo info,
             SupplierId supplierId)

Constructs a device object given information.

Parameters:

deviceId - Device Id

uris - for communicating with the device

info - information about the device

supplierId - who created the device

Throws:

NullPointerException - if there is no information

DefaultDevice

public DefaultDevice(Device device)

Copy constructor Only need to static value the online value, info and uris to be saved later.

Parameters:

device - to copy

Method Detail

info

public DeviceInfo info()

Description copied from interface: Device

Set of information accrued about the device through the use of device drivers.

Specified by:

info in interface Device

Returns:

DeviceInfo containing information about the device

setOnline

public void setOnline(boolean state)

Indicates that the device is on or offline.

Parameters:

state - on or offline

isOnline

public boolean isOnline()

Description copied from interface: Device

Indicates whether the device is presently online.

Specified by:

isOnline in interface Device

Returns:

true if online

dpid

public DataPathId dpid()

Description copied from interface: Device

Returns the data path id for this device or null if the device is not an OpenFlow datapath.

Specified by:

dpid in interface Device

Returns:

device dpid

realizedBy

public Device realizedBy()

Description copied from interface: Device

Optional reference to a device that is used to realize this one.

Specified by:

realizedBy in interface Device

Returns:

underlying device descriptor; null if none

addManagementURI

public boolean addManagementURI(URI uri)

Add a management URI to the list of possible ways to communicate with this device. TODO: should go in interface?

Parameters:

uri - to add to list

Returns:

true if the uri was added; false if it was already there

managementURIs

public Set<URI> managementURIs()

Description copied from interface: Device

Set of URIs that can be used to communicate with the device via device drivers.

snmp://12312313/ of://dpid/

Specified by:

managementURIs in interface Device

Returns:

set of URIs

name

public String name()

Description copied from interface: NetworkElement

Returns the friendly name of the network element.

Specified by:

name in interface NetworkElement

Returns:

name

setName

public void setName(String name)

type

public NetworkElement.Type type()

Description copied from interface: NetworkElement

Returns the network element type, e.g. switch, router, access point, NIC.

Specified by:

type in interface NetworkElement

Returns:

network element type

id

public DeviceId id()

Description copied from interface: Device

Returns the device ID for this device.

Specified by:

id in interface Device

Specified by:

id in interface NetworkElement

Returns:

device ID

supplierId

public SupplierId supplierId()

Description copied from interface: Model

Returns the id of the supplier that provided this model entity.

Specified by:

supplierId in interface Model

Returns:

supplier id

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDeviceInfo

public String getDeviceInfo(DeviceInfo devInfo)

Provides a stringified representation of this device's device info.

Parameters:

devInfo - info about the Device

Returns:

String representing devInfo

toString

public String toString()

Overrides:

toString in class Object

toDebugString

public String toDebugString()

Provides a little more detailed information about this object.

Returns:

String with debug information