com.hp.of.ctl.pkt

Class TestMessageContext

java.lang.Object

com.hp.of.ctl.pkt.TestMessageContext

All Implemented Interfaces:

MessageContext

public class TestMessageContext
extends Object
implements MessageContext

A test message context implementation, available to facilitate unit testing implementations of SequencedPacketListener (SPL).

Note that this implementation allows access to the PacketOut API whereas in the production code this will be restricted to only those SPLs that register as a Director.

Also note that a constructor is provided that takes an OfmPacketIn argument. Internally, this is wrapped in a mock message event. This will hopefully reduce the amount of unnecessary boiler-plate code required to set up the mock context.

Author:

Simon Hunt

Field Summary

Fields

Modifier and Type	Field and Description
static DataPathId	DPID A test datapath ID, used by default.

Constructor Summary

Constructors

Constructor and Description
TestMessageContext(MessageEvent srcEvent) Constructs the message context for the given PacketIn message event.
TestMessageContext(OfmPacketIn packetIn) Constructs the message context for the given PacketIn message, by wrapping the message in a mock event, using the default datapath ID.
TestMessageContext(OfmPacketIn packetIn, DataPathId dpid) Constructs the message context for the given PacketIn message, by wrapping the message in a mock event, using the supplied datapath ID.

Method Summary

Methods

Modifier and Type	Method and Description
MessageContext	addHint(Hint hint) Adds a hint to the context.
Packet	decodedPacket() Returns the decoded packet data generated by the Network Packet Library facility.
boolean	failedToSend() This flag is set in the unlikely event that the packet sequencer failed to send the PacketOut message via the controller.
OfmPacketOut	getCompletedPacketOut() Returns the PacketOut message that was sent back to the source datapath.
List<Hint>	getHints() Returns the hints contained in this context, in the order they were added by the Advisors.
OfmPacketIn	getPacketIn() Convenience method that returns the PacketIn message from the message event.
List<ProtocolId>	getProtocols() Returns an ordered list of protocols decoded from the packet.
ProtocolVersion	getVersion() Returns the protocol version of the associated PacketIn message event.
boolean	isBlocked() Returns true if response (packet-out message) to the associated message event has been blocked.
boolean	isHandled() Returns true if the associated message event has already been handled.
boolean	isSent() Returns true if response (packet-out message) to the associated message event has been sent.
boolean	isTestPacket() Returns true if the associated packet has been determined to be a diagnostic test packet.
PacketOut	packetOut() Returns the API for manipulating the PacketOut message.
boolean	requiresProcessing() Returns true if the associated packet is not a test packet, and has not yet been blocked or sent and thus continues to require processing.
TestMessageContext	setDecodedPacket(Packet packet) Replaces the "decoded" packet with the given instance.
MessageEvent	srcEvent() Returns the associated PacketIn message event.
String	toDebugString() Returns a multi-line string representation of this message context, suitable for debugging.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DPID

public static final DataPathId DPID

A test datapath ID, used by default.

Constructor Detail

TestMessageContext

public TestMessageContext(OfmPacketIn packetIn)

Constructs the message context for the given PacketIn message, by wrapping the message in a mock event, using the default datapath ID.

Parameters:

packetIn - the source message

TestMessageContext

public TestMessageContext(OfmPacketIn packetIn,
                  DataPathId dpid)

Constructs the message context for the given PacketIn message, by wrapping the message in a mock event, using the supplied datapath ID.

Parameters:

packetIn - the source message

dpid - the source datapath ID

TestMessageContext

public TestMessageContext(MessageEvent srcEvent)

Constructs the message context for the given PacketIn message event.

Parameters:

srcEvent - the source message event

Method Detail

setDecodedPacket

public TestMessageContext setDecodedPacket(Packet packet)

Replaces the "decoded" packet with the given instance. Allows unit tests to supply their own mock packet data, rather than relying on the decoded packet data from the PacketIn message.

Parameters:

packet - the packet to set

Returns:

self, for chaining

toString

public String toString()

