org.opendaylight.vtn.manager.internal.vnode

Class VTerminal

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<Vterminal>

org.opendaylight.vtn.manager.internal.vnode.VTerminal

public final class VTerminal
extends VirtualBridge<Vterminal>

VTerminal describes a configuration and runtime status for a vTerminal.

Constructor Summary

Constructors

Constructor and Description
VTerminal(BridgeIdentifier<Vterminal> vtmId) Construct a new instance.
VTerminal(BridgeIdentifier<Vterminal> vtmId, Vterminal vterm) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	destroy(TxContext ctx, boolean retain) Destroy the vTerminal.
protected PacketContext	evaluateOutputFilter(PacketContext pctx, int vid) This method does nothing because vTerminal does not have flow filter.
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) Discard the specified packet because the vTerminal does not forward any packet.
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.
VTerminalInterface	newInterface(VInterfaceIdentifier<Vterminal> ifId, Vinterface vif) Construct a new virtual interface instance associated with the interface inside this vTerminal.
VTerminalInterface	newInterface(VInterfaceIdentifier<Vterminal> ifId, VtnVinterfaceConfig vifc, VTNPortMapConfig pmap) Construct a new virtual interface instance associated with the interface inside this vTerminal.
Vterminal	resume(TxContext ctx, XmlLogger xlogger, XmlVTerminal xvtm) Resume this vTerminal.

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

broadcastInterfaces, create, destroyInterfaces, forward, getBridgeStatus, getState, hasPathFault, isFilterEmpty, match, 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

Constructor Detail

VTerminal

public VTerminal(BridgeIdentifier<Vterminal> vtmId)

Construct a new instance.

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

Parameters:

vtmId - The identifier for the vTerminal.

VTerminal

public VTerminal(BridgeIdentifier<Vterminal> vtmId,
                 Vterminal vterm)

Construct a new instance.

Parameters:

vtmId - The identifier for the vTerminal.

vterm - A Vterminal instance read from the MD-SAL datastore.

Method Detail

resume

public Vterminal resume(TxContext ctx,
                        XmlLogger xlogger,
                        XmlVTerminal xvtm)
                 throws VTNException

Resume this vTerminal.

Parameters:

ctx - MD-SAL datastore transaction context.

xlogger - A XmlLogger instance.

xvtm - A XmlVTerminal instance that contains vTerminal configuration.

Returns:

A Vterminal instance that contains vTerminal configuration and runtime status.

Throws:

VTNException - An error occurred.

newInterface

public VTerminalInterface newInterface(VInterfaceIdentifier<Vterminal> ifId,
                                       Vinterface vif)

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

Specified by:

newInterface in class VirtualBridge<Vterminal>

Parameters:

ifId - The identifier for a new virtual interface.

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

Returns:

A VTerminalInterface instance.

newInterface

public VTerminalInterface newInterface(VInterfaceIdentifier<Vterminal> ifId,
                                       VtnVinterfaceConfig vifc,
                                       VTNPortMapConfig pmap)

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

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

Specified by:

newInterface in class VirtualBridge<Vterminal>

Parameters:

ifId - The identifier for a new virtual interface.

vifc - Configuration of the virtual interface.

pmap - Port mapping configuration.

Returns:

A VTerminalInterface instance.

destroy

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

Destroy the vTerminal.

Specified by:

destroy in class VirtualBridge<Vterminal>

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<Vterminal>

Parameters:

ctx - A runtime context for transaction task.

Returns:

Always VnodeState.UNKNOWN because vTerminal has no virtual mapping.

eventReceived

protected VnodeState eventReceived(TxContext ctx,
                                   VtnNodeEvent ev)

Notify virtual mappings in this bridge of node event.

Specified by:

eventReceived in class VirtualBridge<Vterminal>

Parameters:

ctx - MD-SAL datastore transaction context.

ev - A VtnNodeEvent instance.

Returns:

Always VnodeState.UNKNOWN because vTerminal has no virtual mapping.

eventReceived

protected VnodeState eventReceived(TxContext ctx,
                                   VtnPortEvent ev)

Notify virtual mappings in this bridge of port event.

Specified by:

eventReceived in class VirtualBridge<Vterminal>

Parameters:

ctx - MD-SAL datastore transaction context.

ev - A VtnPortEvent instance.

Returns:

Always VnodeState.UNKNOWN because vTerminal has no virtual mapping.

evaluateOutputFilter

protected PacketContext evaluateOutputFilter(PacketContext pctx,
                                             int vid)

This method does nothing because vTerminal does not have flow filter.

Specified by:

evaluateOutputFilter in class VirtualBridge<Vterminal>

Parameters:

pctx - A runtime context for a received packet.

vid - Unused.

Returns:

pctx is always returned.

forward

protected void forward(PacketContext pctx,
                       VirtualMapNode vnode)

Discard the specified packet because the vTerminal does not forward any packet.

Specified by:

forward in class VirtualBridge<Vterminal>

Parameters:

pctx - A runtime context for a received packet.

vnode - A VirtualMapNode instance that maps the given packet.

getLogger

protected org.slf4j.Logger getLogger()

Return a logger instance.

Specified by:

getLogger in class VirtualElement<Vterminal,BridgeIdentifier<Vterminal>>

Returns:

A Logger instance.