org.openflow.protocol.factory

Class BasicFactory

java.lang.Object

org.openflow.protocol.factory.BasicFactory

All Implemented Interfaces:

OFActionFactory, OFMessageFactory, OFStatisticsFactory, OFVendorDataFactory

Direct Known Subclasses:

OVXMessageFactory

public class BasicFactory
extends Object
implements OFMessageFactory, OFActionFactory, OFStatisticsFactory, OFVendorDataFactory

A basic OpenFlow factory that supports naive creation of both Messages and Actions.

Author:

David Erickson (daviderickson@cs.stanford.edu), Rob Sherwood (rob.sherwood@stanford.edu)

Field Summary

Fields

Modifier and Type	Field and Description
protected static BasicFactory	instance

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static String	dumpBuffer(org.jboss.netty.buffer.ChannelBuffer data)
OFAction	getAction(OFActionType t) Retrieves an OFAction instance corresponding to the specified OFActionType
OFActionFactory	getActionFactory() Retrieves an OFActionFactory
static BasicFactory	getInstance()
OFMessage	getMessage(OFType t) create and return a new instance of a message for OFType t.
OFStatistics	getStatistics(OFType t, OFStatisticsType st) Retrieves an OFStatistics instance corresponding to the specified OFStatisticsType
OFVendorData	getVendorData(OFVendorId vendorId, OFVendorDataType vendorDataType) Retrieves an OFVendorData instance corresponding to the specified OFVendorId and OFVendorDataType.
List<OFAction>	parseActions(org.jboss.netty.buffer.ChannelBuffer data, int length) Attempts to parse and return all OFActions contained in the given ByteBuffer, beginning at the ByteBuffer's position, and ending at position+length.
List<OFAction>	parseActions(org.jboss.netty.buffer.ChannelBuffer data, int length, int limit) Attempts to parse and return all OFActions contained in the given ByteBuffer, beginning at the ByteBuffer's position, and ending at position+length.
List<OFMessage>	parseMessage(org.jboss.netty.buffer.ChannelBuffer data) Attempts to parse and return a OFMessages contained in the given ChannelBuffer, beginning at the ChannelBuffer's position, and ending at the after the first parsed message
OFMessage	parseMessageOne(org.jboss.netty.buffer.ChannelBuffer data)
List<OFStatistics>	parseStatistics(OFType t, OFStatisticsType st, org.jboss.netty.buffer.ChannelBuffer data, int length) Attempts to parse and return all OFStatistics contained in the given ByteBuffer, beginning at the ByteBuffer's position, and ending at position+length.
List<OFStatistics>	parseStatistics(OFType t, OFStatisticsType st, org.jboss.netty.buffer.ChannelBuffer data, int length, int limit) Attempts to parse and return all OFStatistics contained in the given ByteBuffer, beginning at the ByteBuffer's position, and ending at position+length.
OFVendorData	parseVendorData(int vendor, org.jboss.netty.buffer.ChannelBuffer data, int length) Attempts to parse and return the OFVendorData contained in the given ChannelBuffer, beginning right after the vendor id.

Methods inherited from class java.lang.Object

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

Field Detail

instance

protected static BasicFactory instance

Constructor Detail

BasicFactory

protected BasicFactory()

Method Detail

getInstance

public static BasicFactory getInstance()

getMessage

public OFMessage getMessage(OFType t)

create and return a new instance of a message for OFType t. Also injects factories for those message types that implement the *FactoryAware interfaces.

Specified by:

getMessage in interface OFMessageFactory

Parameters:

t - the type of the OFMessage to be retrieved

Returns:

a newly created instance that may be modified / used freely by the caller

parseMessage

public List<OFMessage> parseMessage(org.jboss.netty.buffer.ChannelBuffer data)
                             throws MessageParseException

Description copied from interface: OFMessageFactory

Attempts to parse and return a OFMessages contained in the given ChannelBuffer, beginning at the ChannelBuffer's position, and ending at the after the first parsed message

Specified by:

parseMessage in interface OFMessageFactory

Parameters:

data - the ChannelBuffer to parse for an OpenFlow message

Returns:

a list of OFMessage instances

Throws:

MessageParseException

parseMessageOne

public OFMessage parseMessageOne(org.jboss.netty.buffer.ChannelBuffer data)
                          throws MessageParseException

Throws:

MessageParseException

getAction

public OFAction getAction(OFActionType t)

Description copied from interface: OFActionFactory

Retrieves an OFAction instance corresponding to the specified OFActionType

Specified by:

getAction in interface OFActionFactory

Parameters:

t - the type of the OFAction to be retrieved

Returns:

an OFAction instance

parseActions

public List<OFAction> parseActions(org.jboss.netty.buffer.ChannelBuffer data,
                          int length)

Description copied from interface: OFActionFactory

