X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-dom-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fdom%2Fapi%2FDOMDataReadTransaction.java;h=0517ad6b7dd6c520abd0ac9e900e881f737a1638;hb=b4bf55727093657662d8c16a50fa85f87978a586;hp=0d5e47faee198b95f453a07c99bcfaa3181ded3d;hpb=753af6de42f98637e83bc26b4b058f47840863a8;p=controller.git diff --git a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataReadTransaction.java b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataReadTransaction.java index 0d5e47faee..0517ad6b7d 100644 --- a/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataReadTransaction.java +++ b/opendaylight/md-sal/sal-dom-api/src/main/java/org/opendaylight/controller/md/sal/dom/api/DOMDataReadTransaction.java @@ -7,24 +7,25 @@ */ package org.opendaylight.controller.md.sal.dom.api; +import com.google.common.base.Optional; +import com.google.common.util.concurrent.CheckedFuture; import org.opendaylight.controller.md.sal.common.api.data.AsyncReadTransaction; import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; -import org.opendaylight.yangtools.yang.data.api.InstanceIdentifier; +import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException; +import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; -import com.google.common.base.Optional; -import com.google.common.util.concurrent.ListenableFuture; - /** * A transaction that provides read access to a logical data store. + * *
* For more information on usage and examples, please see the documentation in {@link AsyncReadTransaction}.
*/
-public interface DOMDataReadTransaction extends AsyncReadTransaction
+ *
+ *
* If the target is a subtree, then the whole subtree is read (and will be
* accessible from the returned data object).
*
@@ -33,14 +34,41 @@ public interface DOMDataReadTransaction extends AsyncReadTransaction
+ * Note: a successful result from this method makes no guarantee that a subsequent call to {@link #read}
+ * 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
+ *
+ * @param store
+ * Logical data store from which read should occur.
+ * @param path
+ * Path which uniquely identifies subtree which client want to
+ * check existence of
+ * @return a CheckFuture containing the result of the check.
*
- *
*/
- ListenableFuture