etri.sdn.controller.module.devicemanager

Class Device

java.lang.Object

etri.sdn.controller.module.devicemanager.Device

All Implemented Interfaces:

IDevice

public class Device
extends java.lang.Object
implements IDevice

Concrete implementation of IDevice. This class defines a device.

Author:

readams

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.CopyOnWriteArrayList<AttachmentPoint>	attachmentPoints The current attachment points for the device.
protected java.lang.Long	deviceKey
protected Entity[]	entities
protected IEntityClass	entityClass
(package private) static java.util.EnumSet<IDeviceService.DeviceField>	ipv4Fields
protected java.lang.String	macAddressString
protected java.util.concurrent.CopyOnWriteArrayList<AttachmentPoint>	oldAPs The old attachment points for the device that were valid no more than INACTIVITY_TIME ago.

Constructor Summary

Constructors

Modifier	Constructor and Description
	Device(Device device, Entity newEntity) Constructs a new device consisting of the entities from the old device plus an additional entity.
	Device(java.lang.Long deviceKey, java.util.Collection<AttachmentPoint> oldAPs, java.util.Collection<AttachmentPoint> attachmentPoints, java.util.Collection<Entity> entities, IEntityClass entityClass) Creates a device from a set of entities.
private	Device(java.lang.Long deviceKey, Entity entity, IEntityClass entityClass, java.util.Collection<AttachmentPoint> attachmentPoints) Creates a device from an entities.

Method Summary

Methods

Modifier and Type	Method and Description
static Device	allocateDevice(java.lang.Long deviceKey, Entity entity, IEntityClass entityClass)
boolean	deleteAttachmentPoint(long sw) Deletes attachment points of the given switch from the list of attachment points and oldAPs.
boolean	deleteAttachmentPoint(long sw, short port) Deletes (sw,port) from the list of list of attachment points and oldAPs.
protected int	entityIndex(Entity entity) Checks whether the device contains the specified entity.
boolean	equals(java.lang.Object obj)
private java.util.Map<java.lang.Long,AttachmentPoint>	getAPMap(java.util.List<AttachmentPoint> apList) Given a list of attachment points, the procedure would return a map of attachment points for each L2 domain.
SwitchPort[]	getAttachmentPoints() Gets all unique attachment points associated with the device.
SwitchPort[]	getAttachmentPoints(boolean includeError) Gets all unique attachment points associated with the device.
java.lang.Long	getDeviceKey() Gets the primary key for this device.
private java.util.List<AttachmentPoint>	getDuplicateAttachmentPoints(java.util.List<AttachmentPoint> oldAPList, java.util.Map<java.lang.Long,AttachmentPoint> apMap) Gets a list of duplicate attachment points, given a list of old attachment points and one attachment point per L2 domain.
Entity[]	getEntities()
IEntityClass	getEntityClass() Gets the entity class for the device.
java.lang.Integer[]	getIPv4Addresses() Gets all unique IPv4 addresses associated with the device.
java.util.Date	getLastSeen() Gets the most recent timestamp for this device.
long	getMACAddress() Gets the MAC address of the device as a Long value.
java.lang.String	getMACAddressString() Gets the MAC address of the device as a String value.
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() Gets all unique VLAN IDs for the device.
int	hashCode()
private boolean	removeExpiredAttachmentPoints(java.util.List<AttachmentPoint> apList) Removes all attachment points that are older than AttachmentPoint.INACTIVITY_INTERVAL from the list.
java.lang.String	toString()
protected boolean	updateAttachmentPoint() Updates the known attachment points.
boolean	updateAttachmentPoint(long sw, short port, long lastSeen) Updates the list of attachment points given that a new packetin was seen from (sw, port) at time (lastSeen).

Methods inherited from class java.lang.Object

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

Field Detail

deviceKey

protected final java.lang.Long deviceKey

entities

protected final Entity[] entities

entityClass

protected final IEntityClass entityClass

macAddressString

protected final java.lang.String macAddressString

oldAPs

protected final java.util.concurrent.CopyOnWriteArrayList<AttachmentPoint> oldAPs

The old attachment points for the device that were valid no more than INACTIVITY_TIME ago.

attachmentPoints

protected final java.util.concurrent.CopyOnWriteArrayList<AttachmentPoint> attachmentPoints

The current attachment points for the device.

ipv4Fields

static final java.util.EnumSet<IDeviceService.DeviceField> ipv4Fields

Constructor Detail

Device

private Device(java.lang.Long deviceKey,
      Entity entity,
      IEntityClass entityClass,
      java.util.Collection<AttachmentPoint> attachmentPoints)

Creates a device from an entities.

Parameters:

deviceKey - the unique identifier for this device object

entity - the initial entity for the device

entityClass - the entity classes associated with the entity

Device

public Device(java.lang.Long deviceKey,
      java.util.Collection<AttachmentPoint> oldAPs,
      java.util.Collection<AttachmentPoint> attachmentPoints,
      java.util.Collection<Entity> entities,
      IEntityClass entityClass)

Creates a device from a set of entities.

Parameters:

deviceKey - the unique identifier for this device object

oldAPs - old attachment points for the device

attachmentPoints - current attachment points for the device

entities - the initial entities for the device

entityClass - the entity class associated with the entities

Device

public Device(Device device,
      Entity newEntity)

Constructs a new device consisting of the entities from the old device plus an additional entity.

Parameters:

device - the old device object

newEntity - the entity to add. newEntity must be have the same entity class as device

Method Detail

allocateDevice