Attempts to parse and return all OFActions contained in the given ByteBuffer, beginning at the ByteBuffer's position, and ending at position+length.

Specified by:

parseActions in interface OFActionFactory

Parameters:

data - the ChannelBuffer to parse for OpenFlow actions

length - the number of Bytes to examine for OpenFlow actions

Returns:

a list of OFAction instances

parseActions

public List<OFAction> parseActions(org.jboss.netty.buffer.ChannelBuffer data,
                          int length,
                          int limit)

Description copied from interface: OFActionFactory

Attempts to parse and return all OFActions contained in the given ByteBuffer, beginning at the ByteBuffer's position, and ending at position+length.

Specified by:

parseActions in interface OFActionFactory

Parameters:

data - the ChannelBuffer to parse for OpenFlow actions

length - the number of Bytes to examine for OpenFlow actions

limit - the maximum number of messages to return, 0 means no limit

Returns:

a list of OFAction instances

getActionFactory

public OFActionFactory getActionFactory()

Description copied from interface: OFMessageFactory

Retrieves an OFActionFactory

Specified by:

getActionFactory in interface OFMessageFactory

Returns:

an OFActionFactory

getStatistics

public OFStatistics getStatistics(OFType t,
                         OFStatisticsType st)

Description copied from interface: OFStatisticsFactory

Retrieves an OFStatistics instance corresponding to the specified OFStatisticsType

Specified by:

getStatistics in interface OFStatisticsFactory

Parameters:

t - the type of the containing OFMessage, only accepts statistics request or reply

st - the type of the OFStatistics to be retrieved

Returns:

an OFStatistics instance

parseStatistics

public List<OFStatistics> parseStatistics(OFType t,
                                 OFStatisticsType st,
                                 org.jboss.netty.buffer.ChannelBuffer data,
                                 int length)

Description copied from interface: OFStatisticsFactory

Attempts to parse and return all OFStatistics contained in the given ByteBuffer, beginning at the ByteBuffer's position, and ending at position+length.

Specified by:

parseStatistics in interface OFStatisticsFactory

Parameters:

t - the type of the containing OFMessage, only accepts statistics request or reply

st - the type of the OFStatistics to be retrieved

data - the ChannelBuffer to parse for OpenFlow Statistics

length - the number of Bytes to examine for OpenFlow Statistics

Returns:

a list of OFStatistics instances

parseStatistics

public List<OFStatistics> parseStatistics(OFType t,
                                 OFStatisticsType st,
                                 org.jboss.netty.buffer.ChannelBuffer data,
                                 int length,
                                 int limit)

Description copied from interface: OFStatisticsFactory

Attempts to parse and return all OFStatistics contained in the given ByteBuffer, beginning at the ByteBuffer's position, and ending at position+length.

Specified by:

parseStatistics in interface OFStatisticsFactory

Parameters:

t - OFMessage type: should be one of stats_request or stats_reply

st - statistics type of this message, e.g., DESC, TABLE

data - buffer to read from

length - length of statistics

limit - number of statistics to grab; 0 == all

Returns:

list of statistics

getVendorData

public OFVendorData getVendorData(OFVendorId vendorId,
                         OFVendorDataType vendorDataType)

Description copied from interface: OFVendorDataFactory

Retrieves an OFVendorData instance corresponding to the specified OFVendorId and OFVendorDataType. There are 3 possible cases for how this will be called: 1) If the vendor id in the OFVendor message is an unknown value, then this method is called with both vendorId and vendorDataType set to null. In this case typically the factory method should return an instance of OFGenericVendorData that just contains the raw byte array of the vendor data. 2) If the vendor id is known but no vendor data type has been registered for the data in the message, then vendorId is set to the appropriate OFVendorId instance and OFVendorDataType is set to null. This would typically be handled the same way as #1 3) If both the vendor id and and vendor data type are known, then typically you'd just call the method in OFVendorDataType to instantiate the appropriate subclass of OFVendorData.

Specified by:

getVendorData in interface OFVendorDataFactory

Parameters:

vendorId - the vendorId of the containing OFVendor message

vendorDataType - the type of the OFVendorData to be retrieved

Returns:

an OFVendorData instance

parseVendorData

public OFVendorData parseVendorData(int vendor,
                           org.jboss.netty.buffer.ChannelBuffer data,
                           int length)

Attempts to parse and return the OFVendorData contained in the given ChannelBuffer, beginning right after the vendor id.

Specified by:

parseVendorData in interface OFVendorDataFactory

Parameters:

vendor - the vendor id that was parsed from the OFVendor message.

data - the ChannelBuffer from which to parse the vendor data

length - the length to the end of the enclosing message.

Returns:

an OFVendorData instance

dumpBuffer

public static String dumpBuffer(org.jboss.netty.buffer.ChannelBuffer data)