etri.sdn.controller.module.devicemanager

Class Devices

java.lang.Object

etri.sdn.controller.OFModel

etri.sdn.controller.module.devicemanager.Devices

All Implemented Interfaces:

IService, IDeviceService

public class Devices
extends OFModel
implements IDeviceService

This class manages information of devices such as device map, device indices and so on.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	Devices.AttachmentPointComparator AttachmentPointComparator class compares two attachment points and returns the latest one.
private static class	Devices.DeviceUpdate A device update event to be dispatched
(package private) class	Devices.RESTAttachmentPoint Class to convert Attachment Point information into JSON format
(package private) class	Devices.RESTDevice Class to convert Device information into JSON format

Nested classes/interfaces inherited from class etri.sdn.controller.OFModel

OFModel.RESTApi, OFModel.RESTWebUI

Nested classes/interfaces inherited from interface etri.sdn.controller.module.devicemanager.IDeviceService

IDeviceService.DeviceField

Field Summary

Fields

Modifier and Type	Field and Description
Devices.AttachmentPointComparator	apComparator
private OFModel.RESTApi[]	apis Array of RESTApi objects.
IEntityClassifierService	classifier
private java.util.concurrent.ConcurrentHashMap<java.lang.Long,Device>	deviceIdToDeviceMap This is the master device map that maps device IDs to Device objects.
private long	deviceKeyCounter Counter used to generate device keys
private java.lang.Object	deviceKeyCounterLock Lock for incrementing the device key counter
private java.util.Set<IDeviceListener>	deviceListeners Device manager event listeners
private static java.util.concurrent.atomic.AtomicReference<Devices>	instanceRef
private java.util.concurrent.ConcurrentHashMap<java.util.EnumSet<IDeviceService.DeviceField>,EntityToMultiDeviceIdIndex>	multiIndices Multi indices (from an Entity to a set of device IDs)
private EntityToSingleDeviceIdIndex	primaryIndex This is the primary entity index that contains all entities.
private java.util.concurrent.ConcurrentHashMap<java.util.EnumSet<IDeviceService.DeviceField>,EntityToSingleDeviceIdIndex>	singleIndices Single Indices (from an Entity to a device id).
private java.util.Set<SwitchPort>	suppressedAPs Switch ports where attachment points shouldn't be learned
ITopologyService	topology

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Devices(ITopologyService topo, IEntityClassifierService clf) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addIndex(boolean perClass, java.util.EnumSet<IDeviceService.DeviceField> keyFields) Creates an index over a set of fields.
void	addListener(IDeviceListener listener) Adds a listener to listen for IDeviceManagerServices notifications.
void	addSuppressAPs(long swId, short port) Specifies points in the network where attachment points are not to be learned.
private boolean	allKeyFieldsPresent(Entity e, java.util.EnumSet<IDeviceService.DeviceField> keyFields) Checks if the entity e has all the keyFields set.
static Device	allocateDevice(Device device, Entity entity) Returns a new device consisting of the entities from the old device and an additional entity.
static Device	allocateDevice(java.lang.Long deviceKey, Entity entity, IEntityClass entityClass) Returns a new device.
static Device	allocateDevice(java.lang.Long deviceKey, java.util.List<AttachmentPoint> aps, java.util.List<AttachmentPoint> trueAPs, java.util.Collection<Entity> entities, IEntityClass entityClass) Returns a new device.
void	cleanupEntities(java.util.Date cutoff) Removes all entities of the device if the recent time observed is after the cutoff argument.
private void	deleteDevice(Device device) Deletes the device from deviceIdToDeviceMap and its entities.
void	deleteDevice(long datapathid) delete all device attached to a given switch.
private java.util.EnumSet<IDeviceService.DeviceField>	findChangedFields(Device device, Entity newEntity) Checks the changed IDeviceService.DeviceField of the device.
Device	findDestByEntity(IDevice source, Entity dstEntity) Gets a destination device using entity fields that corresponds with the given source device.
IDevice	findDestDevice(IDevice source, long macAddress, java.lang.Short vlan, java.lang.Integer ipv4Address) Gets a destination device using entity fields that corresponds with the given source device.
IDevice	findDevice(long macAddress, java.lang.Short vlan, java.lang.Integer ipv4Address, java.lang.Long switchDPID, java.lang.Integer switchPort) Searches for a device exactly matching the provided device fields.
private Device	findDeviceByEntity(Entity entity) Looks up a Device based on the provided Entity.
java.util.Collection<? extends IDevice>	getAllDevices() Gets an unmodifiable collection view over all devices currently known.
OFModel.RESTApi[]	getAllRestApi() Returns the list of RESTApi objects.
IDevice	getDevice(java.lang.Long deviceKey) Gets the device with the given device key.
java.util.concurrent.ConcurrentHashMap<java.lang.Long,Device>	getDeviceMap() Returns the map of device and device key.
private java.util.EnumSet<IDeviceService.DeviceField>	getEntityKeys(java.lang.Long macAddress, java.lang.Short vlan, java.lang.Integer ipv4Address, java.lang.Long switchDPID, java.lang.Integer switchPort) Returns the key fields for each argument that is not null.
java.lang.String	getHostDebugInfo() Returns information of devices that have more than one attachment point.
static Devices	getInstance() Returns the instance of Devices class
static Devices	getInstance(ITopologyService topo, IEntityClassifierService clf) Returns the instance of Devices class.
boolean	isEntityAllowed(Entity entity, IEntityClass entityClass) Is this entity is allowed?
boolean	isSuppressedAP(SwitchPort switchPort) Is the switchPort argument contained to the set of switch ports not to be learned?
boolean	isValidAttachmentPoint(long switchDPID, int switchPort) Checks whether the given attachment point is valid given the current topology.
Device	learnDeviceByEntity(Entity entity) Look up a Device based on the provided Entity.
private void	processUpdates(java.util.Queue<Devices.DeviceUpdate> updates) Sends update notifications to listeners.
java.util.Iterator<Device>	queryClassByEntity(IEntityClass clazz, java.util.EnumSet<IDeviceService.DeviceField> keyFields, Entity entity) Returns an iterator of devices that related to the entity argument.
java.util.Iterator<? extends IDevice>	queryClassDevices(IDevice reference, java.lang.Long macAddress, java.lang.Short vlan, java.lang.Integer ipv4Address, java.lang.Long switchDPID, java.lang.Integer switchPort) Finds devices that match the provided query.
java.util.Iterator<? extends IDevice>	queryDevices(java.lang.Long macAddress, java.lang.Short vlan, java.lang.Integer ipv4Address, java.lang.Long switchDPID, java.lang.Integer switchPort) Finds devices that match the provided query.
void	reclassify(java.util.Set<java.lang.String> entityClassNames) Reclassifies a devices if the device entity is null or is contained a device.
private boolean	reclassifyDevice(Device device) This method will reclassify and reconcile a device - possibilities are - create new device(s), remove entities from this device.
private void	removeEntity(Entity removed, IEntityClass entityClass, java.lang.Long deviceKey, java.util.Collection<Entity> others) Removes the device of the deviceKey argument from the single and multi indices.
void	removeSuppressAPs(long swId, short port) Removes setting of points in the network where attachment points are not to be learned.
private void	sendDeviceMovedNotification(Device d) Sends update notifications to listeners.
int	size() Returns the size of deviceIdToDeviceMap.
void	updateAttachmentPoints() Updates attachment points of the device.
private boolean	updateIndices(Device device, java.lang.Long deviceId) Updates both the primary and class indices for the provided device.
private void	updateSecondaryIndices(Entity entity, IEntityClass entityClass, java.lang.Long deviceKey) Updates the secondary indices for the given entity and associated entity classes.
private java.util.LinkedList<Devices.DeviceUpdate>	updateUpdates(java.util.LinkedList<Devices.DeviceUpdate> list, Devices.DeviceUpdate update) Inserts a new DeviceUpdate to the list of Devices.DeviceUpdates.

