net.floodlightcontroller.devicemanager
Interface IDevice

All Known Implementing Classes:
Device

public interface IDevice

Represents an independent device on the network. A device consists of a set of entities, and all the information known about a given device comes only from merging all associated entities for that device.

Author:
readams

Method Summary
 SwitchPort[] getAttachmentPoints()
          Get all unique attachment points associated with the device.
 SwitchPort[] getAttachmentPoints(boolean includeError)
          Get all unique attachment points associated with the device.
 java.lang.Long getDeviceKey()
          Get the primary key for this device.
 IEntityClass getEntityClass()
          Get the entity class for the device.
 java.lang.Integer[] getIPv4Addresses()
          Get all unique IPv4 addresses associated with the device.
 java.util.Date getLastSeen()
          Get the most recent timestamp for this device
 long getMACAddress()
          Get the MAC address of the device as a Long value.
 java.lang.String getMACAddressString()
          Get the MAC address of the device as a String value.
 SwitchPort[] getOldAP()
          Get all old attachment points associated with the device.
 java.lang.Short[] getSwitchPortVlanIds(SwitchPort swp)
          Returns all unique VLAN IDs for the device that were observed on the given switch port
 java.lang.Short[] getVlanId()
          Get all unique VLAN IDs for the device.
 

Method Detail

getDeviceKey

java.lang.Long getDeviceKey()
Get the primary key for this device.

Returns:
the primary key

getMACAddress

long getMACAddress()
Get the MAC address of the device as a Long value.

Returns:
the MAC address for the device

getMACAddressString

java.lang.String getMACAddressString()
Get the MAC address of the device as a String value.

Returns:
the MAC address for the device

getVlanId

java.lang.Short[] getVlanId()
Get all unique VLAN IDs for the device. If the device has untagged entities, then the value -1 will be returned.

Returns:
an array containing all unique VLAN IDs for the device.

getIPv4Addresses

java.lang.Integer[] getIPv4Addresses()
Get all unique IPv4 addresses associated with the device.

Returns:
an array containing the unique IPv4 addresses for the device.

getAttachmentPoints

SwitchPort[] getAttachmentPoints()
Get all unique attachment points associated with the device. This will not include any blocked attachment points.

Returns:
an array containing all unique attachment points for the device

getOldAP

SwitchPort[] getOldAP()
Get all old attachment points associated with the device. this is used in host movement scenario.

Returns:
an array containing all unique old attachment points for the device

getAttachmentPoints

SwitchPort[] getAttachmentPoints(boolean includeError)
Get all unique attachment points associated with the device.

Parameters:
includeError - whether to include blocked attachment points. Blocked attachment points should not be used for forwarding, but could be useful to show to a user
Returns:
an array containing all unique attachment points for the device

getSwitchPortVlanIds

java.lang.Short[] getSwitchPortVlanIds(SwitchPort swp)
Returns all unique VLAN IDs for the device that were observed on the given switch port

Parameters:
swp - the switch port to query
Returns:
an array containing the unique VLAN IDs

getLastSeen

java.util.Date getLastSeen()
Get the most recent timestamp for this device

Returns:
the last seen timestamp

getEntityClass

IEntityClass getEntityClass()
Get the entity class for the device.

Returns:
the entity class
See Also:
IEntityClassifierService