Overrides:

toString in class Object

toDebugString

public String toDebugString()

Description copied from interface: MessageContext

Returns a multi-line string representation of this message context, suitable for debugging.

Specified by:

toDebugString in interface MessageContext

Returns:

a multi-line string representation

srcEvent

public MessageEvent srcEvent()

Description copied from interface: MessageContext

Returns the associated PacketIn message event.

Specified by:

srcEvent in interface MessageContext

Returns:

the PacketIn message event

getVersion

public ProtocolVersion getVersion()

Description copied from interface: MessageContext

Returns the protocol version of the associated PacketIn message event.

Specified by:

getVersion in interface MessageContext

Returns:

the protocol version

getPacketIn

public OfmPacketIn getPacketIn()

Description copied from interface: MessageContext

Convenience method that returns the PacketIn message from the message event.

Specified by:

getPacketIn in interface MessageContext

Returns:

the PacketIn message

decodedPacket

public Packet decodedPacket()

Description copied from interface: MessageContext

Returns the decoded packet data generated by the Network Packet Library facility. This will be null if there is no packet data associated with the PacketIn message.

Specified by:

decodedPacket in interface MessageContext

Returns:

the decoded packet data

getProtocols

public List<ProtocolId> getProtocols()

Description copied from interface: MessageContext

Returns an ordered list of protocols decoded from the packet. The protocols are ordered from outermost to innermost layer. This will be null if there is no packet data associated with the PacketIn message.

Specified by:

getProtocols in interface MessageContext

Returns:

the list of protocols

isHandled

public boolean isHandled()

Description copied from interface: MessageContext

Returns true if the associated message event has already been handled. That is, either blocked or sent.

Specified by:

isHandled in interface MessageContext

Returns:

true if handled; false otherwise

isBlocked

public boolean isBlocked()

Description copied from interface: MessageContext

Returns true if response (packet-out message) to the associated message event has been blocked.

Specified by:

isBlocked in interface MessageContext

Returns:

true if blocked; false otherwise

isSent

public boolean isSent()

Description copied from interface: MessageContext

Returns true if response (packet-out message) to the associated message event has been sent.

Specified by:

isSent in interface MessageContext

Returns:

true if sent; false otherwise

isTestPacket

public boolean isTestPacket()

Description copied from interface: MessageContext

Returns true if the associated packet has been determined to be a diagnostic test packet.

Specified by:

isTestPacket in interface MessageContext

Returns:

true if a diagnostic test packet; false otherwise

requiresProcessing

public boolean requiresProcessing()

Description copied from interface: MessageContext

Returns true if the associated packet is not a test packet, and has not yet been blocked or sent and thus continues to require processing.

Specified by:

requiresProcessing in interface MessageContext

Returns:

true if not a test packet, not blocked, and not sent

failedToSend

public boolean failedToSend()

Description copied from interface: MessageContext

This flag is set in the unlikely event that the packet sequencer failed to send the PacketOut message via the controller.

Specified by:

failedToSend in interface MessageContext

Returns:

true if an error occurred during send

packetOut

public PacketOut packetOut()

Description copied from interface: MessageContext

Returns the API for manipulating the PacketOut message.

Specified by:

packetOut in interface MessageContext

Returns:

the packet out API

getCompletedPacketOut

public OfmPacketOut getCompletedPacketOut()

Description copied from interface: MessageContext

Returns the PacketOut message that was sent back to the source datapath. Note that this method will return null if the PacketOut message has not yet been sent.

Specified by:

getCompletedPacketOut in interface MessageContext

Returns:

the PacketOut message

addHint

public MessageContext addHint(Hint hint)

Description copied from interface: MessageContext

Adds a hint to the context.

Specified by:

addHint in interface MessageContext

Parameters:

hint - the hint to be added

Returns:

self, for chaining

getHints

public List<Hint> getHints()

Description copied from interface: MessageContext

Returns the hints contained in this context, in the order they were added by the Advisors.

Specified by:

getHints in interface MessageContext

Returns:

the hints