org.opendaylight.mdsal.binding.api

Interface CursorAwareWriteTransaction

All Superinterfaces:

DataTreeCursorProvider

All Known Implementing Classes:

BindingDOMCursorAwareWriteTransactionAdapter

public interface CursorAwareWriteTransaction
extends DataTreeCursorProvider

Write transaction that provides cursor's with write access to the data tree.

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancels the transaction.
<T extends DataObject> DataTreeWriteCursor	createCursor(DataTreeIdentifier<T> path) Create a DataTreeWriteCursor anchored at the specified path.
com.google.common.util.concurrent.CheckedFuture<Void,TransactionCommitFailedException>	submit() Submits this transaction to be asynchronously applied to update the logical data tree.

Method Detail

createCursor

@Nullable
<T extends DataObject> DataTreeWriteCursor createCursor(@Nonnull
                                                                  DataTreeIdentifier<T> path)

Create a DataTreeWriteCursor anchored at the specified path. There can only be one cursor open at a time.

Specified by:

createCursor in interface DataTreeCursorProvider

Parameters:

path - Path at which the cursor is to be anchored

Returns:

write cursor at the desired location.

Throws:

IllegalStateException - when there's an open cursor, or this transaction is closed already.

cancel

boolean cancel()

Cancels the transaction.

Transactions can only be cancelled if it was not yet submited.

Invoking cancel() on failed or already canceled will have no effect, and transaction is considered cancelled.

Invoking cancel() on finished transaction (future returned by submit() already successfully completed) will always fail (return false).

Returns:

false if the task could not be cancelled, typically because it has already completed normally; true otherwise

submit

com.google.common.util.concurrent.CheckedFuture<Void,TransactionCommitFailedException> submit()

Submits this transaction to be asynchronously applied to update the logical data tree. The returned CheckedFuture conveys the result of applying the data changes.

Note: It is strongly recommended to process the CheckedFuture result in an asynchronous manner rather than using the blocking get() method.

This call logically seals the transaction, which prevents the client from further changing data tree using this transaction's cursor. Any subsequent calls to createCursorCursor(DOMDataTreeIdentifier or any of the cursor's methods will fail with IllegalStateException.

The transaction is marked as submitted and enqueued into the shard back-end for processing.