Methods inherited from class java.lang.Object

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

Field Detail

topology

public ITopologyService topology

classifier

public IEntityClassifierService classifier

apComparator

public Devices.AttachmentPointComparator apComparator

deviceListeners

private java.util.Set<IDeviceListener> deviceListeners

Device manager event listeners

deviceIdToDeviceMap

private java.util.concurrent.ConcurrentHashMap<java.lang.Long,Device> deviceIdToDeviceMap

This is the master device map that maps device IDs to Device objects.

deviceKeyCounter

private long deviceKeyCounter

Counter used to generate device keys

deviceKeyCounterLock

private java.lang.Object deviceKeyCounterLock

Lock for incrementing the device key counter

primaryIndex

private EntityToSingleDeviceIdIndex primaryIndex

This is the primary entity index that contains all entities.

singleIndices

private java.util.concurrent.ConcurrentHashMap<java.util.EnumSet<IDeviceService.DeviceField>,EntityToSingleDeviceIdIndex> singleIndices

Single Indices (from an Entity to a device id). One of the Indices is the primaryIndex.

multiIndices

private java.util.concurrent.ConcurrentHashMap<java.util.EnumSet<IDeviceService.DeviceField>,EntityToMultiDeviceIdIndex> multiIndices

Multi indices (from an Entity to a set of device IDs)

