PacketContext (vtn 0.6.4-SNAPSHOT API)

java.lang.Object
- org.opendaylight.vtn.manager.internal.vnode.PacketContext

All Implemented Interfaces:

Cloneable, CachedPacketContext, PathMapContext, FlowActionContext, FlowFilterContext, FlowMatchContext, PacketHeader
```
public class PacketContext
extends Object
implements Cloneable, CachedPacketContext, PathMapContext, FlowFilterContext
```
PacketContext class describes the context of received packet.
This class is designed to be used by a single thread.

Constructor Summary

Constructors
Constructor and Description
`PacketContext(PacketInEvent ev)` Construct a new packet context to handle PACKET_IN message.
`PacketContext(TxContext ctx, Ethernet ether, SalPort ingress)` Construct a new packet context.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFilterAction(FlowFilterAction act)` Append the given flow action to the action list to be applied to packet.
`void`	`addFlow(VTNFlowBuilder builder)` Install the given data flow.
`void`	`addMatchField(FlowMatchType type)` Add a match field to be configured into a flow entry.
`void`	`addUnicastMatchFields()` Add match fields to be configured into an unicast flow entry.
`void`	`addVNodeHop(VNodeHop vhop)` Append the specified virtual node hop to the virtual packet route.
`void`	`broadcasted(RedirectFlowException rex, VNodeIdentifier<?> ident)` Invoked when the redirected unicast packet was broadcasted to the bridge.
`PacketContext`	`clone()` Return a copy of this instance.
`void`	`commit()` Commit all modifications to the packet.
`VTNFlowBuilder`	`createFlowBuilder(String tname, VTNMatch vmatch)` Create a new VTN flow builder with specifying the flow match.
`Ethernet`	`createFrame(int vlan)` Create a new ethernet frame that forwards the received packet.
`void`	`destinationDisabled(RedirectFlowException rex)` Invoked when the destination virtual interface of the packet redirection was disabled.
`void`	`destinationNotFound(RedirectFlowException rex, String msg)` Invoked when the destination virtual interface of the packet redirection was not found.
`PacketContext`	`evaluate(FlowFilterList fflist, int vid)` Evaluate the given flow filter list against the packet.
`void`	`forwarded(RedirectFlowException rex, VNodeIdentifier<?> to, SalPort sport, int vid)` Invoked when the final destination of the unicast packet redirection is determined.
`int`	`getBaseFlowPriority()` Return the base flow priority.
`EtherAddress`	`getControllerAddress()` Return the MAC address of the controller.
`String`	`getDescription()` Return a brief description of the ethernet frame in this context.
`String`	`getDescription(EtherAddress src, EtherAddress dst, int type, SalPort sport, int vid)` Create a brief description of the ethernet frame.
`String`	`getDescription(Ethernet ether, SalPort sport, int vid)` Create a brief description of the ethernet frame.
`String`	`getDescription(SalPort sport)` Create a brief description of the ethernet frame in this context.
`EtherAddress`	`getDestinationAddress()` Return the destination MAC address.
`VNodeHop`	`getEgressVNodeHop()` Return a `VNodeHop` instance which represents the virtual node hop to the egress node.
`EtherHeader`	`getEtherHeader()` Return an `EtherHeader` instance which describes an Ethernet header and IEEE 802.1Q VLAN tag.
`EtherPacket`	`getEtherPacket()` Return an `EtherPacket` instance which represents the Ethernet frame.
`Collection<FlowFilterAction>`	`getFilterActions()` Return a collection of flow actions configured by a flow filter.
`RedirectFlowException`	`getFirstRedirection()` Return a `RedirectFlowException` which represents the first packet redirection in a flow.
`VTNFlowCondition`	`getFlowCondition(VTNFlowFilter ff)` Return a `VTNFlowCondition` instance which determines whether the specified flow filter needs to be applied to the packet.
`FlowCondReader`	`getFlowCondReader()` Return the flow condition reader associated with the current MD-SAL datastore transaction.
`int`	`getFlowPriority()` Return a priority value for flow entries.
`Ethernet`	`getFrame()` Return an ethernet frame in this context.
`int`	`getHardTimeout()` Return the hard timeout for a flow entry.
`String`	`getHeaderDescription()` Return a description about protocol headers.
`int`	`getIdleTimeout()` Return the idle timeout for a flow entry.
`PortVlan`	`getIncomingNetwork()` Return a pair of switch port and VLAN ID which indicates the incoming network.
`Inet4Packet`	`getInet4Packet()` Return an `Inet4Packet` instance which represents the IPv4 packet in the payload.
`InetHeader`	`getInetHeader()` Returns an `InetHeader` instance which describes an IP header.
`SalPort`	`getIngressPort()` Return a `SalPort` instance corresponding to the ingress switch port.
`String`	`getIngressPortName()` Return the name of the ingress switch port.
`InventoryReader`	`getInventoryReader()` Return the inventory reader associated with the current MD-SAL datastoren transaction.
`L4Packet`	`getL4Packet()` Return a `L4Packet` instance which represents layer 4 protocol data.
`Layer4Header`	`getLayer4Header()` Returns a `Layer4Header` instance which describes a layer 4 protocol header.
`int`	`getMaxRedirections()` Return the maximum number of flow redirections.
`VTNManagerProvider`	`getProvider()` Return the VTN Manager provider.
`RouteResolver`	`getRouteResolver()` Return route resolver for this packet.
`Ip4Network`	`getSenderIp4Address()` Return the IPv4 address associated with the source MAC address.
`EtherAddress`	`getSourceAddress()` Return the source MAC address.
`TxContext`	`getTxContext()` Return a MD-SAL datastore transaction context.
`int`	`getVlanId()` Return VLAN ID of this packet.
`VNodeReader`	`getVNodeReader()` Return the virtual node reader associated with the current MD-SAL datastore transaction.
`boolean`	`hasMatchField(FlowMatchType type)` Determine whether the given match field will be configured in a flow entry or not.
`void`	`initPacketIn(TenantNodeIdentifier<?,?> ref)` Initialize the received packet information.
`void`	`installDropFlow()` Install a flow entry that discards the packet.
`void`	`installFlow(SalPort egress, int outVid, List<LinkEdge> path)` Install a VTN data flow for the received packet.
`boolean`	`isFilterDisabled()` Determine whether this packet should be handled without flow filters or not.
`boolean`	`isFiltered()` Determine whether at least one flow filter is evaluated with this packet or not.
`boolean`	`isFlooding()` Determine whether the packet is going to be broadcasted in the vBridge or not.
`boolean`	`isIPv4()` Determine whether this packet is an IPv4 packet or not.
`boolean`	`isToController()` Determine whether the destination address of this packet is equal to the controller address or not.
`boolean`	`isUnicast()` Determine whether this packet is an unicast packet or not.
`void`	`notMapped(RedirectFlowException rex)` Invoked when the physical switch port is not mapped to the destination virtual interface.
`void`	`probeInetAddress()` Try to probe IP address of the source address of this packet.
`boolean`	`redirect(VInterfaceIdentifier<?> path, RedirectFlowException rex)` Record the packet redirection.
`void`	`removeFilterAction(Class<? extends FlowFilterAction> actClass)` Remove the specified flow action from the flow filter action list.
`void`	`removeFlows(MacEntry ment)` Purge VTN flows relevant to the given obsolete layer 2 host.
`void`	`setEgressVNodeHop(VNodeHop vhop)` Set the virtual node hop to the egress node.
`boolean`	`setFirstRedirection(RedirectFlowException rex)` Set a `RedirectFlowException` which represents the first packet redirection in a flow.
`void`	`setFlooding(boolean b)` Set a boolean value which indicates whether the packet is going to be broadcasted in the vBridge.
`void`	`setFlowTimeout(int idle, int hard)` Set timeout for the ingress flow.
`void`	`setToController(boolean b)` Set a boolean value which indicates whether the packet is sent to the controller or not.
`void`	`setVlanId(int vid)` Set VLAN ID used for packet matching.
`void`	`transmit(SalPort egress, Packet packet)` Transmit the given packet.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PacketContext
```
public PacketContext(PacketInEvent ev)
```
    Construct a new packet context to handle PACKET_IN message.
    
    Parameters:
    
    ev - A PacketInEvent instance.
  - PacketContext
```
public PacketContext(TxContext ctx,
                     Ethernet ether,
                     SalPort ingress)
