org.opendaylight.vtn.manager.internal.util.tx

Class DeleteDataTask<D extends org.opendaylight.yangtools.yang.binding.DataObject>

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<D>

Type Parameters:

D - The type of data object in MD-SAL datastore.

All Implemented Interfaces:

TxTask<VtnUpdateType>

Direct Known Subclasses:

DeleteVlanMapTask, RemoveCostTask, RemoveFilterTask, RemoveFlowConditionTask, RemoveMacTask, RemoveMapTask, RemoveMatchTask, RemovePathPolicyTask, RemoveVirtualNodeTask

public abstract class DeleteDataTask<D extends org.opendaylight.yangtools.yang.binding.DataObject>
extends AbstractDataTask<D,VtnUpdateType>

An abstract implementation of TxTask used to delete a data object in he MD-SAL datastore.

This task returns VtnUpdateType.REMOVED if the target data has been successfully removed, and null if the target data is not present.

Constructor Summary

Constructors

Constructor and Description
DeleteDataTask(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType store, org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> path) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
protected VtnUpdateType	execute(TxContext ctx) Delete a data object in the MD-SAL datastore.
protected void	onDeleted(TxContext ctx) Invoked when the target data object has been deleted.
protected void	onStarted(TxContext ctx, D current) Invoked when the MD-SAL datastore transaction has started.

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, onSuccess

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

DeleteDataTask

public DeleteDataTask(org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType store,
                      org.opendaylight.yangtools.yang.binding.InstanceIdentifier<D> path)

Construct a new instance.

Parameters:

store - The target type of the MD-SAL datastore.

path - The path to the target object.

Method Detail

execute

protected final VtnUpdateType execute(TxContext ctx)
                               throws VTNException

Delete a data object in the MD-SAL datastore.

Specified by:

execute in class AbstractTxTask<VtnUpdateType>

Parameters:

ctx - A runtime context for transaction task.

Returns:

A VtnUpdateType instance which indicates the result of this task.

Throws:

VTNException - An error occurred.

onStarted

protected void onStarted(TxContext ctx,
                         D current)
                  throws VTNException

Invoked when the MD-SAL datastore transaction has started.

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.

onDeleted

protected void onDeleted(TxContext ctx)
                  throws VTNException

Invoked when the target data object has been deleted.

Parameters:

ctx - A runtime context for transaction task.

Throws:

VTNException - An error occurred.