suppressedAPs

private java.util.Set<SwitchPort> suppressedAPs

Switch ports where attachment points shouldn't be learned

instanceRef

private static java.util.concurrent.atomic.AtomicReference<Devices> instanceRef

apis

private OFModel.RESTApi[] apis

Array of RESTApi objects. Each objects represent a REST call handler routine bound to a specific URI.

Constructor Detail

Devices

private Devices(ITopologyService topo,
       IEntityClassifierService clf)

Constructor

Parameters:

topo - the reference of topology service module

clf - the entity classifier

Method Detail

getInstance

public static Devices getInstance(ITopologyService topo,
                  IEntityClassifierService clf)

Returns the instance of Devices class. If there is no instance, creates a new instance.

Parameters:

topo - the reference of topology service module

clf - the entity classifier

Returns:

the instance of Devices class

getInstance

public static Devices getInstance()

Returns the instance of Devices class

Returns:

the instance of Devices class

isValidAttachmentPoint

public boolean isValidAttachmentPoint(long switchDPID,
                             int switchPort)

Checks whether the given attachment point is valid given the current topology.

Parameters:

switchDPID - the switch dpid

switchPort - the switch port

Returns:

true if it's a valid attachment point

allocateDevice

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

Returns a new device.

Parameters:

deviceKey - the unique identifier for this device object

entity - the initial entity for the device

entityClass - the entity classes associated with the entity

Returns:

a new device

allocateDevice

public static Device allocateDevice(java.lang.Long deviceKey,
                    java.util.List<AttachmentPoint> aps,
                    java.util.List<AttachmentPoint> trueAPs,
                    java.util.Collection<Entity> entities,
                    IEntityClass entityClass)

Returns a new device.

Parameters:

deviceKey - the unique identifier for this device object

aps - old attachment points for the device

trueAPs - current attachment points for the device

entities - the initial entities for the device

entityClass - the entity class associated with the entities

Returns:

a new device

allocateDevice

public static Device allocateDevice(Device device,
                    Entity entity)

Returns a new device consisting of the entities from the old device and an additional entity.

Parameters:

device - the old device object

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

Returns:

a new device

getDeviceMap

public java.util.concurrent.ConcurrentHashMap<java.lang.Long,Device> getDeviceMap()

Returns the map of device and device key.

Returns:

the deviceIdToDeviceMap

size

public int size()

Returns the size of deviceIdToDeviceMap.

Returns:

the number of elements in deviceIdToDeviceMap

isEntityAllowed