```
    Construct a new packet context.
    This constructor is only for unit test.
    
    Parameters:
    
    ctx - A runtime context for transaction task.
    
    ether - The ethernet frame.
    
    ingress - The ingress switch port.
- Method Detail
  - initPacketIn
```
public void initPacketIn(TenantNodeIdentifier<?,?> ref)
```
    Initialize the received packet information.
    
    Parameters:
    
    ref - A TenantNodeIdentifier instance that specifies the virtual mapping that maps the packet.
  - getFrame
```
public Ethernet getFrame()
```
    Return an ethernet frame in this context.
    
    Returns:
    
    An ethernet frame.
  - getEtherPacket
```
public EtherPacket getEtherPacket()
```
    Return an EtherPacket instance which represents the Ethernet frame.
    
    Returns:
    
    An EtherPacket instance.
  - getSourceAddress
```
public EtherAddress getSourceAddress()
```
    Return the source MAC address.
    
    Returns:
    
    The source MAC address.
  - getDestinationAddress
```
public EtherAddress getDestinationAddress()
```
    Return the destination MAC address.
    
    Returns:
    
    The destination MAC address.
  - getSenderIp4Address
```
public Ip4Network getSenderIp4Address()
```
    Return the IPv4 address associated with the source MAC address.
    
    Returns:
    
    An Ip4Network instance that indicates the sender IPv4 address if found. null if not found.
  - getIngressPort
```
public SalPort getIngressPort()
```
    Return a SalPort instance corresponding to the ingress switch port.
    
    Returns:
    
    A SalPort instance.
  - getIngressPortName
```
public String getIngressPortName()
                          throws VTNException
