etri.sdn.controller

Class OFModule

java.lang.Object

etri.sdn.controller.OFModule

Direct Known Subclasses:

ForwardingBase, Hub, OFMDefaultEntityClassifier, OFMDeviceManager, OFMFirewall, OFMLearningMac, OFMLearningMac10, OFMLearningMac13, OFMLinkDiscovery, OFMStateManager, OFMStorageManager, OFMTopologyManager, OFMUserInterface

public abstract class OFModule
extends java.lang.Object

This abstract class is mother of all Torpedo modules. OFModule represents a reusable unit in defining a custom controller.

Author:

bjlee

Field Summary

Fields

Modifier and Type	Field and Description
protected IOFHandler	controller reference to the controller implementation.
private java.util.concurrent.ConcurrentMap<org.openflow.protocol.interfaces.OFMessageType,OFMFilter>	filters private map that holds filters for OFMessage objects for this module.
private static java.util.concurrent.ConcurrentMap<java.lang.Class<? extends IService>,OFModule>	modules static map that holds all the references to module instances.

Constructor Summary

Constructors

Constructor and Description
OFModule()

Method Summary

Methods

Modifier and Type	Method and Description
IOFHandler	getController() returns the controller that this modules is attached.
abstract OFModel[]	getModels() returns the array of all OFModel objects associated with this module.
static OFModule	getModule(java.lang.Class<? extends IService> c) return a module that implements a specific service from the static map modules.
protected abstract boolean	handleDisconnect(Connection conn) Process the disconnection event from a switch.
protected abstract boolean	handleHandshakedEvent(Connection conn, MessageContext context) An abstract method that all subclasses should implement.
protected abstract 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.
void	init(IOFHandler ctrl) initialize module.
protected abstract void	initialize() method that initializes this module.
boolean	processDisconnect(Connection conn) Process the disconnection event from a switch.
boolean	processHandshakeFinished(Connection conn, MessageContext context) This method is called after FEATURE-REQUEST and FEATUER-REPLY is correctly exchanged.
boolean	processMessage(Connection conn, MessageContext context, org.openflow.protocol.OFMessage msg, java.util.List<org.openflow.protocol.OFMessage> outgoing) Handle incoming messages and return the processing result.
void	registerFilter(org.openflow.protocol.interfaces.OFMessageType messageType, OFMFilter filter) register a filter that only selects messages that matches the condition described by the OFMFilter object.
static void	registerModule(java.lang.Class<? extends IService> c, OFModule m) register a module to the static map modules.

Methods inherited from class java.lang.Object

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

Field Detail

modules

private static java.util.concurrent.ConcurrentMap<java.lang.Class<? extends IService>,OFModule> modules

static map that holds all the references to module instances.

filters

private java.util.concurrent.ConcurrentMap<org.openflow.protocol.interfaces.OFMessageType,OFMFilter> filters

private map that holds filters for OFMessage objects for this module.

controller

protected IOFHandler controller

reference to the controller implementation.

Constructor Detail

OFModule

public OFModule()

Method Detail

registerModule

public static void registerModule(java.lang.Class<? extends IService> c,
                  OFModule m)

register a module to the static map modules.

Parameters:

c - represents a service that the module implements

m - the module instance

getModule

public static OFModule getModule(java.lang.Class<? extends IService> c)

return a module that implements a specific service from the static map modules.

Parameters:

c - class of the service that this module implements

Returns:

OFModule object

registerFilter

public void registerFilter(org.openflow.protocol.interfaces.OFMessageType messageType,
                  OFMFilter filter)

register a filter that only selects messages that matches the condition described by the OFMFilter object.

Parameters:

messageType - type of the OFMessage that the filter applies

filter - a filter object to be applied to OFMessage objects

init

public final void init(IOFHandler ctrl)

initialize module. This method is called by OFController.init().

Parameters:

ctrl - reference to the controller implementation

getController

public IOFHandler getController()

returns the controller that this modules is attached.

Returns:

reference to the controller implementation

initialize

protected abstract void initialize()

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

processHandshakeFinished

public boolean processHandshakeFinished(Connection conn,
                               MessageContext context)

This method is called after FEATURE-REQUEST and FEATUER-REPLY is correctly exchanged. This method only calls handleHandshakedEvent(Connection, MessageContext), which is an abstract method that all subclasses should implement.

Parameters:

conn - connection on which the handshaking is done

context - message context for the handshaking messages

Returns:

false when there is an critical error which prevents the successful operation of this module.

handleHandshakedEvent

protected abstract boolean handleHandshakedEvent(Connection conn,
                            MessageContext context)

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

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.

processMessage

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

Handle incoming messages and return the processing result. This method first applies filters for the message type to find out the message needs to be processed by this module. if the answer is yes, the message is passed to handleMessage(Connection, MessageContext, OFMessage, List).

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

Returns:

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

handleMessage

protected abstract 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. All subclasses of OFModule must implement this method. This method is called by processMessage(Connection, MessageContext, OFMessage, List).

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.

processDisconnect

public boolean processDisconnect(Connection conn)

Process the disconnection event from a switch. This method calls handleDisconnect(Connection) callback.

Parameters:

conn - connection that the event has occurred

Returns:

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

handleDisconnect

protected abstract boolean handleDisconnect(Connection conn)

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

Parameters:

conn - connection that the event has occurred

Returns:

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

getModels

public abstract OFModel[] getModels()

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

Returns:

the array of OFModel objects