public boolean isEntityAllowed(Entity entity,
                      IEntityClass entityClass)

Is this entity is allowed?

Returns:

true

learnDeviceByEntity

public Device learnDeviceByEntity(Entity entity)

Look up a Device based on the provided Entity. Also learns based on the new entity, and will update existing devices as required.

Parameters:

entity - the Entity

Returns:

The Device object if found

reclassify

public void reclassify(java.util.Set<java.lang.String> entityClassNames)

Reclassifies a devices if the device entity is null or is contained a device.

Parameters:

entityClassNames - a set of device entity names

updateAttachmentPoints

public void updateAttachmentPoints()

Updates attachment points of the device.

cleanupEntities

public void cleanupEntities(java.util.Date cutoff)

Removes all entities of the device if the recent time observed is after the cutoff argument.

Parameters:

cutoff - the time of threshold to delete entities

findDestByEntity

public Device findDestByEntity(IDevice source,
                      Entity dstEntity)

Gets a destination device using entity fields that corresponds with the given source device. The source device is important since there could be ambiguity in the destination device without the attachment point information.

Parameters:

source - the source device. The returned destination will be in the same entity class as the source.

dstEntity - the entity to look up

Returns:

an Device or null if no device is found

queryClassByEntity

public java.util.Iterator<Device> queryClassByEntity(IEntityClass clazz,
                                            java.util.EnumSet<IDeviceService.DeviceField> keyFields,
                                            Entity entity)

Returns an iterator of devices that related to the entity argument.

Parameters:

clazz - the entity class for the entity

keyFields - the key field to search for

entity - the entity class to search for

Returns:

the iterator of empty set if the entity has no relation, the DeviceIdIterator otherwise

updateIndices

private boolean updateIndices(Device device,
                    java.lang.Long deviceId)

Updates both the primary and class indices for the provided device. If the update fails because of an concurrent update, will return false.

Parameters:

device - the device to update

deviceId - the device key for the device

Returns:

true if the update succeeded, false otherwise.

updateSecondaryIndices

private void updateSecondaryIndices(Entity entity,
                          IEntityClass entityClass,
                          java.lang.Long deviceKey)

Updates the secondary indices for the given entity and associated entity classes.

Parameters:

entity - the entity to update

entityClass - the entity class for the entity

deviceKey - the device key to set up

updateUpdates

private java.util.LinkedList<Devices.DeviceUpdate> updateUpdates(java.util.LinkedList<Devices.DeviceUpdate> list,
                                                       Devices.DeviceUpdate update)

Inserts a new DeviceUpdate to the list of Devices.DeviceUpdates.

Parameters:

list - the list of Devices.DeviceUpdates before update

update - the Devices.DeviceUpdate to update

Returns:

the list of Devices.DeviceUpdate

findChangedFields

private java.util.EnumSet<IDeviceService.DeviceField> findChangedFields(Device device,
                                                              Entity newEntity)

Checks the changed IDeviceService.DeviceField of the device.

Parameters:

device - the device to check its entities

newEntity - the entity to check

Returns:

the enum set of DeviceField that changed

deleteDevice

private void deleteDevice(Device device)

Deletes the device from deviceIdToDeviceMap and its entities.

Parameters:

device - the device to delete

deleteDevice

public void deleteDevice(long datapathid)

delete all device attached to a given switch.

Parameters:

datapathid - datapath id of the switch.

removeEntity

private void removeEntity(Entity removed,
                IEntityClass entityClass,
                java.lang.Long deviceKey,
                java.util.Collection<Entity> others)

Removes the device of the deviceKey argument from the single and multi indices.

Parameters:

removed - the entity to remove

entityClass - the entity class for the entity

deviceKey - the device key to remove

others - the others against which to check

reclassifyDevice

private boolean reclassifyDevice(Device device)

This method will reclassify and reconcile a device - possibilities are - create new device(s), remove entities from this device.

Parameters:

device - the device to reclassify

Returns:

true if the device entity class is changed, false otherwise

processUpdates