```
    Return the name of the ingress switch port.
    
    Returns:
    
    The name of the ingress switch port. null if not available.
    
    Throws:
    
    VTNException - An error occurred.
  - getIncomingNetwork
```
public PortVlan getIncomingNetwork()
```
    Return a pair of switch port and VLAN ID which indicates the incoming network.
    
    Returns:
    
    A PortVlan which indicates the incoming network where the packet was received from.
  - getVlanId
```
public int getVlanId()
```
    Return VLAN ID of this packet.
    
    Returns:
    
    VLAN ID. Zero is returned if no VLAN tag was found in the packet.
  - createFrame
```
public Ethernet createFrame(int vlan)
                     throws VTNException
```
    Create a new ethernet frame that forwards the received packet.
    
    Parameters:
    
    vlan - VLAN ID for a new frame. Zero means that the VLAN tag should not be added.
    
    Returns:
    
    A new ethernet frame.
    
    Throws:
    
    VTNException - Failed to commit packet modification.
  - removeFlows
```
public void removeFlows(MacEntry ment)
```
    Purge VTN flows relevant to the given obsolete layer 2 host.
    
    Parameters:
    
    ment - An obsolete MAC address table entry.
  - getDescription
```
public String getDescription(SalPort sport)
```
    Create a brief description of the ethernet frame in this context.
    
    Parameters:
    
    sport - A SalPort instance associated with the ethernet frame.
    
    Returns:
    
    A brief description of the ethernet frame in ths context.
  - getDescription
```
public String getDescription(Ethernet ether,
                             SalPort sport,
                             int vid)
```
    Create a brief description of the ethernet frame.
    
    Parameters:
    
    ether - An ethernet frame.
    
    sport - A SalPort instance associated with the ethernet frame.
    
    vid - VLAN ID.
    
    Returns:
    
    A brief description of the specified ethernet frame.
  - getDescription
```
public String getDescription(EtherAddress src,
                             EtherAddress dst,
                             int type,
                             SalPort sport,
                             int vid)
