etri.sdn.controller.module.devicemanager

Class OFMDefaultEntityClassifier

java.lang.Object

etri.sdn.controller.OFModule

etri.sdn.controller.module.devicemanager.OFMDefaultEntityClassifier

All Implemented Interfaces:

IService, IEntityClassifierService

public final class OFMDefaultEntityClassifier
extends OFModule
implements IEntityClassifierService

This is a default entity classifier that simply classifies all entities into a fixed entity class, with key fields of MAC and VLAN.

Author:

readams

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	OFMDefaultEntityClassifier.DefaultEntityClass A default fixed entity class

Field Summary

Fields

Modifier and Type	Field and Description
private static OFMDefaultEntityClassifier.DefaultEntityClass	entityClass
private static java.util.EnumSet<IDeviceService.DeviceField>	keyFields

Fields inherited from class etri.sdn.controller.OFModule

controller

Constructor Summary

Constructors

Constructor and Description
OFMDefaultEntityClassifier()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(IEntityClassListener listener) Adds a listener to listen for IEntityClassifierServices notifications
IEntityClass	classifyEntity(Entity entity) This choose a proper IEntityClass object to which the entity belongs.
void	deviceUpdate(IDevice oldDevice, java.util.Collection<? extends IDevice> newDevices) Once reclassification is complete for a device, this method will be called.
java.util.EnumSet<IDeviceService.DeviceField>	getKeyFields() Returns the primary key-fields to classify entities.
OFModel[]	getModels() returns the array of all OFModel objects associated with this module.
protected boolean	handleDisconnect(Connection conn) Process the disconnection event from a switch.
protected boolean	handleHandshakedEvent(Connection conn, MessageContext context) An abstract method that all subclasses should implement.
protected boolean	handleMessage(Connection conn, MessageContext context, org.openflow.protocol.OFMessage msg, java.util.List<org.openflow.protocol.OFMessage> outgoing) Handle incoming messages that pass the test of filters.
protected void	initialize() method that initializes this module.
IEntityClass	reclassifyEntity(IDevice curDevice, Entity entity) Reclassifies the given entity into a class.

Methods inherited from class etri.sdn.controller.OFModule

getController, getModule, init, processDisconnect, processHandshakeFinished, processMessage, registerFilter, registerModule

Methods inherited from class java.lang.Object

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

Field Detail

keyFields

private static java.util.EnumSet<IDeviceService.DeviceField> keyFields

entityClass

private static OFMDefaultEntityClassifier.DefaultEntityClass entityClass

Constructor Detail

OFMDefaultEntityClassifier

public OFMDefaultEntityClassifier()

Method Detail

classifyEntity

public IEntityClass classifyEntity(Entity entity)

This choose a proper IEntityClass object to which the entity belongs.

Specified by:

classifyEntity in interface IEntityClassifierService

Parameters:

entity - entity to classify

Returns:

an IEntityClass object

See Also:

IEntityClassifierService.getKeyFields()

reclassifyEntity

public IEntityClass reclassifyEntity(IDevice curDevice,
                            Entity entity)

Description copied from interface: IEntityClassifierService

Reclassifies the given entity into a class. When reclassifying entities, it can be helpful to take into account the current classification either as an optimization or to allow flushing any cached state tied to the key for that device. The entity will be assigned to a new device with a new object if the entity class returned is different from the entity class for curDevice.

Note that you must take steps to ensure you always return classes in some consistent ordering.

Specified by:

reclassifyEntity in interface IEntityClassifierService

Parameters:

curDevice - the device currently associated with the entity

entity - the entity to reclassify

Returns:

the IEntityClass resulting from the classification

deviceUpdate

public void deviceUpdate(IDevice oldDevice,
                java.util.Collection<? extends IDevice> newDevices)

Description copied from interface: IEntityClassifierService

Once reclassification is complete for a device, this method will be called. If any entities within the device changed their classification, it will split into one or more new devices for each of the entities. If two devices are merged because of a reclassification, then this will be called on each of the devices, with the same device in the newDevices collection.

Specified by:

deviceUpdate in interface IEntityClassifierService

Parameters:

oldDevice - the original device object

newDevices - all the new devices derived from the entities of the old device. If null, the old device was unchanged.

getKeyFields

public java.util.EnumSet<IDeviceService.DeviceField> getKeyFields()

Returns the primary key-fields to classify entities.

Specified by:

getKeyFields in interface IEntityClassifierService

Returns:

a set containing the fields that should not be wildcarded. May be null to indicate that all fields are key fields.

See Also:

IEntityClass.getKeyFields(), IEntityClassifierService.classifyEntity(Entity entity)

addListener

public void addListener(IEntityClassListener listener)

Description copied from interface: IEntityClassifierService

Adds a listener to listen for IEntityClassifierServices notifications

Specified by:

addListener in interface IEntityClassifierService

Parameters:

listener - The listener that wants the notifications

initialize

protected void initialize()

Description copied from class: OFModule

method that initializes this module. Subclass of OFModule must implement this method. You can find the example of this method in OFMLinkDiscovery.initialize().

Specified by:

initialize in class OFModule

handleHandshakedEvent

protected boolean handleHandshakedEvent(Connection conn,
                            MessageContext context)

Description copied from class: OFModule

An abstract method that all subclasses should implement. This method is called after FEATURE-REQUEST and FEATURE-REPLY is correct exchanged, by OFModule.processHandshakeFinished(Connection, MessageContext). Normally, most of modules have very simple implementation for this method, only returning true.

Specified by:

handleHandshakedEvent in class OFModule

Parameters:

conn - connection that the event has occurred

context - message context for the handshaking messages

Returns:

true is returned when the event has been correctly processed. false otherwise.

handleMessage

protected boolean handleMessage(Connection conn,
                    MessageContext context,
                    org.openflow.protocol.OFMessage msg,
                    java.util.List<org.openflow.protocol.OFMessage> outgoing)

Description copied from class: OFModule

Handle incoming messages that pass the test of filters. All subclasses of OFModule must implement this method. This method is called by OFModule.processMessage(Connection, MessageContext, OFMessage, List).

Specified by:

handleMessage in class OFModule

Parameters:

conn - connection that the message has arrived

context - message context for the message

msg - the actual message object

outgoing - responses for the message arrived, which is filled by the handleMessage implementation

Returns:

true if the message has been correctly processed. false otherwise.

handleDisconnect

protected boolean handleDisconnect(Connection conn)

Description copied from class: OFModule

Process the disconnection event from a switch. This callback method is called by OFModule.processDisconnect(Connection). All subclasses of OFModule should implement this method.

Specified by:

handleDisconnect in class OFModule

Parameters:

conn - connection that the event has occurred

Returns:

true if the event has been correctly processed. false otherwise.

getModels

public OFModel[] getModels()

Description copied from class: OFModule

returns the array of all OFModel objects associated with this module. Normally the size of the array is one, but not limited to.

Specified by:

getModels in class OFModule

Returns:

the array of OFModel objects