org.opendaylight.mdsal.dom.broker

Class ShardedDOMReadWriteTransactionAdapter

java.lang.Object

org.opendaylight.mdsal.dom.broker.ShardedDOMWriteTransactionAdapter

org.opendaylight.mdsal.dom.broker.ShardedDOMReadWriteTransactionAdapter

All Implemented Interfaces:

AutoCloseable, DOMDataTreeReadOperations, DOMDataTreeReadTransaction, DOMDataTreeReadWriteTransaction, DOMDataTreeTransaction, DOMDataTreeWriteOperations, DOMDataTreeWriteTransaction, org.opendaylight.yangtools.concepts.Identifiable<Object>, org.opendaylight.yangtools.concepts.Registration

public class ShardedDOMReadWriteTransactionAdapter
extends ShardedDOMWriteTransactionAdapter
implements DOMDataTreeReadWriteTransaction

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancels the transaction.
com.google.common.util.concurrent.FluentFuture<Boolean>	exists(LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path) Checks if data is available in the logical data store located at provided path.
com.google.common.util.concurrent.FluentFuture<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>>	read(LogicalDatastoreType store, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path) Reads data from provided logical data store located at the provided path.

Methods inherited from class org.opendaylight.mdsal.dom.broker.ShardedDOMWriteTransactionAdapter

commit, delete, getIdentifier, merge, put

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.mdsal.dom.api.DOMDataTreeReadWriteTransaction

close

Methods inherited from interface org.opendaylight.mdsal.dom.api.DOMDataTreeWriteTransaction

commit

Methods inherited from interface org.opendaylight.mdsal.dom.api.DOMDataTreeWriteOperations

delete, merge, put

Methods inherited from interface org.opendaylight.yangtools.concepts.Identifiable

getIdentifier

Method Detail

read

public com.google.common.util.concurrent.FluentFuture<Optional<org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode<?,?>>> read(LogicalDatastoreType store,
                                                                                                                                          org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

Description copied from interface: DOMDataTreeReadOperations

Reads data from provided logical data store located at the provided path.

If the target is a subtree, then the whole subtree is read (and will be accessible from the returned data object).

Specified by:

read in interface DOMDataTreeReadOperations

Parameters:

store - Logical data store from which read should occur.

path - Path which uniquely identifies subtree which client want to read

Returns:

a FluentFuture containing the result of the read. The Future blocks until the commit operation is complete. Once complete:

• If the data at the supplied path exists, the Future returns an Optional object containing the data.
• If the data at the supplied path does not exist, the Future returns Optional.empty().
• If the read of the data fails, the Future will fail with a ReadFailedException or an exception derived from ReadFailedException.

exists

public com.google.common.util.concurrent.FluentFuture<Boolean> exists(LogicalDatastoreType store,
                                                                      org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier path)

Description copied from interface: DOMDataTreeReadOperations

Checks if data is available in the logical data store located at provided path.

Note: a successful result from this method makes no guarantee that a subsequent call to DOMDataTreeReadOperations.read(org.opendaylight.mdsal.common.api.LogicalDatastoreType, org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier) will succeed. It is possible that the data resides in a data store on a remote node and, if that node goes down or a network failure occurs, a subsequent read would fail. Another scenario is if the data is deleted in between the calls to exists and read

Specified by:

exists in interface DOMDataTreeReadOperations

Parameters:

store - Logical data store from which read should occur.

path - Path which uniquely identifies subtree which client want to check existence of

Returns:

a FluentFuture containing the result of the check.

• If the data at the supplied path exists, the Future returns a Boolean whose value is true, false otherwise
• If checking for the data fails, the Future will fail with a ReadFailedException or an exception derived from ReadFailedException.

cancel

public boolean cancel()

Description copied from interface: DOMDataTreeWriteTransaction

Cancels the transaction. Transactions can only be cancelled if it was not yet committed. Invoking cancel() on failed or already canceled will have no effect, and transaction is considered cancelled. Invoking cancel() on finished transaction (future returned by DOMDataTreeWriteTransaction.commit() already successfully completed) will always fail (return false).

Specified by:

cancel in interface DOMDataTreeWriteTransaction

Overrides:

cancel in class ShardedDOMWriteTransactionAdapter

Returns:

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