```
    Create a brief description of the ethernet frame.
    
    Parameters:
    
    src - The source MAC address.
    
    dst - The destination MAC address.
    
    type - The ethernet type.
    
    sport - A SalPort instance associated with the ethernet frame.
    
    vid - VLAN ID.
    
    Returns:
    
    A brief description of the specified ethernet frame.
  - getInet4Packet
```
public Inet4Packet getInet4Packet()
```
    Return an Inet4Packet instance which represents the IPv4 packet in the payload.
    
    Returns:
    
    An Inet4Packet instance if the Ethernet frame contains an IPv4 paclet. Otherwise null.
  - getL4Packet
```
public L4Packet getL4Packet()
```
    Return a L4Packet instance which represents layer 4 protocol data.
    
    Returns:
    
    A L4Packet instance if found. null if not found.
  - isIPv4
```
public boolean isIPv4()
```
    Determine whether this packet is an IPv4 packet or not.
    
    Returns:
    
    true is returned only if this packet is an IPv4 packet.
  - isUnicast
```
public boolean isUnicast()
```
    Determine whether this packet is an unicast packet or not.
    
    Returns:
    
    true is returned only if this packet is an unicast packet.
  - probeInetAddress
```
public void probeInetAddress()
```
    Try to probe IP address of the source address of this packet.
  - addVNodeHop
```
public void addVNodeHop(VNodeHop vhop)
```
    Append the specified virtual node hop to the virtual packet route.
    
    Parameters:
    
    vhop - A VNodeHop instance which represents a routing to the virtual node.
  - setEgressVNodeHop
```
public void setEgressVNodeHop(VNodeHop vhop)
```
    Set the virtual node hop to the egress node.
    
    Parameters:
    
    vhop - A VNodeHop instance which represents the hop to the egress node.
  - getEgressVNodeHop
```
public VNodeHop getEgressVNodeHop()
```
    Return a VNodeHop instance which represents the virtual node hop to the egress node.
    
    Returns:
    
    A VNodeHop instance. null is returned if not configured.
  - getRouteResolver
```
public RouteResolver getRouteResolver()
```
    Return route resolver for this packet.
    
    Returns:
    
    A RouteResolver instance.
  - getIdleTimeout
```
public int getIdleTimeout()
```
    Return the idle timeout for a flow entry.
    
    Returns:
    
    The idle timeout for a flow entry.
  - getHardTimeout
```
public int getHardTimeout()
```
    Return the hard timeout for a flow entry.
    
    Returns:
    
    The hard timeout for a flow entry.
  - getBaseFlowPriority
```
public int getBaseFlowPriority()
```
    Return the base flow priority.
    
    Returns:
    
    The base flow priority.
  - getMaxRedirections
```
public int getMaxRedirections()
```
    Return the maximum number of flow redirections.
    
    Returns:
    
    The maximum number of flow redirections.
  - getFlowPriority
```
public int getFlowPriority()
```
    Return a priority value for flow entries.
    
    Returns:
    
    A flow priority value.
  - installFlow
```
public void installFlow(SalPort egress,
                        int outVid,
                        List<LinkEdge> path)
```
    Install a VTN data flow for the received packet.
    
    Parameters:
    
    egress - A SalPort corresponding to the egress switch port.
    
    outVid - A VLAN ID to be set to the outgoing packet.
    
    path - A list of LinkEdge instances which represents packet route to the destination address of the received packet.
  - commit
```
public void commit()
            throws VTNException
```
    Commit all modifications to the packet.
    
    Throws:
    
    VTNException - Failed to copy the packet.
  - setFlooding
```
public void setFlooding(boolean b)
```
    Set a boolean value which indicates whether the packet is going to be broadcasted in the vBridge.
    
    Parameters:
    
    b - true means that the packet is going to be broadcasted in the vBridge.
  - isFilterDisabled
```
public boolean isFilterDisabled()
```
    Determine whether this packet should be handled without flow filters or not.
    
    Returns:
    
    true is returned only if flow filters should be disabled.
  - isFiltered
```
public boolean isFiltered()
```
    Determine whether at least one flow filter is evaluated with this packet or not.
    
    Returns:
    
    true only if at least one flow filter is evaluated.
  - isToController
```
public boolean isToController()
```
    Determine whether the destination address of this packet is equal to the controller address or not.
    
    Returns:
    
    true is returned if this packet is sent to the controller. Otherwise false is returned.
  - setToController
```
public void setToController(boolean b)
```
    Set a boolean value which indicates whether the packet is sent to the controller or not.
    
    Parameters:
    
    b - true means that the packet is sent to the controller. Pass false otherwise.
  - redirect
```
public boolean redirect(VInterfaceIdentifier<?> path,
                        RedirectFlowException rex)
