org.opendaylight.vtn.manager.internal.vnode

Class RemoveVirtualNodeTask<T extends org.opendaylight.yangtools.yang.binding.DataObject,I extends VNodeIdentifier<T>>

java.lang.Object

org.opendaylight.vtn.manager.internal.util.tx.AbstractTxTask<T>

org.opendaylight.vtn.manager.internal.util.tx.AbstractRpcTask<V>

org.opendaylight.vtn.manager.internal.util.tx.AbstractDataTask<D,VtnUpdateType>

org.opendaylight.vtn.manager.internal.util.tx.DeleteDataTask<T>

org.opendaylight.vtn.manager.internal.vnode.RemoveVirtualNodeTask<T,I>

Type Parameters:

T - The type of target virtual node.

I - The type of the identifier for the target virtual node.

All Implemented Interfaces:

TxTask<VtnUpdateType>, RpcOutputGenerator<VtnUpdateType,Void>

Direct Known Subclasses:

RemoveVbridgeTask, RemoveVinterfaceTask, RemoveVterminalTask, RemoveVtnTask

public abstract class RemoveVirtualNodeTask<T extends org.opendaylight.yangtools.yang.binding.DataObject,I extends VNodeIdentifier<T>>
extends DeleteDataTask<T>
implements RpcOutputGenerator<VtnUpdateType,Void>

An abstract implementation of DeleteDataTask used to remove the specified virtual node from the MD-SAL datastore.

This task returns a VtnUpdateType instance that indicates the result of the task.

VtnUpdateType.REMOVED

Indicates that the target virtual node has been removed.

null

The target virtual node is not present.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RemoveVirtualNodeTask(I ident) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
Void	createOutput(VtnUpdateType result) Generate the output of the RPC request.
protected abstract void	destroy(TxContext ctx, T current) Destroy the target virtual node.
protected I	getIdentifier() Return an identifier for the target virtual node.
Class<Void>	getOutputType() Return a class which indicates the type of the RPC output.
protected void	onStarted(TxContext ctx, T current) Invoked when the MD-SAL datastore transaction has started.
void	onSuccess(VTNManagerProvider provider, VtnUpdateType result) Invoked when the task has completed successfully.
protected void	setFlowRemover(FlowRemover fr) Set a FlowRemover instance that specifies the flow entries to be removed.

Methods inherited from class org.opendaylight.vtn.manager.internal.util.tx.DeleteDataTask

execute, onDeleted

Methods inherited from class org.opendaylight.vtn.manager.internal.util.tx.AbstractDataTask

getDatastoreType, getTargetPath

Methods inherited from class org.opendaylight.vtn.manager.internal.util.tx.AbstractRpcTask

needErrorLog

Methods inherited from class org.opendaylight.vtn.manager.internal.util.tx.AbstractTxTask

addBackgroundTask, execute, getBackgroundTasks, getMaxRetry, onFailure

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

isAsync

Constructor Detail

RemoveVirtualNodeTask

protected RemoveVirtualNodeTask(I ident)

Construct a new instance.

Parameters:

ident - The identifier for the target virtual node.

Method Detail

getIdentifier

protected final I getIdentifier()

Return an identifier for the target virtual node.

Returns:

A VNodeIdentifier instance.

setFlowRemover

protected final void setFlowRemover(FlowRemover fr)

Set a FlowRemover instance that specifies the flow entries to be removed.

Parameters:

fr - A FlowRemover instance.

destroy

protected abstract void destroy(TxContext ctx,
                                T current)
                         throws VTNException

Destroy the target virtual node.

Parameters:

ctx - A runtime context for transaction task.

current - The virtual node to be removed.

Throws:

VTNException - An error occurred.

onStarted

protected final void onStarted(TxContext ctx,
                               T current)
                        throws VTNException

Invoked when the MD-SAL datastore transaction has started.

Overrides:

onStarted in class DeleteDataTask<T extends org.opendaylight.yangtools.yang.binding.DataObject>

Parameters:

ctx - A runtime context for transaction task.

current - The current value at the target path in the MD-SAL datastore. Note that null is passed if the target data is not present.

Throws:

VTNException - An error occurred.

getOutputType

public final Class<Void> getOutputType()

Return a class which indicates the type of the RPC output.

Specified by:

getOutputType in interface RpcOutputGenerator<VtnUpdateType,Void>

Returns:

A class which indicates the type of the RPC output.

createOutput

public final Void createOutput(VtnUpdateType result)

Generate the output of the RPC request.

Specified by:

createOutput in interface RpcOutputGenerator<VtnUpdateType,Void>

Parameters:

result - The result of the RPC main procedure.

Returns:

The output of the RPC request.

onSuccess

public final void onSuccess(VTNManagerProvider provider,
                            VtnUpdateType result)

Invoked when the task has completed successfully.

This method of this class does nothing.

Specified by:

onSuccess in interface TxTask<VtnUpdateType>

Overrides:

onSuccess in class AbstractTxTask<VtnUpdateType>

Parameters:

provider - VTN Manager provider service.

result - An object returned by AbstractTxTask.execute(TxContext, int).