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

Class PutDataTask<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.PutDataTask<D>

Type Parameters:

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

All Implemented Interfaces:

TxTask<VtnUpdateType>

Direct Known Subclasses:

SetCostTask, SetFilterTask, SetFlowConditionTask, SetMapTask, SetMatchTask, SetPathPolicyTask

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

An abstract implementation of TxTask used to create or update a data object in the MD-SAL datastore.

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

VtnUpdateType.CREATED

Indicates that the target data object has been newly created.

VtnUpdateType.CHANGED

Indicates that the target data is present and it has been successfully updated.

null

No change has been made to the target data object.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected VtnUpdateType	execute(TxContext ctx) Create or update a data object in the MD-SAL datastore.
protected boolean	fixMissingParents() Determine whether missing parent nodes should be created or not.
D	getDataObject() Return the data object to be submitted.
protected void	onStarted(TxContext ctx, D current) Invoked when the MD-SAL datastore transaction has started.
void	setDataObject(D data) Set the data object to be submitted.

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

PutDataTask

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

Construct a new instance.

Parameters:

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

path - The path to the target object.

obj - The data object to be submitted.

repl - If true, the target object will be replaced with the given object. Otherwise the given object will be merged with the target object.

Method Detail

getDataObject

public final D getDataObject()

Return the data object to be submitted.

Returns:

A data object to be submitted.

setDataObject

public final void setDataObject(D data)

Set the data object to be submitted.

Parameters:

data - A data object to be submitted.

fixMissingParents

protected boolean fixMissingParents()

Determine whether missing parent nodes should be created or not.

Returns:

true if parent nodes should be created if missing. Otherwise false.

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.

execute

protected final VtnUpdateType execute(TxContext ctx)
                               throws VTNException

Create or update 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. null is returned if the target data object was not changed.

Throws:

VTNException - An error occurred.