```
    Record the packet redirection.
    
    Parameters:
    
    path - The location of the destination interface.
    
    rex - A RedirectFlowException instance that keeps information about packet redirection.
    
    Returns:
    
    true if the packet should be forwarded to the destination interface. false if the packet should be discarded.
  - getFirstRedirection
```
public RedirectFlowException getFirstRedirection()
```
    Return a RedirectFlowException which represents the first packet redirection in a flow.
    
    Returns:
    
    A RedirectFlowException instance. null is returned if the packet was not redirected.
  - getTxContext
```
public TxContext getTxContext()
```
    Return a MD-SAL datastore transaction context.
    
    Returns:
    
    A TxContext instance.
  - getControllerAddress
```
public EtherAddress getControllerAddress()
```
    Return the MAC address of the controller.
    
    Returns:
    
    An EtherAddress instance that indicates the MAC address of the controller.
  - transmit
```
public void transmit(SalPort egress,
                     Packet packet)
```
    Transmit the given packet.
    The given packet is enqueued to the packet transmission queue, and will be transmitted when the MD-SAL datastore transaction completes successfully.
    
    Parameters:
    
    egress - A SalPort instance which specifies the egress switch port.
    
    packet - A Packet instance to transmit.
  - addFlow
```
public void addFlow(VTNFlowBuilder builder)
```
    Install the given data flow.
    The given data flow is enqueued to the flow installation request queue, and it will be installed when the MD-SAL datastore transaction completes successfully.
    
    Parameters:
    
    builder - A VTNFlowBuilder instance which contains data flow to be installed.
  - getVNodeReader
```
public VNodeReader getVNodeReader()
```
    Return the virtual node reader associated with the current MD-SAL datastore transaction.
    
    Returns:
    
    A VNodeReader instance.
  - evaluate
```
public PacketContext evaluate(FlowFilterList fflist,
                              int vid)
                       throws DropFlowException,
                              RedirectFlowException
```
    Evaluate the given flow filter list against the packet.
    
    Parameters:
    
    fflist - A FlowFilterList instance.
    
    vid - A VLAN ID to be used for packet matching. A VLAN ID configured in the given packet is used if a negative value is specified.
    
    Returns:
    
    A PacketContext to be used for succeeding packet processing.
    
    Throws:
    
    DropFlowException - The given packet was discarded by a flow filter configured in this instance.
    
    RedirectFlowException - The given packet was redirected by a flow filter configured in this instance.
  - getInventoryReader
```
public InventoryReader getInventoryReader()
```
    Return the inventory reader associated with the current MD-SAL datastoren transaction.
    
    Returns:
    
    An InventoryReader instance.
  - createFlowBuilder
```
public VTNFlowBuilder createFlowBuilder(String tname,
                                        VTNMatch vmatch)
```
    Create a new VTN flow builder with specifying the flow match.
    Note that this method configures uses the base flow priority.
    
    Parameters:
    
    tname - The name of the VTN.
    
    vmatch - A VTNMatch instance.
    
    Returns:
    
    A VTNFlowBuilder instance.
  - destinationNotFound
```
public void destinationNotFound(RedirectFlowException rex,
                                String msg)
```
    Invoked when the destination virtual interface of the packet redirection was not found.
    
    Parameters:
    
    rex - A RedirectFlowException instance.
    
    msg - An error message.
  - destinationDisabled
```
public void destinationDisabled(RedirectFlowException rex)
```
    Invoked when the destination virtual interface of the packet redirection was disabled.
    
    Parameters:
    
    rex - A RedirectFlowException instance.
  - notMapped
```
public void notMapped(RedirectFlowException rex)
```
    Invoked when the physical switch port is not mapped to the destination virtual interface.
    
    Parameters:
    
    rex - A RedirectFlowException instance.
  - forwarded
```
public void forwarded(RedirectFlowException rex,
                      VNodeIdentifier<?> to,
                      SalPort sport,
                      int vid)
