org.opendaylight.vtn.manager.internal.flow.cond

Class FlowCondManager

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<VtnFlowCondition,org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange>

org.opendaylight.vtn.manager.internal.flow.cond.FlowCondManager

All Implemented Interfaces:

AutoCloseable, EventListener, org.opendaylight.controller.md.sal.binding.api.DataTreeChangeListener<VtnFlowCondition>, VTNSubSystem, VtnFlowConditionService, org.opendaylight.yangtools.yang.binding.RpcService

public final class FlowCondManager
extends MultiDataStoreListener<VtnFlowCondition,org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange>
implements VTNSubSystem, VtnFlowConditionService

Flow condition manager.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Future<org.opendaylight.yangtools.yang.common.RpcResult<ClearFlowConditionOutput>>	clearFlowCondition() Remove all the flow conditions.
protected org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange	enterEvent() Invoked when AbstractDataChangeListener.onDataTreeChanged(Collection) has just been called.
protected void	exitEvent(org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange 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<VtnFlowCondition>	getWildcardPath() Return a wildcard instance identifier that specifies data objects to be listened.
VTNFuture<?>	initConfig(boolean master) Post a MD-SAL datastore transaction task that initializes the configuration.
void	initRpcServices(org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcReg, CompositeAutoCloseable regs) Register RPC implementation required by the subsystem.
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.flow.cond.FlowCondChange ectx, ChangedData<?> data) Determine whether the specified data was updated or not.
protected void	onCreated(org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange ectx, IdentifiedData<?> data) Invoked when a new data has been created in the datastore.
protected void	onRemoved(org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange ectx, IdentifiedData<?> data) Invoked when a data has been removed from the datastore.
protected void	onUpdated(org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange ectx, ChangedData<?> data) Invoked when a data in the datastore has been updated.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	removeFlowCondition(RemoveFlowConditionInput input) Remove the flow condition specified by the name.
Future<org.opendaylight.yangtools.yang.common.RpcResult<RemoveFlowConditionMatchOutput>>	removeFlowConditionMatch(RemoveFlowConditionMatchInput input) Remove the flow match condition specified by the flow condition name and match index.
Future<org.opendaylight.yangtools.yang.common.RpcResult<SetFlowConditionOutput>>	setFlowCondition(SetFlowConditionInput input) Create or modify the flow condition.
Future<org.opendaylight.yangtools.yang.common.RpcResult<SetFlowConditionMatchOutput>>	setFlowConditionMatch(SetFlowConditionMatchInput input) Configure a flow match condition into the flow condition specified by the flow condition name and match index.

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, close

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Constructor Detail

FlowCondManager

public FlowCondManager(VTNManagerProvider provider)

Construct a new instance.

Parameters:

provider - VTN Manager provider service.

Method Detail

isDepth

protected boolean isDepth(VtnUpdateType type)

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

Specified by:

isDepth in class MultiDataStoreListener<VtnFlowCondition,org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange>

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<VtnFlowCondition,org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange>

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 VtnFlowMatch.

Overrides:

isLeafNode in class MultiDataStoreListener<VtnFlowCondition,org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange>

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.flow.cond.FlowCondChange 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<VtnFlowCondition,org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange>

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.

onCreated

protected void onCreated(org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange ectx,
                         IdentifiedData<?> data)

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

Specified by:

onCreated in class MultiDataStoreListener<VtnFlowCondition,org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange>

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.flow.cond.FlowCondChange ectx,
                         ChangedData<?> data)

Invoked when a data in the datastore has been updated.

Specified by:

onUpdated in class MultiDataStoreListener<VtnFlowCondition,org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange>

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.flow.cond.FlowCondChange ectx,
                         IdentifiedData<?> data)

Invoked when a data has been removed from the datastore.

Specified by:

onRemoved in class MultiDataStoreListener<VtnFlowCondition,org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange>

Parameters:

ectx - An event context created by this instance.

data - An IdentifiedData instance which contains the removed data.

enterEvent

protected org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange enterEvent()

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

Specified by:

enterEvent in class AbstractDataChangeListener<VtnFlowCondition,org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange>

Returns:

A new event context.

exitEvent

protected void exitEvent(org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange 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<VtnFlowCondition,org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange>

Parameters:

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

getWildcardPath

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

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

Specified by:

getWildcardPath in class AbstractDataChangeListener<VtnFlowCondition,org.opendaylight.vtn.manager.internal.flow.cond.FlowCondChange>

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.

initConfig

public VTNFuture<?> initConfig(boolean master)

Post a MD-SAL datastore transaction task that initializes the configuration.

Specified by:

initConfig in interface VTNSubSystem

Parameters:

master - true if the local node is the configuration provider.

Returns:

A VTNFuture instance associated with the task for initialization. null means that there is nothing to do on initialization.

initRpcServices

public void initRpcServices(org.opendaylight.controller.sal.binding.api.RpcProviderRegistry rpcReg,
                            CompositeAutoCloseable regs)

Register RPC implementation required by the subsystem.

Specified by:

initRpcServices in interface VTNSubSystem

Parameters:

rpcReg - A RpcProviderRegistry service instance.

regs - A CompositeAutoCloseable instance to store RPC registration.

setFlowCondition

public Future<org.opendaylight.yangtools.yang.common.RpcResult<SetFlowConditionOutput>> setFlowCondition(SetFlowConditionInput input)

Create or modify the flow condition.

• If the flow condition specified by the name does not exist, a new flow condition will be associated with the specified name.
• If the flow condition specifie by the name already exists, it will be modified as specified the RPC input.

Specified by:

setFlowCondition in interface VtnFlowConditionService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

removeFlowCondition

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> removeFlowCondition(RemoveFlowConditionInput input)

Remove the flow condition specified by the name.

Specified by:

removeFlowCondition in interface VtnFlowConditionService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

setFlowConditionMatch

public Future<org.opendaylight.yangtools.yang.common.RpcResult<SetFlowConditionMatchOutput>> setFlowConditionMatch(SetFlowConditionMatchInput input)

Configure a flow match condition into the flow condition specified by the flow condition name and match index.

Specified by:

setFlowConditionMatch in interface VtnFlowConditionService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

removeFlowConditionMatch

public Future<org.opendaylight.yangtools.yang.common.RpcResult<RemoveFlowConditionMatchOutput>> removeFlowConditionMatch(RemoveFlowConditionMatchInput input)

Remove the flow match condition specified by the flow condition name and match index.

Specified by:

removeFlowConditionMatch in interface VtnFlowConditionService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

clearFlowCondition

public Future<org.opendaylight.yangtools.yang.common.RpcResult<ClearFlowConditionOutput>> clearFlowCondition()

Remove all the flow conditions.

Specified by:

clearFlowCondition in interface VtnFlowConditionService

Returns:

A Future associated with the RPC task.