org.opendaylight.vtn.manager.internal.vnode

Class MacMapStatusReader

java.lang.Object

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

org.opendaylight.vtn.manager.internal.vnode.MacMapStatusReader

All Implemented Interfaces:

TxHook

public final class MacMapStatusReader
extends AbstractPreSubmitHook

Helper class to read runtime information of MAC mapping 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
MacMapStatusReader(TxContext ctx) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	clear() Discard all the cached instances.
VTNMacMapStatus	get(MacMapIdentifier ident) Return the runtime status of the given MAC mapping.
VTNMacMapStatus	getCached(MacMapIdentifier ident) Return the runtime status of the given MAC mapping only if it is cached in this instance.
int	getOrder() Return an integer that determines the order of execution.
VTNMacMapStatus	put(MacMapIdentifier ident, VTNMacMapStatus vmst) Put the given MAC mapping status only if not cached.
VTNMacMapStatus	remove(MacMapIdentifier ident) Discard the status information about the specified MAC mapping.
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

MacMapStatusReader

public MacMapStatusReader(TxContext ctx)

Construct a new instance.

Parameters:

ctx - A runtime context for transaction task.

Method Detail

get

public VTNMacMapStatus get(MacMapIdentifier ident)
                    throws VTNException

Return the runtime status of the given MAC mapping.

Parameters:

ident - A MacMapIdentifier instance that specifies the target MAC mapping.

Returns:

A VTNMacMapStatus instance.

Throws:

VTNException - An error occurred.

getCached

public VTNMacMapStatus getCached(MacMapIdentifier ident)

Return the runtime status of the given MAC mapping only if it is cached in this instance.

Parameters:

ident - A MacMapIdentifier instance that specifies the target MAC mapping.

Returns:

A VTNMacMapStatus instance if the status of the specified MAC mapping is cached in this instance. null if not cached.

put

public VTNMacMapStatus put(MacMapIdentifier ident,
                           VTNMacMapStatus vmst)

Put the given MAC mapping status only if not cached.

Parameters:

ident - A MacMapIdentifier instance that specifies the target MAC mapping.

vmst - A VTNMacMapStatus instance that represents the status of the MAC mapping specified by ident.

Returns:

A VTNMacMapStatus instance actually cached in this instance.

remove

public VTNMacMapStatus remove(MacMapIdentifier ident)

Discard the status information about the specified MAC mapping.

Parameters:

ident - A MacMapIdentifier instance that specifies the target MAC mapping.

Returns:

If actually removed, the removed VTNMacMapStatus instance is returned. null is returned if the status information for the specified MAC mapping is not present in this instance.

clear

public void clear()

Discard all the cached instances.

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 MAC mapping status 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.