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

Class TenantFlowRemover

java.lang.Object

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

All Implemented Interfaces:

FlowRemover

public final class TenantFlowRemover
extends Object
implements FlowRemover

An implementation of FlowRemover which removes all VTN data flows in the specified VTN.

Constructor Summary

Constructors

Constructor and Description
TenantFlowRemover(String tname) Construct a new instance.
TenantFlowRemover(VNodeIdentifier<?> ident) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Return a brief description about this flow remover.
RemovedDataFlows<TenantFlowRemover>	removeDataFlow(TxContext ctx) Remove VTN data flows from the MD-SAL datastore.

Methods inherited from class java.lang.Object

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

Constructor Detail

TenantFlowRemover

public TenantFlowRemover(String tname)

Construct a new instance.

Parameters:

tname - The name of the target VTN.

TenantFlowRemover

public TenantFlowRemover(VNodeIdentifier<?> ident)

Construct a new instance.

Parameters:

ident - The identifier for the virtual node in the target VTN.

Method Detail

removeDataFlow

public RemovedDataFlows<TenantFlowRemover> 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.

getDescription

public String getDescription()

Return a brief description about this flow remover.

Specified by:

getDescription in interface FlowRemover

Returns:

A brief description about this flow remover.