org.opendaylight.vtn.manager.internal.vnode

Class VBridge

java.lang.Object

org.opendaylight.vtn.manager.internal.vnode.VirtualElement<T,I>

org.opendaylight.vtn.manager.internal.vnode.VirtualNode<T,BridgeIdentifier<T>>

org.opendaylight.vtn.manager.internal.vnode.VirtualBridge<Vbridge>

org.opendaylight.vtn.manager.internal.vnode.VBridge

public final class VBridge
extends VirtualBridge<Vbridge>

VBridge describes a configuration and runtime status for a vBridge.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_AGE_INTERVAL The default value for age-interval.

Constructor Summary

Constructors

Constructor and Description
VBridge(BridgeIdentifier<Vbridge> vbrId) Construct a new instance.
VBridge(BridgeIdentifier<Vbridge> vbrId, Vbridge vbr) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	destroy(TxContext ctx, boolean retain) Destroy the vBridge.
protected PacketContext	evaluateOutputFilter(PacketContext pctx, int vid) Evaluate flow filters configured in this vBridge against the given outgoing packet.
protected VnodeState	eventReceived(TxContext ctx, VtnNodeEvent ev) Notify virtual mappings in this bridge of node event.
protected VnodeState	eventReceived(TxContext ctx, VtnPortEvent ev) Notify virtual mappings in this bridge of port event.
protected void	forward(PacketContext pctx, VirtualMapNode vnode) Forward the specified packet to the virtual mapping configured in this virtual bridge.
protected org.slf4j.Logger	getLogger() Return a logger instance.
protected VnodeState	getMapState(TxContext ctx) Return the state of the virtual mapping configured to this bridge.
Vbridge	getVbridge() Return the vbridge container associated with this instance.
boolean	isFilterEmpty() Determine whether this vBridge contains no flow filter or not.
protected VirtualMapNode	match(PacketContext pctx, TenantNodeIdentifier<?,?> ref, EtherAddress eaddr, SalPort sport, int vid, boolean pktin) Return the virtual network node in this vBridge which maps the specified host.
VBridgeInterface	newInterface(VInterfaceIdentifier<Vbridge> ifId, Vinterface vif) Construct a new virtual interface instance associated with the interface inside this vBridge.
VBridgeInterface	newInterface(VInterfaceIdentifier<Vbridge> ifId, VtnVinterfaceConfig vifc, VTNPortMapConfig pmap) Construct a new virtual interface instance associated with the interface inside this vBridge.
Vbridge	resume(TxContext ctx, XmlLogger xlogger, XmlVBridge xvbr) Resume this vBridge.

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

broadcastInterfaces, create, destroyInterfaces, forward, getBridgeStatus, getState, hasPathFault, match, newBridgeStatus, newBridgeStatus, notifyNode, notifyPort, putState, putState, putState, receive, redirect, resume, routingUpdated, setInterfaceEnabled, submit, traceState, updateState, updateState, updateState

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

getFlowFilterList

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

Field Detail

DEFAULT_AGE_INTERVAL

public static final int DEFAULT_AGE_INTERVAL

The default value for age-interval.

See Also:

Constant Field Values

Constructor Detail

VBridge

public VBridge(BridgeIdentifier<Vbridge> vbrId)

Construct a new instance.

This constructor is used to resume runtime status of the virtual bridge on bootstrap.

Parameters:

vbrId - The identifier for the vBridge.

VBridge

public VBridge(BridgeIdentifier<Vbridge> vbrId,
               Vbridge vbr)

Construct a new instance.

Parameters:

vbrId - The identifier for the vBridge.

vbr - A Vbridge instance read from the MD-SAL datastore.

Method Detail

getVbridge

public Vbridge getVbridge()

Return the vbridge container associated with this instance.

Returns:

A Vbridge instance.

resume

public Vbridge resume(TxContext ctx,
                      XmlLogger xlogger,
                      XmlVBridge xvbr)
               throws VTNException

Resume this vBridge.

Parameters:

ctx - MD-SAL datastore transaction context.

xlogger - A XmlLogger instance.

xvbr - A XmlVBridge instance that contains vBridge configuration.

Returns:

A Vbridge instance that contains vBridge configuration and runtime status.

Throws:

VTNException - An error occurred.

isFilterEmpty

public boolean isFilterEmpty()

Determine whether this vBridge contains no flow filter or not.