public static Device allocateDevice(java.lang.Long deviceKey,
                    Entity entity,
                    IEntityClass entityClass)

getAPMap

private java.util.Map<java.lang.Long,AttachmentPoint> getAPMap(java.util.List<AttachmentPoint> apList)

Given a list of attachment points, the procedure would return a map of attachment points for each L2 domain. L2 domain id is the key.

Parameters:

apList - a list of attachment points

Returns:

a map of attachment points for each L2 domain

removeExpiredAttachmentPoints

private boolean removeExpiredAttachmentPoints(java.util.List<AttachmentPoint> apList)

Removes all attachment points that are older than AttachmentPoint.INACTIVITY_INTERVAL from the list.

Parameters:

apList - the list of attachment points

Returns:

true if removed more than one attachment point, false otherwise

getDuplicateAttachmentPoints

private java.util.List<AttachmentPoint> getDuplicateAttachmentPoints(java.util.List<AttachmentPoint> oldAPList,
                                                           java.util.Map<java.lang.Long,AttachmentPoint> apMap)

Gets a list of duplicate attachment points, given a list of old attachment points and one attachment point per L2 domain. Given a true attachment point in the L2 domain, say trueAP, another attachment point in the same L2 domain, say ap, is duplicate if

1. ap is inconsistent with trueAP, and
2. active time of ap is after that of trueAP; and
3. last seen time of ap is within the last AttachmentPoint.INACTIVITY_INTERVAL

Parameters:

oldAPList - a list of old attachment points

apMap - a map of attachment points for each L2 domain

Returns:

a list of duplicated attachment points

updateAttachmentPoint

protected boolean updateAttachmentPoint()

Updates the known attachment points. This method is called whenever topology changes.

Returns:

true if there is any change to the list of attachment points -- which indicates a possible device move

updateAttachmentPoint

public boolean updateAttachmentPoint(long sw,
                            short port,
                            long lastSeen)

Updates the list of attachment points given that a new packetin was seen from (sw, port) at time (lastSeen).

Parameters:

sw - the switch that received packetin

port - the switch port that received packetin

lastSeen - the timestamp we observed on the network

Returns:

true if there was any change to the list of attachment points for the device -- which indicates a device move

deleteAttachmentPoint

public boolean deleteAttachmentPoint(long sw,
                            short port)

Deletes (sw,port) from the list of list of attachment points and oldAPs.

Parameters:

sw - a switch to delete

port - a switch port to delete

Returns:

true if deleted more than one attachment point, false otherwise

deleteAttachmentPoint

public boolean deleteAttachmentPoint(long sw)

Deletes attachment points of the given switch from the list of attachment points and oldAPs.

Parameters:

sw - a switch to delete

Returns:

true if deleted more than one attachment point, false otherwise

getAttachmentPoints

public SwitchPort[] getAttachmentPoints()

Description copied from interface: IDevice

Gets all unique attachment points associated with the device. This will not include any blocked attachment points.

Specified by:

getAttachmentPoints in interface IDevice

Returns:

an array containing all unique attachment points for the device

getAttachmentPoints

public SwitchPort[] getAttachmentPoints(boolean includeError)

Description copied from interface: IDevice

Gets all unique attachment points associated with the device.

Specified by:

getAttachmentPoints in interface IDevice

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

getDeviceKey

public java.lang.Long getDeviceKey()

Description copied from interface: IDevice

Gets the primary key for this device.

Specified by:

getDeviceKey in interface IDevice

Returns:

the primary key

getMACAddress

public long getMACAddress()

Description copied from interface: IDevice

Gets the MAC address of the device as a Long value.

Specified by:

getMACAddress in interface IDevice

Returns:

the MAC address for the device

getMACAddressString

public java.lang.String getMACAddressString()

Description copied from interface: IDevice

Gets the MAC address of the device as a String value.

Specified by:

getMACAddressString in interface IDevice

Returns:

the MAC address for the device

getVlanId

public java.lang.Short[] getVlanId()

Description copied from interface: IDevice

Gets all unique VLAN IDs for the device. If the device has untagged entities, then the value -1 will be returned.

Specified by:

getVlanId in interface IDevice

Returns:

an array containing all unique VLAN IDs for the device

getIPv4Addresses

public java.lang.Integer[] getIPv4Addresses()

Description copied from interface: IDevice

Gets all unique IPv4 addresses associated with the device.

Specified by:

getIPv4Addresses in interface IDevice

Returns:

an array containing the unique IPv4 addresses for the device

getSwitchPortVlanIds

public java.lang.Short[] getSwitchPortVlanIds(SwitchPort swp)

Description copied from interface: IDevice

Returns all unique VLAN IDs for the device that were observed on the given switch port.

Specified by:

getSwitchPortVlanIds in interface IDevice

Parameters:

swp - the switch port to query

Returns:

an array containing the unique VLAN IDs

getLastSeen

public java.util.Date getLastSeen()

Description copied from interface: IDevice

Gets the most recent timestamp for this device.

Specified by:

getLastSeen in interface IDevice

Returns:

the last seen timestamp

getEntityClass

public IEntityClass getEntityClass()

Description copied from interface: IDevice

Gets the entity class for the device.

Specified by:

getEntityClass in interface IDevice

Returns:

the entity class

See Also:

IEntityClassifierService

getEntities

public Entity[] getEntities()

entityIndex

protected int entityIndex(Entity entity)

Checks whether the device contains the specified entity.

Parameters:

entity - the entity to search for

Returns:

the index of the entity, or <0 if not found

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object