org.opendaylight.vtn.manager.internal.flow.remove

Class PortFlowRemover

java.lang.Object

org.opendaylight.vtn.manager.internal.flow.remove.IndexFlowRemover<PortFlows,RemovedPortFlows>

org.opendaylight.vtn.manager.internal.flow.remove.PortFlowRemover

All Implemented Interfaces:

FlowRemover

public final class PortFlowRemover
extends IndexFlowRemover<PortFlows,RemovedPortFlows>

An implementation of FlowRemover which removes VTN data flows related to the specified switch port.

This flow remover affects flow entries in all the VTNs.

Constructor Summary

Constructors

Constructor and Description
PortFlowRemover(SalPort sport) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected void	add(RemovedPortFlows removed, FlowCache fc) Invoked when the given data flow has been removed.
String	getDescription() Return a brief description about this flow remover.
SalPort	getFlowPort() Return the target switch port.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<PortFlows>	getPath(VtnFlowTableKey key) Return the path to the port flow index to be removed.
RemovedPortFlows	removeDataFlow(TxContext ctx) Remove VTN data flows from the MD-SAL datastore.

Methods inherited from class org.opendaylight.vtn.manager.internal.flow.remove.IndexFlowRemover

remove

Methods inherited from class java.lang.Object

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

Constructor Detail

PortFlowRemover

public PortFlowRemover(SalPort sport)

Construct a new instance.

Parameters:

sport - A SalPort instance.

Method Detail

getFlowPort

public SalPort getFlowPort()

Return the target switch port.

Returns:

A SalPort instance whcih specifies the target switch port.

getPath

protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier<PortFlows> getPath(VtnFlowTableKey key)

Return the path to the port flow index to be removed.

Specified by:

getPath in class IndexFlowRemover<PortFlows,RemovedPortFlows>

Parameters:

key - A VtnFlowTableKey instance which specifies the target VTN flow table.

Returns:

Path to the port flow index to be removed.

add

protected void add(RemovedPortFlows removed,
                   FlowCache fc)

Invoked when the given data flow has been removed.

Specified by:

add in class IndexFlowRemover<PortFlows,RemovedPortFlows>

Parameters:

removed - A RemovedFlows instance to store flow entries to be removed.

fc - A FlowCache instance which contains VTN data flow to be removed.

removeDataFlow

public RemovedPortFlows removeDataFlow(TxContext ctx)
                                throws VTNException

Remove VTN data flows from the MD-SAL datastore.

Parameters:

ctx - A runtime context for transaction task.

Returns:

A RemovedFlows instance which represents removed flow entries.

Throws:

VTNException - An error occurred.

getDescription

public String getDescription()

Return a brief description about this flow remover.

Returns:

A brief description about this flow remover.