Overrides:

isFilterEmpty in class VirtualBridge<Vbridge>

Returns:

true if this virtual bridge contains no flow filter. false otherwise.

match

protected VirtualMapNode match(PacketContext pctx,
                               TenantNodeIdentifier<?,?> ref,
                               EtherAddress eaddr,
                               SalPort sport,
                               int vid,
                               boolean pktin)
                        throws VTNException

Return the virtual network node in this vBridge which maps the specified host.

Overrides:

match in class VirtualBridge<Vbridge>

Parameters:

pctx - A runtime context for a received packet.

ref - Reference to the virtual network mapping that maps the host. Note that the specified virtual mapping must be present in this virtual bridge.

eaddr - The MAC address of the host.

sport - A SalPort instance that specifies the switch port where the host was detected.

vid - The VLAN ID associated with the specified host.

pktin - true indicates the caller is the PACKET_IN handler.

Returns:

A VirtualMapNode if the specified host is mapped to this virtual bridge. null otherwise.

Throws:

VTNException - An error occurred.

newInterface

public VBridgeInterface newInterface(VInterfaceIdentifier<Vbridge> ifId,
                                     Vinterface vif)

Construct a new virtual interface instance associated with the interface inside this vBridge.

Specified by:

newInterface in class VirtualBridge<Vbridge>

Parameters:

ifId - The identifier for a new virtual interface.

vif - A Vinterface instance read from the MD-SAL datastore.

Returns:

A VBridgeInterface instance.

newInterface

public VBridgeInterface newInterface(VInterfaceIdentifier<Vbridge> ifId,
                                     VtnVinterfaceConfig vifc,
                                     VTNPortMapConfig pmap)

Construct a new virtual interface instance associated with the interface inside this vBridge.

This method is used to resume runtime status of the virtual interface on bootstrap.

Specified by:

newInterface in class VirtualBridge<Vbridge>

Parameters:

ifId - The identifier for a new virtual interface.

vifc - Configuration of the virtual interface.

pmap - Port mapping configuration.

Returns:

A VBridgeInterface instance.

destroy

public void destroy(TxContext ctx,
                    boolean retain)
             throws VTNException

Destroy the vBridge.

Specified by:

destroy in class VirtualBridge<Vbridge>

Parameters:

ctx - MD-SAL datastore transaction context.

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

Throws:

VTNException - An error occurred.

getMapState

protected VnodeState getMapState(TxContext ctx)

Return the state of the virtual mapping configured to this bridge.

Specified by:

getMapState in class VirtualBridge<Vbridge>

Parameters:

ctx - A runtime context for transaction task.

Returns:

The state of the virtual mapping configured to this bridge.

eventReceived

protected VnodeState eventReceived(TxContext ctx,
                                   VtnNodeEvent ev)

Notify virtual mappings in this bridge of node event.

Specified by:

eventReceived in class VirtualBridge<Vbridge>

Parameters:

ctx - MD-SAL datastore transaction context.

ev - A VtnNodeEvent instance.

Returns:

The state of the virtual mapping configured to this bridge.

eventReceived

protected VnodeState eventReceived(TxContext ctx,
                                   VtnPortEvent ev)

Notify virtual mappings in this bridge of port event.

Specified by:

eventReceived in class VirtualBridge<Vbridge>

Parameters:

ctx - MD-SAL datastore transaction context.

ev - A VtnPortEvent instance.

Returns:

The state of the virtual mapping configured to this bridge.

evaluateOutputFilter

protected PacketContext evaluateOutputFilter(PacketContext pctx,
                                             int vid)
                                      throws DropFlowException,
                                             RedirectFlowException

Evaluate flow filters configured in this vBridge against the given outgoing packet.

Specified by:

evaluateOutputFilter in class VirtualBridge<Vbridge>

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.

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.

forward

protected void forward(PacketContext pctx,
                       VirtualMapNode vnode)
                throws DropFlowException,
                       RedirectFlowException,
                       VTNException

Forward the specified packet to the virtual mapping configured in this virtual bridge.

Specified by:

forward in class VirtualBridge<Vbridge>

Parameters:

pctx - A runtime context for a received packet.

vnode - A VirtualMapNode instance that maps the given packet.

Throws:

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

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<Vbridge,BridgeIdentifier<Vbridge>>

Returns:

A Logger instance.