```
    Invoked when the final destination of the unicast packet redirection is determined.
    
    Parameters:
    
    rex - A RedirectFlowException instance.
    
    to - The identifier for the egress virtual node.
    
    sport - A SalPort corresponding to the outgoing physical switch port.
    
    vid - A VLAN ID to be set to the outgoing packet.
  - broadcasted
```
public void broadcasted(RedirectFlowException rex,
                        VNodeIdentifier<?> ident)
```
    Invoked when the redirected unicast packet was broadcasted to the bridge.
    
    Parameters:
    
    rex - A RedirectFlowException instance.
    
    ident - The identifier for the virtual node where the packet was broadcasted.
  - clone
```
public PacketContext clone()
```
    Return a copy of this instance.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    A copy of this instance.
  - addMatchField
```
public void addMatchField(FlowMatchType type)
```
    Add a match field to be configured into a flow entry.
    
    Specified by:
    
    addMatchField in interface FlowMatchContext
    
    Parameters:
    
    type - A match type to be added.
  - hasMatchField
```
public boolean hasMatchField(FlowMatchType type)
```
    Determine whether the given match field will be configured in a flow entry or not.
    
    Specified by:
    
    hasMatchField in interface FlowMatchContext
    
    Parameters:
    
    type - A match type to be tested.
    
    Returns:
    
    true only if the given match type will be configured in a flow entry.
  - addUnicastMatchFields
```
public void addUnicastMatchFields()
```
    Add match fields to be configured into an unicast flow entry.
    
    Specified by:
    
    addUnicastMatchFields in interface FlowMatchContext
  - getEtherHeader
```
public EtherHeader getEtherHeader()
```
    Return an EtherHeader instance which describes an Ethernet header and IEEE 802.1Q VLAN tag.
    
    Specified by:
    
    getEtherHeader in interface PacketHeader
    
    Returns:
    
    An EtherHeader instance.
  - getInetHeader
```
public InetHeader getInetHeader()
```
    Returns an InetHeader instance which describes an IP header.
    
    Specified by:
    
    getInetHeader in interface PacketHeader
    
    Returns:
    
    An InetHeader instance if a packet associated with this instance is an IP packet. Otherwise null.
  - getLayer4Header
```
public Layer4Header getLayer4Header()
```
    Returns a Layer4Header instance which describes a layer 4 protocol header.
    
    Specified by:
    
    getLayer4Header in interface PacketHeader
    
    Returns:
    
    An Layer4Header instance if a packet associated with this instance contains a layer 4 protocol header. Otherwise null.
  - getHeaderDescription
```
public String getHeaderDescription()
```
    Return a description about protocol headers.
    
    Specified by:
    
    getHeaderDescription in interface PacketHeader
    
    Returns:
    
    A description about protocol headers.
  - addFilterAction
```
public void addFilterAction(FlowFilterAction act)
```
    Append the given flow action to the action list to be applied to packet.
    This method is used to apply flow actions configured in a flow filter.
    
    Specified by:
    
    addFilterAction in interface FlowActionContext
    
    Parameters:
    
    act - A FlowFilterAction instance.
  - removeFilterAction
```
public void removeFilterAction(Class<? extends FlowFilterAction> actClass)
```
    Remove the specified flow action from the flow filter action list.
    
    Specified by:
    
    removeFilterAction in interface FlowActionContext
    
    Parameters:
    
    actClass - A class of flow action to be removed.
  - getFilterActions
```
public Collection<FlowFilterAction> getFilterActions()
```
    Return a collection of flow actions configured by a flow filter.
    
    Specified by:
    
    getFilterActions in interface FlowActionContext
    
    Returns:
    
    A collection of flow actions. null is returned if no flow action was created by flow filter.
  - getProvider
```
public VTNManagerProvider getProvider()
```
    Return the VTN Manager provider.
    
    Specified by:
    
    getProvider in interface PathMapContext
    
    Returns:
    
    A VTNManagerProvider instance.
  - getFlowCondReader
```
public FlowCondReader getFlowCondReader()
```
    Return the flow condition reader associated with the current MD-SAL datastore transaction.
    
    Specified by:
    
    getFlowCondReader in interface PathMapContext
    
    Returns:
    
    A FlowCondReader instance.
  - setFlowTimeout
```
public void setFlowTimeout(int idle,
                           int hard)
