org.opendaylight.vtn.manager.internal.flow.stats

Class SalFlowIdResolver

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.DataStoreListener<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow,AddedFlowStats>

org.opendaylight.vtn.manager.internal.flow.stats.SalFlowIdResolver

All Implemented Interfaces:

AutoCloseable, EventListener, org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow>

public final class SalFlowIdResolver
extends DataStoreListener<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow,AddedFlowStats>

SalFlowIdResolver is used to resolve MD-SAL flow ID assigned to the VTN flow.

Flow entries installed by the VTN Manager has no MD-SAL flow ID because it installs flow entries without using the MD-SAL FRM. But pseudo MD-SAL flow identifier will be assigned to every flow entries by the MD-SAL statistics manager. This class listens the flow statistics in the MD-SAL datastore, and determine MD-SAL flow ID assigned assigned by the MD-SAL statistics manager.

Constructor Summary

Constructors

Constructor and Description
SalFlowIdResolver(VTNManagerProvider provider, TxQueue txq) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected AddedFlowStats	enterEvent() Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) has just been called.
protected void	exitEvent(AddedFlowStats ectx) Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) is going to leave.
protected org.slf4j.Logger	getLogger() Return a logger instance.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow>	getWildcardPath() Return a wildcard instance identifier that specifies data objects to be listened.
protected boolean	isRequiredEvent(VtnUpdateType type) Determine whether the specified event type should be handled or not.
protected boolean	isUpdated(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow before, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow after) Always returns false because this listener has no interest in the change of MD-SAL flow.
protected void	onCreated(AddedFlowStats ectx, IdentifiedData<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow> data) Invoked when a new data has been created in the datastore.
protected void	onRemoved(AddedFlowStats ectx, IdentifiedData<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow> data) Invoked when a data has been removed from the datastore.
protected void	onUpdated(AddedFlowStats ectx, ChangedData<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow> data) Invoked when a data in the datastore has been updated.

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

handleTree

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

checkPath, getTargetType, nullValue, onDataTreeChanged, registerListener

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

addCloseable, close

Methods inherited from class java.lang.Object

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

Constructor Detail

SalFlowIdResolver

public SalFlowIdResolver(VTNManagerProvider provider,
                         TxQueue txq)

Construct a new instance.

Parameters:

provider - VTN Manager provider service.

txq - A TxQueue instance used to update the VTN flow information.

Method Detail

enterEvent

protected AddedFlowStats enterEvent()

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

Specified by:

enterEvent in class AbstractDataChangeListener<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow,AddedFlowStats>

Returns:

A new event context.

exitEvent

protected void exitEvent(AddedFlowStats 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<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow,AddedFlowStats>

Parameters:

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

onCreated

protected void onCreated(AddedFlowStats ectx,
                         IdentifiedData<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow> data)

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

Specified by:

onCreated in class DataStoreListener<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow,AddedFlowStats>

Parameters:

ectx - An event context created by this instance.

data - An IdentifiedData instance which contains the created data.

onUpdated

protected void onUpdated(AddedFlowStats ectx,
                         ChangedData<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow> data)

Invoked when a data in the datastore has been updated.

Specified by:

onUpdated in class DataStoreListener<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow,AddedFlowStats>

Parameters:

ectx - An event context created by this instance.

data - A ChangedData instance which contains the changed data.

onRemoved

protected void onRemoved(AddedFlowStats ectx,
                         IdentifiedData<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow> data)

Invoked when a data has been removed from the datastore.

Specified by:

onRemoved in class DataStoreListener<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow,AddedFlowStats>

Parameters:

ectx - An event context created by this instance.

data - An IdentifiedData instance which contains the removed data.

isUpdated

protected boolean isUpdated(@Nonnull
                            org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow before,
                            @Nonnull
                            org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow after)

Always returns false because this listener has no interest in the change of MD-SAL flow.

Specified by:

isUpdated in class DataStoreListener<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow,AddedFlowStats>

Parameters:

before - The target data object before modification.

after - The target data object after modification.

Returns:

false.

getWildcardPath

protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow> getWildcardPath()

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

Specified by:

getWildcardPath in class AbstractDataChangeListener<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow,AddedFlowStats>

Returns:

A wildcard instance identifier.

isRequiredEvent

protected boolean isRequiredEvent(@Nonnull
                                  VtnUpdateType type)

Determine whether the specified event type should be handled or not.

This method returns true only if the given type is VtnUpdateType.CREATED.

Overrides:

isRequiredEvent in class AbstractDataChangeListener<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow,AddedFlowStats>

Parameters:

type - A VtnUpdateType instance which indicates the event type.

Returns:

true if the given event type should be handled. false otherwise.

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.