private void processUpdates(java.util.Queue<Devices.DeviceUpdate> updates)

Sends update notifications to listeners.

Parameters:

updates - the updates to process.

sendDeviceMovedNotification

private void sendDeviceMovedNotification(Device d)

Sends update notifications to listeners.

Parameters:

d - the device to updates

allKeyFieldsPresent

private boolean allKeyFieldsPresent(Entity e,
                          java.util.EnumSet<IDeviceService.DeviceField> keyFields)

Checks if the entity e has all the keyFields set. Returns false if not.

Parameters:

e - entity to check

keyFields - the key fields to check e against

Returns:

true if the entity argument has all the key fields, false otherwise

findDeviceByEntity

private Device findDeviceByEntity(Entity entity)

Looks up a Device based on the provided Entity. We first check the primary index. If we do not find an entry there we classify the device into its IEntityClass and query the classIndex. This implies that all key field of the current IEntityClassifierService must be present in the entity for the lookup to succeed!

Parameters:

entity - the entity to search for

Returns:

The Device object if found

getEntityKeys

private java.util.EnumSet<IDeviceService.DeviceField> getEntityKeys(java.lang.Long macAddress,
                                                          java.lang.Short vlan,
                                                          java.lang.Integer ipv4Address,
                                                          java.lang.Long switchDPID,
                                                          java.lang.Integer switchPort)

Returns the key fields for each argument that is not null.

Parameters:

macAddress - MAC address

vlan - VLAN ID

ipv4Address - IPv4 address

switchDPID - the switch dpid

switchPort - the switch port

Returns:

the enum set of key fields

getDevice

public IDevice getDevice(java.lang.Long deviceKey)

Description copied from interface: IDeviceService

Gets the device with the given device key.

Specified by:

getDevice in interface IDeviceService

Parameters:

deviceKey - the key to search for

Returns:

the device associated with the key, or null if no such device

See Also:

IDevice.getDeviceKey()

findDevice

public IDevice findDevice(long macAddress,
                 java.lang.Short vlan,
                 java.lang.Integer ipv4Address,
                 java.lang.Long switchDPID,
                 java.lang.Integer switchPort)
                   throws java.lang.IllegalArgumentException

Description copied from interface: IDeviceService

Searches for a device exactly matching the provided device fields. This is the same lookup process that is used for packet_in processing and device learning. Thus, findDevice() can be used to match flow entries from switches to devices.

Only the key fields as defined by the IEntityClassifierService will be important in this search. All key fields MUST be supplied. IDeviceService.queryDevices(java.lang.Long, java.lang.Short, java.lang.Integer, java.lang.Long, java.lang.Integer) might be more appropriate!

Specified by:

findDevice in interface IDeviceService

Parameters:

macAddress - The MAC address

vlan - the VLAN. Null means no VLAN and is valid even if VLAN is a key field.

ipv4Address - the ipv4 address

switchDPID - the switch dpid

switchPort - the switch port

Returns:

an IDevice or null if no device is found.

Throws:

java.lang.IllegalArgumentException - if not all key fields of the current IEntityClassifierService are specified.

findDestDevice

public IDevice findDestDevice(IDevice source,
                     long macAddress,
                     java.lang.Short vlan,
                     java.lang.Integer ipv4Address)
                       throws java.lang.IllegalArgumentException

Description copied from interface: IDeviceService

Gets a destination device using entity fields that corresponds with the given source device. The source device is important since there could be ambiguity in the destination device without the attachment point information.

Specified by:

findDestDevice in interface IDeviceService

Parameters:

source - the source device. The returned destination will be in the same entity class as the source.

macAddress - The MAC address for the destination

vlan - the VLAN if available

ipv4Address - The IP address if available.

Returns:

an IDevice or null if no device is found.

Throws:

java.lang.IllegalArgumentException - if not all key fields of the source's IEntityClass are specified.

See Also:

IDeviceService.findDevice(long, Short, Integer, Long, Integer)

getAllDevices

