org.opendaylight.vtn.manager.internal.inventory

Class VTNInventoryManager

java.lang.Object

org.opendaylight.vtn.manager.internal.util.CloseableContainer

org.opendaylight.vtn.manager.internal.util.AbstractDataChangeListener<T,C>

org.opendaylight.vtn.manager.internal.util.MultiDataStoreListener<VtnNode,org.opendaylight.vtn.manager.internal.inventory.InventoryEvents>

org.opendaylight.vtn.manager.internal.inventory.VTNInventoryManager

All Implemented Interfaces:

AutoCloseable, EventListener, org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener<VtnNode>

public final class VTNInventoryManager
extends MultiDataStoreListener<VtnNode,org.opendaylight.vtn.manager.internal.inventory.InventoryEvents>

Internal inventory manager.

Constructor Summary

Constructors

Constructor and Description
VTNInventoryManager(VTNManagerProvider provider) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
void	addListener(VTNInventoryListener l) Add the given VTN inventory listener.
void	close() Close the VTN inventory service.
protected org.opendaylight.vtn.manager.internal.inventory.InventoryEvents	enterEvent() Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) has just been called.
protected void	exitEvent(org.opendaylight.vtn.manager.internal.inventory.InventoryEvents ectx) Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) is going to leave.
protected org.slf4j.Logger	getLogger() Return a logger instance.
VtnNodeManager	getVtnNodeManager() Return the VTN node manager.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnNode>	getWildcardPath() Return a wildcard instance identifier that specifies data objects to be listened.
protected boolean	isDepth(VtnUpdateType type) Return a boolean value which specifies the order of tree traversal.
protected boolean	isLeafNode(Class<?> type) Determine whether the specified type of the tree node should be treated as a leaf node.
protected boolean	isRequiredType(Class<?> type) Determine whether the specified type of the tree node is required to be notified or not.
protected boolean	isUpdated(org.opendaylight.vtn.manager.internal.inventory.InventoryEvents ectx, ChangedData<?> data) Determine whether the specified data was updated or not.
StaticTopologyManager	newStaticTopologyManager() Create a new static network topology manager.
protected void	onCreated(org.opendaylight.vtn.manager.internal.inventory.InventoryEvents ectx, IdentifiedData<?> data) Invoked when a new data has been created in the datastore.
protected void	onRemoved(org.opendaylight.vtn.manager.internal.inventory.InventoryEvents ectx, IdentifiedData<?> data) Invoked when a data has been removed from the datastore.
protected void	onUpdated(org.opendaylight.vtn.manager.internal.inventory.InventoryEvents ectx, ChangedData<?> data) Invoked when a data in the datastore has been updated.
void	shutdown() Shutdown listener service.
void	start() Start the inventory service.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.MultiDataStoreListener

handleTree

Methods inherited from class org.opendaylight.vtn.manager.internal.util.AbstractDataChangeListener

checkPath, getTargetType, isRequiredEvent, nullValue, onDataTreeChanged, registerListener

Methods inherited from class org.opendaylight.vtn.manager.internal.util.CloseableContainer

addCloseable

Methods inherited from class java.lang.Object

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

Constructor Detail

VTNInventoryManager

public VTNInventoryManager(VTNManagerProvider provider)

Construct a new instance.

Parameters:

provider - A VTN Manager provider service.

Method Detail

newStaticTopologyManager

public StaticTopologyManager newStaticTopologyManager()

Create a new static network topology manager.

Returns:

A StaticTopologyManager instance.

start

public void start()

Start the inventory service.

addListener

public void addListener(VTNInventoryListener l)

Add the given VTN inventory listener.

Parameters:

l - A VTN inventory listener.

getVtnNodeManager

public VtnNodeManager getVtnNodeManager()

Return the VTN node manager.

Returns:

The VTN node manager.

shutdown

public void shutdown()

Shutdown listener service.

close

public void close()

Close the VTN inventory service.

Specified by:

close in interface AutoCloseable

Overrides:

close in class CloseableContainer

isDepth

protected boolean isDepth(@Nonnull
                          VtnUpdateType type)

Return a boolean value which specifies the order of tree traversal.

Specified by:

isDepth in class MultiDataStoreListener<VtnNode,org.opendaylight.vtn.manager.internal.inventory.InventoryEvents>

Parameters:

type - A VtnUpdateType instance which specifies the type of event.

Returns:

true means that each tree node's children need to be processed after the tree node itself (from outer to innter). false means that each tree node's children need to be processed before the tree node itself (from inner to outer).

isRequiredType

protected boolean isRequiredType(@Nonnull
                                 Class<?> type)

Determine whether the specified type of the tree node is required to be notified or not.

Specified by:

isRequiredType in class MultiDataStoreListener<VtnNode,org.opendaylight.vtn.manager.internal.inventory.InventoryEvents>

Parameters:

type - A class that specifies the type of the tree node.

Returns:

true if the specified type of the tree node needs to be notified. false otherwise.

isLeafNode

protected boolean isLeafNode(@Nonnull
                             Class<?> type)

Determine whether the specified type of the tree node should be treated as a leaf node.

This method returns true only if the specified type is VtnPort.

Overrides:

isLeafNode in class MultiDataStoreListener<VtnNode,org.opendaylight.vtn.manager.internal.inventory.InventoryEvents>

Parameters:

type - A class that specifies the type of the tree node.

Returns:

true if the specified type of the tree node should be treated as a leaf node. false otherwise.

isUpdated

protected boolean isUpdated(org.opendaylight.vtn.manager.internal.inventory.InventoryEvents ectx,
                            ChangedData<?> data)

Determine whether the specified data was updated or not.

MultiDataStoreListener.onUpdated(Object, ChangedData) is called only if this method returns true. This method is called only if MultiDataStoreListener.isRequiredType(Class) with specifying type returns true.

Specified by:

isUpdated in class MultiDataStoreListener<VtnNode,org.opendaylight.vtn.manager.internal.inventory.InventoryEvents>

Parameters:

ectx - An event context created by this instance.

data - A ChangedData instance which contains the changed data.

Returns:

true if the target data was updated. false otherwise.

enterEvent

protected org.opendaylight.vtn.manager.internal.inventory.InventoryEvents enterEvent()

Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) has just been called.

Specified by:

enterEvent in class AbstractDataChangeListener<VtnNode,org.opendaylight.vtn.manager.internal.inventory.InventoryEvents>

Returns:

A new event context.

exitEvent

protected void exitEvent(org.opendaylight.vtn.manager.internal.inventory.InventoryEvents ectx)

Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) is going to leave.

Note that this method may be called even if no modified data was notified.

Specified by:

exitEvent in class AbstractDataChangeListener<VtnNode,org.opendaylight.vtn.manager.internal.inventory.InventoryEvents>

Parameters:

ectx - An event context created by AbstractDataChangeListener.enterEvent().

onCreated

protected void onCreated(org.opendaylight.vtn.manager.internal.inventory.InventoryEvents ectx,
                         IdentifiedData<?> data)

Invoked when a new data has been created in the datastore.

Specified by:

onCreated in class MultiDataStoreListener<VtnNode,org.opendaylight.vtn.manager.internal.inventory.InventoryEvents>

Parameters:

ectx - An event context created by this instance.

data - An IdentifiedData instance which contains the created data.

onUpdated

protected void onUpdated(org.opendaylight.vtn.manager.internal.inventory.InventoryEvents ectx,
                         ChangedData<?> data)

Invoked when a data in the datastore has been updated.

Specified by:

onUpdated in class MultiDataStoreListener<VtnNode,org.opendaylight.vtn.manager.internal.inventory.InventoryEvents>

Parameters:

ectx - An event context created by this instance.

data - A ChangedData instance which contains the changed data.

onRemoved

protected void onRemoved(org.opendaylight.vtn.manager.internal.inventory.InventoryEvents ectx,
                         IdentifiedData<?> data)

Invoked when a data has been removed from the datastore.

Specified by:

onRemoved in class MultiDataStoreListener<VtnNode,org.opendaylight.vtn.manager.internal.inventory.InventoryEvents>

Parameters:

ectx - An event context created by this instance.

data - An IdentifiedData instance which contains the removed data.

getWildcardPath

protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnNode> getWildcardPath()

Return a wildcard instance identifier that specifies data objects to be listened.

Specified by:

getWildcardPath in class AbstractDataChangeListener<VtnNode,org.opendaylight.vtn.manager.internal.inventory.InventoryEvents>

Returns:

A wildcard instance identifier.

getLogger

protected org.slf4j.Logger getLogger()

Return a logger instance.

Note that this method will be called before the constructor returns.

Specified by:

getLogger in class CloseableContainer

Returns:

A Logger instance.