etri.sdn.controller.module.devicemanager

Interface IDeviceService

All Superinterfaces:

IService

All Known Implementing Classes:

Devices, OFMDeviceManager

public interface IDeviceService
extends IService

The device manager allows interacting with devices on the network. Note that under normal circumstances, Device objects should be retrieved from the MessageContext.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IDeviceService.DeviceField Fields used in devices for indexes and querying

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.
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.
java.util.Collection<? extends IDevice>	getAllDevices() Gets an unmodifiable collection view over all devices currently known.
IDevice	getDevice(java.lang.Long deviceKey) Gets the device with the given device key.
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	removeSuppressAPs(long swId, short port) Removes setting of points in the network where attachment points are not to be learned.

Method Detail

getDevice

IDevice getDevice(java.lang.Long deviceKey)

Gets the device with the given device key.

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

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

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. queryDevices(java.lang.Long, java.lang.Short, java.lang.Integer, java.lang.Long, java.lang.Integer) might be more appropriate!

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

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

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.

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:

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

getAllDevices

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

Gets an unmodifiable collection view over all devices currently known.

Returns:

the collection of all devices

addIndex

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

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.

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

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. 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.

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

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. 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.

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

void addListener(IDeviceListener listener)

Adds a listener to listen for IDeviceManagerServices notifications.

Parameters:

listener - The listener that wants the notifications

addSuppressAPs

void addSuppressAPs(long swId,
                  short port)

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

Parameters:

swId - a switchid

port - a port number

removeSuppressAPs

void removeSuppressAPs(long swId,
                     short port)

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

Parameters:

swId - a switchid

port - a port number