org.opendaylight.vtn.manager.internal.vnode

Class VirtualMapRegistry<C extends MapCleaner>

java.lang.Object

org.opendaylight.vtn.manager.internal.vnode.VirtualMapRegistry<C>

Type Parameters:

C - The type of MapCleaner that purges network caches.

Direct Known Subclasses:

MacMapRegistry, PortMapRegistry, VlanMapRegistry

public abstract class VirtualMapRegistry<C extends MapCleaner>
extends Object

VirtualMapRegistry describes a base context for registering virtual network mapping.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VirtualMapRegistry(TxContext ctx) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	addMapCleaner(String tname, C cl) Associate the specified MapCleaner instance with the specified VTN name.
protected void	cleanUp() Clean up the transaction for changing virtual network mapping.
protected abstract void	cleanUpImpl(TxContext ctx) Clean up the transaction for changing virtual network mapping.
TxContext	getContext() Return the runtime context for the MD-SAL datastore transaction.
protected C	getMapCleaner(String name) Return a MapCleaner instance associated with the specified VTN.

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualMapRegistry

protected VirtualMapRegistry(TxContext ctx)

Construct a new instance.

Parameters:

ctx - A runtime context for transaction task.

Method Detail

getContext

public final TxContext getContext()

Return the runtime context for the MD-SAL datastore transaction.

Returns:

A TxContext instance.

cleanUp

protected final void cleanUp()
                      throws VTNException

Clean up the transaction for changing virtual network mapping.

Throws:

VTNException - An error occurred.

getMapCleaner

protected final C getMapCleaner(String name)

Return a MapCleaner instance associated with the specified VTN.

Parameters:

name - The name of the target VTN.

Returns:

A MapCleaner instance if found. null is returned if not found.

addMapCleaner

protected final void addMapCleaner(String tname,
                                   C cl)

Associate the specified MapCleaner instance with the specified VTN name.

Parameters:

tname - The name of the VTN.

cl - A MapCleaner instance.

cleanUpImpl

protected abstract void cleanUpImpl(TxContext ctx)
                             throws VTNException

Clean up the transaction for changing virtual network mapping.

Parameters:

ctx - A runtime context for transaction task.

Throws:

VTNException - An error occurred.