etri.sdn.controller

Class MessageContext

java.lang.Object

etri.sdn.controller.MessageContext

public final class MessageContext
extends java.lang.Object

This is a context object where listeners can register and later retrieve context information associated with an event. The MessageContext object is created one per each OFMessage received from a switch. Originally, this was FloodlightContext in Floodlight.

Author:

readams, bjlee

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DST_DEVICE a predefined key to find the destination device for the current packet-in, if applicable.
static java.lang.String	ETHER_PAYLOAD a predefined key for the Ethernet payload.
static java.lang.String	ROUTING_DECISION a predefined key for the Routing Decisions.
static java.lang.String	SRC_DEVICE a predefined key to find the source device for the current packet-in, if applicable.
private java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Object>	storage Internal representation of the message context storage.

Constructor Summary

Constructors

Constructor and Description
MessageContext()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	get(java.lang.String key) retrieve an object saved with the given key
java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Object>	getStorage() Return the actual storage associated with the message context.
void	put(java.lang.String key, java.lang.Object value) Put something in the message context with given key.

Methods inherited from class java.lang.Object

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

Field Detail

storage

private java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Object> storage

Internal representation of the message context storage.

ETHER_PAYLOAD

public static final java.lang.String ETHER_PAYLOAD

a predefined key for the Ethernet payload.

See Also:

Constant Field Values

ROUTING_DECISION

public static final java.lang.String ROUTING_DECISION

a predefined key for the Routing Decisions.

See Also:

Constant Field Values

SRC_DEVICE

public static final java.lang.String SRC_DEVICE

a predefined key to find the source device for the current packet-in, if applicable.

See Also:

Constant Field Values

DST_DEVICE

public static final java.lang.String DST_DEVICE

a predefined key to find the destination device for the current packet-in, if applicable.

See Also:

Constant Field Values

Constructor Detail

MessageContext

public MessageContext()

Method Detail

getStorage

public java.util.concurrent.ConcurrentHashMap<java.lang.String,java.lang.Object> getStorage()

Return the actual storage associated with the message context. With put() and get() method, this method should be rarely used.

Returns:

the actual storage object associated with the message context

get

public java.lang.Object get(java.lang.String key)

retrieve an object saved with the given key

Parameters:

key - value that uniquely identifies an item saved in the message context

Returns:

Object saved in the storage

put

public void put(java.lang.String key,
       java.lang.Object value)

Put something in the message context with given key.

Parameters:

key - value that uniquely identifies an item saved in the message context

value - value that is saved in the message context