X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-binding-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fbinding%2Fapi%2FReadTransaction.java;h=c1efcce02c12dbaa0606a8d3482fe405b50ab499;hp=21bcf23cd468a4f09570a6d8d4c40fb8699bfae2;hb=refs%2Fchanges%2F28%2F83828%2F2;hpb=f1a918f69b787dd422a09e4e8fd83a1d52a72f83 diff --git a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ReadTransaction.java b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ReadTransaction.java index 21bcf23cd4..c1efcce02c 100644 --- a/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ReadTransaction.java +++ b/opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ReadTransaction.java @@ -9,6 +9,9 @@ package org.opendaylight.controller.md.sal.binding.api; import com.google.common.base.Optional; import com.google.common.util.concurrent.CheckedFuture; +import com.google.common.util.concurrent.Futures; +import com.google.common.util.concurrent.MoreExecutors; +import org.opendaylight.controller.md.sal.common.api.MappingCheckedFuture; import org.opendaylight.controller.md.sal.common.api.data.AsyncReadTransaction; import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException; @@ -20,20 +23,20 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; * *

* For more information on usage and examples, please see the documentation in {@link AsyncReadTransaction}. + * + * @deprecated Use {@link org.opendaylight.mdsal.binding.api.ReadTransaction} instead. */ +@Deprecated public interface ReadTransaction extends AsyncReadTransaction, DataObject> { - /** * Reads data from the 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). * - * @param store - * Logical data store from which read should occur. - * @param path - * Path which uniquely identifies subtree which client want to - * read + *

+ * If the target is a subtree, then the whole subtree is read (and will be accessible from the returned data + * object). + * + * @param store Logical data store from which read should occur. + * @param path Path which uniquely identifies subtree which client want to read * @return a CheckFuture containing the result of the read. The Future blocks until the * commit operation is complete. Once complete: *

*/ - CheckedFuture,ReadFailedException> read( + CheckedFuture, ReadFailedException> read( LogicalDatastoreType store, InstanceIdentifier path); + + /** + * 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 {@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 + * + *

+ * Default implementation delegates to {@link #read(LogicalDatastoreType, InstanceIdentifier)}, implementations + * are advised to provide a more efficient override. + * + * @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. + *

    + *
  • 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 + * {@link ReadFailedException} or an exception derived from ReadFailedException.
  • + *
+ */ + default CheckedFuture exists(final LogicalDatastoreType store, + final InstanceIdentifier path) { + return MappingCheckedFuture.create(Futures.transform(read(store, path), Optional::isPresent, + MoreExecutors.directExecutor()), ReadFailedException.MAPPER); + } }