```
    Set timeout for the ingress flow.
    
    Specified by:
    
    setFlowTimeout in interface PathMapContext
    
    Parameters:
    
    idle - An idle timeout for the ingress flow.
    
    hard - A hard timeout for the ingress flow.
  - getDescription
```
public String getDescription()
```
    Return a brief description of the ethernet frame in this context.
    
    Specified by:
    
    getDescription in interface PathMapContext
    
    Specified by:
    
    getDescription in interface FlowFilterContext
    
    Returns:
    
    A brief description of the ethernet frame in ths context.
  - isFlooding
```
public boolean isFlooding()
```
    Determine whether the packet is going to be broadcasted in the vBridge or not.
    
    Specified by:
    
    isFlooding in interface FlowFilterContext
    
    Returns:
    
    true is returned only if the packet is going to be broadcasted in the vBridge.
  - setVlanId
```
public void setVlanId(int vid)
```
    Set VLAN ID used for packet matching.
    
    Specified by:
    
    setVlanId in interface FlowFilterContext
    
    Parameters:
    
    vid - A VLAN ID.
  - installDropFlow
```
public void installDropFlow()
```
    Install a flow entry that discards the packet.
    
    Specified by:
    
    installDropFlow in interface FlowFilterContext
  - getFlowCondition
```
public VTNFlowCondition getFlowCondition(VTNFlowFilter ff)
                                  throws UnsupportedPacketException
```
    Return a VTNFlowCondition instance which determines whether the specified flow filter needs to be applied to the packet.
    Note that this method also checks whether this flow filter supports the given packet or not.
    
    Specified by:
    
    getFlowCondition in interface FlowFilterContext
    
    Parameters:
    
    ff - A VTNFlowFilter instance.
    
    Returns:
    
    A VTNFlowCondition instance which selects the packet.
    
    Throws:
    
    UnsupportedPacketException - The specified flow filter does not support the given packet.
  - setFirstRedirection
```
public boolean setFirstRedirection(RedirectFlowException rex)
```
    Set a RedirectFlowException which represents the first packet redirection in a flow.
    
    Specified by:
    
    setFirstRedirection in interface FlowFilterContext
    
    Parameters:
    
    rex - An RedirectFlowException instance.
    
    Returns:
    
    true if the given instance represents the first packet redirection in a flow. false otherwise.

Class PacketContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PacketContext

PacketContext

Method Detail

initPacketIn

getFrame

getEtherPacket

getSourceAddress

getDestinationAddress

getSenderIp4Address

getIngressPort

getIngressPortName

getIncomingNetwork

getVlanId

createFrame

removeFlows

getDescription

getDescription

getDescription

getInet4Packet

getL4Packet

isIPv4

isUnicast

probeInetAddress

addVNodeHop

setEgressVNodeHop

getEgressVNodeHop

getRouteResolver

getIdleTimeout

getHardTimeout

getBaseFlowPriority

getMaxRedirections

getFlowPriority

installFlow

commit

setFlooding

isFilterDisabled

isFiltered

isToController

setToController

redirect

getFirstRedirection

getTxContext

getControllerAddress

transmit

addFlow

getVNodeReader

evaluate

getInventoryReader

createFlowBuilder

destinationNotFound

destinationDisabled

notMapped

forwarded

broadcasted

clone

addMatchField

hasMatchField

addUnicastMatchFields

getEtherHeader

getInetHeader

getLayer4Header

getHeaderDescription

addFilterAction

removeFilterAction

getFilterActions

getProvider

getFlowCondReader

setFlowTimeout

getDescription

isFlooding

setVlanId

installDropFlow

getFlowCondition

setFirstRedirection