public java.util.Collection<? extends IDevice> getAllDevices()

Description copied from interface: IDeviceService

Gets an unmodifiable collection view over all devices currently known.

Specified by:

getAllDevices in interface IDeviceService

Returns:

the collection of all devices

addIndex

public void addIndex(boolean perClass,
            java.util.EnumSet<IDeviceService.DeviceField> keyFields)

Description copied from interface: IDeviceService

Creates an index over a set of fields. This allows efficient lookup of devices when querying using the indexed set of specified fields. The index must be registered before any device learning takes place, or it may be incomplete. It's OK if this is called multiple times with the same fields; only one index will be created for each unique set of fields.

Specified by:

addIndex in interface IDeviceService

Parameters:

perClass - set to true if the index should be maintained for each entity class separately.

keyFields - the set of fields on which to index

queryDevices

public java.util.Iterator<? extends IDevice> queryDevices(java.lang.Long macAddress,
                                                 java.lang.Short vlan,
                                                 java.lang.Integer ipv4Address,
                                                 java.lang.Long switchDPID,
                                                 java.lang.Integer switchPort)

Description copied from interface: IDeviceService

Finds devices that match the provided query. Any fields that are null will not be included in the query. If there is an index for the query, then it will be performed efficiently using the index. Otherwise, there will be a full scan of the device list.

Specified by:

queryDevices in interface IDeviceService

Parameters:

macAddress - The MAC address

vlan - the VLAN

ipv4Address - the ipv4 address

switchDPID - the switch dpid

switchPort - the switch port

Returns:

an iterator over a set of devices matching the query

queryClassDevices

public java.util.Iterator<? extends IDevice> queryClassDevices(IDevice reference,
                                                      java.lang.Long macAddress,
                                                      java.lang.Short vlan,
                                                      java.lang.Integer ipv4Address,
                                                      java.lang.Long switchDPID,
                                                      java.lang.Integer switchPort)

Description copied from interface: IDeviceService

Finds devices that match the provided query. Only the index for the class of the specified reference device will be searched. Any fields that are null will not be included in the query. If there is an index for the query, then it will be performed efficiently using the index. Otherwise, there will be a full scan of the device list.

Specified by:

queryClassDevices in interface IDeviceService

Parameters:

reference - The reference device to refer to when finding entity classes.

macAddress - The MAC address

vlan - the VLAN

ipv4Address - the ipv4 address

switchDPID - the switch dpid

switchPort - the switch port

Returns:

an iterator over a set of devices matching the query

addListener

public void addListener(IDeviceListener listener)

Description copied from interface: IDeviceService

Adds a listener to listen for IDeviceManagerServices notifications.

Specified by:

addListener in interface IDeviceService

Parameters:

listener - The listener that wants the notifications

addSuppressAPs

public void addSuppressAPs(long swId,
                  short port)

Description copied from interface: IDeviceService

Specifies points in the network where attachment points are not to be learned.

Specified by:

addSuppressAPs in interface IDeviceService

Parameters:

swId - a switchid

port - a port number

removeSuppressAPs

public void removeSuppressAPs(long swId,
                     short port)

Description copied from interface: IDeviceService

Removes setting of points in the network where attachment points are not to be learned.

Specified by:

removeSuppressAPs in interface IDeviceService

Parameters:

swId - a switchid

port - a port number

isSuppressedAP

public boolean isSuppressedAP(SwitchPort switchPort)

Is the switchPort argument contained to the set of switch ports not to be learned?

Parameters:

switchPort - the switch port to check

Returns:

true if suppressedAPs includes switchPort, false otherwise

getHostDebugInfo

public java.lang.String getHostDebugInfo()

Returns information of devices that have more than one attachment point. This method is used only for debugging.

Returns:

String of device list or null

getAllRestApi

public OFModel.RESTApi[] getAllRestApi()

Returns the list of RESTApi objects.

Specified by:

getAllRestApi in class OFModel

Returns:

array of all RESTApi objects