org.opendaylight.vtn.manager.internal.vnode

Interface VirtualMapNode

All Known Implementing Classes:

VBridgeInterface, VInterface, VTerminalInterface, VTNMacMap, VTNVlanMap

public interface VirtualMapNode

VirtualMapNode determines interfaces to be implemented by virtual node classes which map the physical network element.

Method Summary

Modifier and Type	Method and Description
void	disableInput(PacketContext pctx) Install a flow entry that drops every incoming packet.
void	filterPacket(PacketContext pctx, int vid) Evaluate flow filters for incoming packet mapped by this virtual mapping.
PacketContext	filterPacket(PacketContext pctx, int vid, VirtualBridge<?> bridge) Evaluate flow filters for outgoing packet to be transmitted by this virtual mapping.
TenantNodeIdentifier<?,?>	getIdentifier() Return the identifier for this node.
TenantNodeIdentifier<?,?>	getIdentifier(EtherAddress eaddr, int vid) Return the identifier for the virtual mapping which maps the given host.
VNodeHop	getIngressHop(EtherAddress eaddr, int vid) Return a VNodeHop instance that represents the ingress virtual node in the virtual packet route.
boolean	isEnabled() Determine whether this virtual mapping is administratively enabled or not.

Method Detail

getIdentifier

TenantNodeIdentifier<?,?> getIdentifier()

Return the identifier for this node.

Returns:

The identifier for this node.

getIdentifier

TenantNodeIdentifier<?,?> getIdentifier(EtherAddress eaddr,
                                        int vid)

Return the identifier for the virtual mapping which maps the given host.

Parameters:

eaddr - An EtherAddress instance that specifies the MAC address of the mapped host. null should be treated as if the mapped host is not specified.

vid - The VLAN ID of the mapped host.

Returns:

The identifier for the virtual network mapping.

isEnabled

boolean isEnabled()

Determine whether this virtual mapping is administratively enabled or not.

Returns:

true only if this mapping is enabled.

getIngressHop

VNodeHop getIngressHop(EtherAddress eaddr,
                       int vid)

Return a VNodeHop instance that represents the ingress virtual node in the virtual packet route.

Parameters:

eaddr - An EtherAddress instance that specifies the MAC address of the mapped host. null should be treated as if the mapped host is not specified.

vid - The VLAN ID of the mapped host.

Returns:

A VNodeHop instance.

disableInput

void disableInput(PacketContext pctx)

Install a flow entry that drops every incoming packet.

Parameters:

pctx - A runtime context for a received packet.

filterPacket

void filterPacket(PacketContext pctx,
                  int vid)
           throws DropFlowException,
                  RedirectFlowException

Evaluate flow filters for incoming packet mapped by this virtual mapping.

Parameters:

pctx - A runtime context for a received packet.

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.

Throws:

DropFlowException - The given packet was discarded by a flow filter.

RedirectFlowException - The given packet was redirected by a flow filter.

filterPacket

PacketContext filterPacket(PacketContext pctx,
                           int vid,
                           VirtualBridge<?> bridge)
                    throws DropFlowException,
                           RedirectFlowException

Evaluate flow filters for outgoing packet to be transmitted by this virtual mapping.

Parameters:

pctx - A runtime context for a received packet.

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.

bridge - A VirtualBridge instance associated with this virtual mapping.

Returns:

A PacketContext to be used for transmitting packet.

Throws:

DropFlowException - The given packet was discarded by a flow filter.

RedirectFlowException - The given packet was redirected by a flow filter.