org.opendaylight.vtn.manager.internal.flow

Class VTNFlowManager

java.lang.Object

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

org.opendaylight.vtn.manager.internal.util.SalNotificationListener

org.opendaylight.vtn.manager.internal.flow.VTNFlowManager

All Implemented Interfaces:

AutoCloseable, EventListener, org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener, VTNInventoryListener, BarrierSender, VTNSubSystem, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowListener, VtnFlowService, org.opendaylight.yangtools.yang.binding.NotificationListener, org.opendaylight.yangtools.yang.binding.RpcService

public final class VTNFlowManager
extends SalNotificationListener
implements VTNSubSystem, VTNInventoryListener, BarrierSender, VtnFlowService, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowListener, org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener

Flow entry manager.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	VTNFlowManager.TxCounterCallback<T> A callback for flow transaction future that decrements the transaction counter.

Constructor Summary

Constructors

Constructor and Description
VTNFlowManager(VTNManagerProvider provider, org.opendaylight.controller.md.sal.binding.api.NotificationService nsv) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
VTNFuture<VtnFlowId>	addFlow(VTNFlowBuilder builder) Add a new VTN data flow.
void	asyncBarrier(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nref) Send a barrier request to the specified switch asynchronously.
void	close() Close the VTN flow manager service.
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetDataFlowOutput>>	getDataFlow(GetDataFlowInput input) Return information about data flows specified by the RPC input.
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetDataFlowCountOutput>>	getDataFlowCount(GetDataFlowCountInput input) Return the number of data flows present in the specified VTN.
protected org.slf4j.Logger	getLogger() Return a logger instance.
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.
void	notifyVtnNode(VtnNodeEvent ev) Invoked when a node information has been added or removed.
void	notifyVtnPort(VtnPortEvent ev) Invoked when a port information has been added, removed, or changed.
void	onFlowAdded(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowAdded notification) Invoked when a flow entry has been added.
void	onFlowRemoved(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved notification) Invoked when a flow entry has been removed.
void	onFlowUpdated(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowUpdated notification) Invoked when a flow entry has been updated.
void	onNodeErrorNotification(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeErrorNotification notification) Invoked when an error has been detected.
void	onNodeExperimenterErrorNotification(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeExperimenterErrorNotification notification) Invoked when an experimental error has been detected.
void	onSwitchFlowRemoved(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SwitchFlowRemoved notification) Invoked when a flow entry has been removed from the switch.
void	ownershipChanged(org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange change) Invoked when the ownership status of the flow statistics has been changed.
VTNFuture<Void>	removeFlows(FlowRemover remover) Remove VTN data flows selected by the given flow remover.
void	shutdown() Shut down the VTN flow service.

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

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

VTNFlowManager

public VTNFlowManager(VTNManagerProvider provider,
                      org.opendaylight.controller.md.sal.binding.api.NotificationService nsv)

Construct a new instance.

Parameters:

provider - A VTN Manager provider service.

nsv - A NotificationService service instance.

Method Detail

shutdown

public void shutdown()

Shut down the VTN flow service.

addFlow

public VTNFuture<VtnFlowId> addFlow(VTNFlowBuilder builder)

Add a new VTN data flow.

Parameters:

builder - A VTNFlowBuilder instance which contains data flow to be installed.

Returns:

A future associated with the task which adds a VTN data flow.

removeFlows

public VTNFuture<Void> removeFlows(FlowRemover remover)

Remove VTN data flows selected by the given flow remover.

Parameters:

remover - A FlowRemover instance which determines VTN data flows to be removed.

Returns:

A future associated with the task which removes VTN data flows.

close

public void close()

Close the VTN flow manager service.

Specified by:

close in interface AutoCloseable

Overrides:

close in class CloseableContainer

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.

notifyVtnNode

public void notifyVtnNode(VtnNodeEvent ev)
                   throws VTNException

Invoked when a node information has been added or removed.

Specified by:

notifyVtnNode in interface VTNInventoryListener

Parameters:

ev - A VtnNodeEvent instance.

Throws:

VTNException - An error occurred.

notifyVtnPort

public void notifyVtnPort(VtnPortEvent ev)

Invoked when a port information has been added, removed, or changed.

Specified by:

notifyVtnPort in interface VTNInventoryListener

Parameters:

ev - A VtnPortEvent instance.

asyncBarrier

public void asyncBarrier(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef nref)

Send a barrier request to the specified switch asynchronously.

Specified by:

asyncBarrier in interface BarrierSender

Parameters:

nref - Reference to the target node.

getDataFlow

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetDataFlowOutput>> getDataFlow(GetDataFlowInput input)

Return information about data flows specified by the RPC input.

Specified by:

getDataFlow in interface VtnFlowService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

getDataFlowCount

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetDataFlowCountOutput>> getDataFlowCount(GetDataFlowCountInput input)

Return the number of data flows present in the specified VTN.

Specified by:

getDataFlowCount in interface VtnFlowService

Parameters:

input - Input of the RPC.

Returns:

A Future associated with the RPC task.

onFlowAdded

public void onFlowAdded(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowAdded notification)

Invoked when a flow entry has been added.

Specified by:

onFlowAdded in interface org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowListener

Parameters:

notification - A FlowAdded instance.

onFlowRemoved

public void onFlowRemoved(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemoved notification)

Invoked when a flow entry has been removed.

Specified by:

onFlowRemoved in interface org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowListener

Parameters:

notification - A FlowRemoved notification.

onFlowUpdated

public void onFlowUpdated(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowUpdated notification)

Invoked when a flow entry has been updated.

Specified by:

onFlowUpdated in interface org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowListener

Parameters:

notification - A FlowUpdated notification.

onNodeErrorNotification

public void onNodeErrorNotification(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeErrorNotification notification)

Invoked when an error has been detected.

Specified by:

onNodeErrorNotification in interface org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowListener

Parameters:

notification - A NodeErrorNotification notification.

onNodeExperimenterErrorNotification

public void onNodeExperimenterErrorNotification(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeExperimenterErrorNotification notification)

Invoked when an experimental error has been detected.

Specified by:

onNodeExperimenterErrorNotification in interface org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowListener

Parameters:

notification - A NodeExperimenterErrorNotification notification.

onSwitchFlowRemoved

public void onSwitchFlowRemoved(org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SwitchFlowRemoved notification)

Invoked when a flow entry has been removed from the switch.

Specified by:

onSwitchFlowRemoved in interface org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.SalFlowListener

Parameters:

notification - A SwitchFlowRemoved notification.

ownershipChanged

public void ownershipChanged(org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipChange change)

Invoked when the ownership status of the flow statistics has been changed.

Specified by:

ownershipChanged in interface org.opendaylight.controller.md.sal.common.api.clustering.EntityOwnershipListener

Parameters:

change - An EntityOwnershipChange instance.