org.opendaylight.vtn.manager.internal.vnode

Class VTNVlanMap

java.lang.Object

org.opendaylight.vtn.manager.internal.vnode.VirtualElement<VlanMap,VlanMapIdentifier>

org.opendaylight.vtn.manager.internal.vnode.VTNVlanMap

All Implemented Interfaces:

VirtualMapNode

public final class VTNVlanMap
extends VirtualElement<VlanMap,VlanMapIdentifier>
implements VirtualMapNode

VTNVlanMap describes a configuration and runtime status for a VLAN mapping.

Constructor Summary

Constructors

Constructor and Description
VTNVlanMap(BridgeIdentifier<Vbridge> vbrId, VlanMap vlmap) Construct a new instance.
VTNVlanMap(BridgeIdentifier<Vbridge> vbrId, VTNVlanMapConfig vmc) Construct a new instance.
VTNVlanMap(VlanMapIdentifier vmapId, VlanMap vlmap) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
static boolean	checkNode(TxContext ctx, SalNode snode) Determine whether the given node is suitable for the VLAN mapping or not.
void	destroy(TxContext ctx, boolean retain) Destroy the VLAN mapping.
void	disableInput(PacketContext pctx) This method does nothing.
void	filterPacket(PacketContext pctx, int vid) This method does nothing.
PacketContext	filterPacket(PacketContext pctx, int vid, VirtualBridge<?> bridge) Evaluate flow filters for outgoing packet to be transmitted by this VLAN mapping.
VlanMapIdentifier	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 indicates the packet was mapped by the VLAN mapping.
protected org.slf4j.Logger	getLogger() Return a logger instance.
String	getMapId() Return the mapping identifier assigned to this VLAN mapping.
VnodeState	getState() Return the state of this VLAN mapping.
VlanMap	getVlanMap() Return the VLAN mapping container.
VlanMapStatus	getVlanMapStatus() Return the runtime status information of the VLAN mapping.
boolean	isEnabled() Determine whether this VLAN mapping is administravely enabled or not.
VnodeState	notifyNode(TxContext ctx, VtnNodeEvent ev) Invoked when a physical switch is added, removed, or changed.
VnodeState	notifyPort(TxContext ctx, VtnPortEvent ev) Invoked when a physical switch port is added, removed, or changed.
VnodeState	register(TxContext ctx, boolean purge) Register the VLAN mapping.
VnodeState	resume(TxContext ctx, List<VlanMap> list) Resume the VLAN mapping.
void	submit(TxContext ctx) Submit runtime status changes to the MD-SAL datastore.
void	transmit(PacketContext pctx, VBridge vbr, Set<PortVlan> sent) Transmit the given packet to the physical network mapped by this VLAN mapping.

Methods inherited from class org.opendaylight.vtn.manager.internal.vnode.VirtualElement

getIdentifier, getInitialValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.vtn.manager.internal.vnode.VirtualMapNode

getIdentifier

Constructor Detail

VTNVlanMap

public VTNVlanMap(BridgeIdentifier<Vbridge> vbrId,
                  VTNVlanMapConfig vmc)

Construct a new instance.

Parameters:

vbrId - The identifier for a vBridge that contains this VLAN mapping.

vmc - VLAN mapping configuration.

VTNVlanMap

public VTNVlanMap(BridgeIdentifier<Vbridge> vbrId,
                  VlanMap vlmap)

Construct a new instance.

Parameters:

vbrId - The identifier for a vBridge that contains this VLAN mapping.

vlmap - A VlanMap instance read from the MD-SAL datastore.

VTNVlanMap

public VTNVlanMap(VlanMapIdentifier vmapId,
                  VlanMap vlmap)

Construct a new instance.

Parameters:

vmapId - The identifier for the VLAN mapping.

vlmap - A VlanMap instance.

Method Detail

checkNode

public static boolean checkNode(TxContext ctx,
                                SalNode snode)
                         throws VTNException

Determine whether the given node is suitable for the VLAN mapping or not.

Parameters:

ctx - A runtime context for MD-SAL datastore transaction task.

snode - A SalNode instance which specifies the node to be tested. null means that all the switches are targeted.

Returns:

true is returned only if the given node is valid.

Throws:

VTNException - An error occurred.

getMapId

public String getMapId()

Return the mapping identifier assigned to this VLAN mapping.

