org.opendaylight.vtn.manager.internal.vnode

Class VNodeReader

java.lang.Object

org.opendaylight.vtn.manager.internal.util.tx.AbstractPreSubmitHook

org.opendaylight.vtn.manager.internal.vnode.VNodeReader

All Implemented Interfaces:

TxHook

public final class VNodeReader
extends AbstractPreSubmitHook

Helper class to read virtual node in the VTN tree using the specified MD-SAL datastore transaction.

An instance of this class must be obtained by TxContext.getSpecific(Class).

Constructor Summary

Constructors

Constructor and Description
VNodeReader(TxContext ctx) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
VirtualBridge<?>	getBridge(TenantNodeIdentifier<?,?> ident) Return the virtual bridge that contains the specified virtual node.
int	getOrder() Return an integer that determines the order of execution.
VBridge	getVBridge(VBridgeIdentifier vbrId) Return the specified vBridge.
VTerminal	getVTerminal(VTerminalIdentifier vtmId) Return the specified vTerminal.
void	run(TxContext ctx, TxTask<?> task) Invoked when the MD-SAL datastore transaction is going to be submitted.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.tx.AbstractPreSubmitHook

getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

VNodeReader

public VNodeReader(TxContext ctx)

Construct a new instance.

Parameters:

ctx - A runtime context for transaction task.

Method Detail

getBridge

public VirtualBridge<?> getBridge(TenantNodeIdentifier<?,?> ident)
                           throws VTNException

Return the virtual bridge that contains the specified virtual node.

Parameters:

ident - A TenantNodeIdentifier instance that specifies the virtual node in the VTN.

Returns:

A VirtualBridge instance on success. null if the specified virtual bridge is not present.

Throws:

VTNException - An error occurred.

getVBridge

public VBridge getVBridge(VBridgeIdentifier vbrId)
                   throws VTNException

Return the specified vBridge.

Parameters:

vbrId - A VBridgeIdentifier instance which specifies the vBridge.

Returns:

A VBridge instance on success. null if the specified vBridge is not present.

Throws:

VTNException - An error occurred.

getVTerminal

public VTerminal getVTerminal(VTerminalIdentifier vtmId)
                       throws VTNException

Return the specified vTerminal.

Parameters:

vtmId - A VTerminalIdentifier instance which specifies the vTerminal.

Returns:

A VTerminal instance on success. null if the specified vTerminal is not present.

Throws:

VTNException - An error occurred.

run

public void run(TxContext ctx,
                TxTask<?> task)

Invoked when the MD-SAL datastore transaction is going to be submitted.

This method puts all modified virtual nodes to the transaction.

Parameters:

ctx - A runtime context for transaction task.

task - The current transaction task.

getOrder

public int getOrder()

Return an integer that determines the order of execution.

Registered hooks are executed in ascending order of order values.

Returns:

An integer that determines the order of execution.