Package org.opendaylight.mdsal.dom.spi.store

Class SnapshotBackedReadWriteTransaction<T>

java.lang.Object
org.opendaylight.mdsal.dom.spi.store.AbstractDOMStoreTransaction<T>
org.opendaylight.mdsal.dom.spi.store.SnapshotBackedWriteTransaction<T>
org.opendaylight.mdsal.dom.spi.store.SnapshotBackedReadWriteTransaction<T>
Type Parameters:
T - identifier type
All Implemented Interfaces:
AutoCloseable, DOMStoreReadTransaction, DOMStoreReadWriteTransaction, DOMStoreTransaction, DOMStoreWriteTransaction, SnapshotBackedTransaction, Identifiable<Object>
@Beta public final class SnapshotBackedReadWriteTransaction<T> extends SnapshotBackedWriteTransaction<T> implements DOMStoreReadWriteTransaction
Implementation of Read-Write transaction which is backed by DataTreeSnapshot and executed according to SnapshotBackedWriteTransaction.TransactionReadyPrototype.

  • Method Details

    • read

      public FluentFuture<Optional<NormalizedNode>> read(YangInstanceIdentifier path)
      Description copied from interface: DOMStoreReadTransaction
      Reads data from provided logical data store located at provided path.
      Specified by:
      read in interface DOMStoreReadTransaction
      Parameters:
      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 FluentFuture<Boolean> exists(YangInstanceIdentifier path)
      Description copied from interface: DOMStoreReadTransaction
      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 DOMStoreReadTransaction.read(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 DOMStoreReadTransaction
      Parameters:
      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.