Returns:

A mapping identifier assigned to this VLAN mapping.

getState

public VnodeState getState()

Return the state of this VLAN mapping.

Returns:

VnodeState.UP if this VLAN mapping is active. VnodeState.DOWN otherwise.

getVlanMap

public VlanMap getVlanMap()

Return the VLAN mapping container.

Returns:

A VlanMap instance.

getVlanMapStatus

public VlanMapStatus getVlanMapStatus()

Return the runtime status information of the VLAN mapping.

Returns:

A VlanMapStatus instance.

register

public VnodeState register(TxContext ctx,
                           boolean purge)
                    throws VTNException

Register the VLAN mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

purge - If true, this method purges obsolete network caches as appropriate.

Returns:

VnodeState.UP if this VLAN mapping has been activated. VnodeState#DOWN otherwise.

Throws:

VTNException - An error occurred.

resume

public VnodeState resume(TxContext ctx,
                         List<VlanMap> list)

Resume the VLAN mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

list - A list of VlanMap instances to store resumed VLAN mapping.

Returns:

A VnodeState instance on success. null on failure.

submit

public void submit(TxContext ctx)

Submit runtime status changes to the MD-SAL datastore.

Parameters:

ctx - MD-SAL datastore transaction context.

destroy

public void destroy(TxContext ctx,
                    boolean retain)

Destroy the VLAN mapping.

Parameters:

ctx - MD-SAL datastore transaction context.

retain - true means that the parent vBridge will be retained. false means that the parent vBridge is being destroyed.

notifyNode

public VnodeState notifyNode(TxContext ctx,
                             VtnNodeEvent ev)

Invoked when a physical switch is added, removed, or changed.

Parameters:

ctx - MD-SAL datastore transaction context.

ev - A VtnNodeEvent instance.

Returns:

New state of this VLAN mapping.

notifyPort

public VnodeState notifyPort(TxContext ctx,
                             VtnPortEvent ev)

Invoked when a physical switch port is added, removed, or changed.

Parameters:

ctx - MD-SAL datastore transaction context.

ev - A VtnPortEvent instance.

Returns:

New state of this virtual interface.

transmit

public void transmit(PacketContext pctx,
                     VBridge vbr,
                     Set<PortVlan> sent)
              throws RedirectFlowException,
                     VTNException

Transmit the given packet to the physical network mapped by this VLAN mapping.

Parameters:

pctx - A runtime context for a received packet.

vbr - A VBridge instance that contains this VLAN mapping.

sent - A set of PortVlan which indicates the network already processed.

Throws:

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

VTNException - An error occurred.

getLogger

protected org.slf4j.Logger getLogger()

Return a logger instance.

Specified by:

getLogger in class VirtualElement<VlanMap,VlanMapIdentifier>

Returns:

A Logger instance.

getIdentifier

public VlanMapIdentifier getIdentifier(EtherAddress eaddr,
                                       int vid)

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

This method always returns the identifier for this VLAN mapping because VLAN mapping does not specifies the host to be mapped.

Specified by:

getIdentifier in interface VirtualMapNode

Parameters:

eaddr - Unused.

vid - Unused.

Returns:

The identifier for the VLAN mapping.

isEnabled

public boolean isEnabled()

Determine whether this VLAN mapping is administravely enabled or not.

Specified by:

isEnabled in interface VirtualMapNode

Returns:

Always true because the VLAN mapping cannot be disabled administratively.

getIngressHop

public VNodeHop getIngressHop(EtherAddress eaddr,
                              int vid)

Return a VNodeHop instance that indicates the packet was mapped by the VLAN mapping.

Specified by:

getIngressHop in interface VirtualMapNode

Parameters:

eaddr - Unused.

vid - Unused.

Returns:

A VNodeHop instance.

disableInput

public void disableInput(PacketContext pctx)

This method does nothing.

Specified by:

disableInput in interface VirtualMapNode

Parameters:

pctx - Unused.

filterPacket

public void filterPacket(PacketContext pctx,
                         int vid)

This method does nothing.

The input filters configured in the vBridge should be evaluated by VBridge.

Specified by:

filterPacket in interface VirtualMapNode

Parameters:

pctx - Unused.

vid - Unused.

filterPacket

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

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

Specified by:

filterPacket in interface VirtualMapNode

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.