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

Class TenantIndexFlowRemover<T extends FlowIdSet>

java.lang.Object

org.opendaylight.vtn.manager.internal.flow.remove.TenantIndexFlowRemover<T>

Type Parameters:

T - The type of the flow index.

All Implemented Interfaces:

FlowRemover

Direct Known Subclasses:

EdgeNodeFlowRemover, PortIndexFlowRemover

public abstract class TenantIndexFlowRemover<T extends FlowIdSet>
extends Object
implements FlowRemover

An implementation of FlowRemover which removes VTN data flows in the specified VTN using flow index.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TenantIndexFlowRemover(String tname) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected abstract org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T>	getPath(VtnFlowTableKey key) Return the path to the flow index to be removed.
String	getTenantName() Return the name of the target VTN.
RemovedDataFlows<TenantIndexFlowRemover<T>>	removeDataFlow(TxContext ctx) Remove VTN data flows from the MD-SAL datastore.
protected abstract boolean	select(FlowCache fc) Determine whether the given data flow should be removed or not.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.vtn.manager.internal.FlowRemover

getDescription

Constructor Detail

TenantIndexFlowRemover

protected TenantIndexFlowRemover(String tname)

Construct a new instance.

Parameters:

tname - The name of the target VTN.

Method Detail

getTenantName

public final String getTenantName()

Return the name of the target VTN.

Returns:

The name of the target VTN.

getPath

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

Return the path to the flow index to be removed.

Parameters:

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

Returns:

Path to the flow index to be removed.

select

protected abstract boolean select(FlowCache fc)
                           throws VTNException

Determine whether the given data flow should be removed or not.

Parameters:

fc - A FlowCache instance.

Returns:

true if the given data flow should be removed. Otherwise false.

Throws:

VTNException - An error occurred.

removeDataFlow

public final RemovedDataFlows<TenantIndexFlowRemover<T>> removeDataFlow(TxContext ctx)
                                                                 throws VTNException

Remove VTN data flows from the MD-SAL datastore.

Specified by:

removeDataFlow in interface FlowRemover

Parameters:

ctx - A runtime context for transaction task.

Returns:

A RemovedFlows instance which represents removed flow entries.

Throws:

VTNException - An error occurred.