dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMDataTreeReadTransaction.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.dom.api;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.util.concurrent.CheckedFuture;
  12 import org.opendaylight.mdsal.common.api.AsyncReadTransaction;
  13 import org.opendaylight.mdsal.common.api.LogicalDatastoreType;
  14 import org.opendaylight.mdsal.common.api.ReadFailedException;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  17
  18 /**
  19  * A transaction that provides read access to a logical data store.
  20  *
  21  * <p>
  22  * For more information on usage and examples, please see the documentation in {@link AsyncReadTransaction}.
  23  */
  24 public interface DOMDataTreeReadTransaction extends AsyncReadTransaction<YangInstanceIdentifier, NormalizedNode<?, ?>> {
  25
  26     /**
  27      * Reads data from provided logical data store located at the provided path.
  28      *
  29      *<p>
  30      * If the target is a subtree, then the whole subtree is read (and will be
  31      * accessible from the returned data object).
  32      *
  33      * @param store
  34      *            Logical data store from which read should occur.
  35      * @param path
  36      *            Path which uniquely identifies subtree which client want to
  37      *            read
  38      * @return a CheckFuture containing the result of the read. The Future blocks until the
  39      *         commit operation is complete. Once complete:
  40      *         <ul>
  41      *         <li>If the data at the supplied path exists, the Future returns an Optional object
  42      *         containing the data.</li>
  43      *         <li>If the data at the supplied path does not exist, the Future returns
  44      *         Optional#absent().</li>
  45      *         <li>If the read of the data fails, the Future will fail with a
  46      *         {@link ReadFailedException} or an exception derived from ReadFailedException.</li>
  47      *         </ul>
  48      */
  49     CheckedFuture<Optional<NormalizedNode<?,?>>, ReadFailedException> read(
  50             LogicalDatastoreType store, YangInstanceIdentifier path);
  51
  52     /**
  53      * Checks if data is available in the logical data store located at provided path.
  54      *
  55      * <p>
  56      * Note: a successful result from this method makes no guarantee that a subsequent call to {@link #read}
  57      * will succeed. It is possible that the data resides in a data store on a remote node and, if that
  58      * node goes down or a network failure occurs, a subsequent read would fail. Another scenario is if
  59      * the data is deleted in between the calls to <code>exists</code> and <code>read</code>
  60      *
  61      * @param store
  62      *            Logical data store from which read should occur.
  63      * @param path
  64      *            Path which uniquely identifies subtree which client want to
  65      *            check existence of
  66      * @return a CheckFuture containing the result of the check.
  67      *         <ul>
  68      *         <li>If the data at the supplied path exists, the Future returns a Boolean
  69      *         whose value is true, false otherwise</li>
  70      *         <li>If checking for the data fails, the Future will fail with a
  71      *         {@link ReadFailedException} or an exception derived from ReadFailedException.</li>
  72      *         </ul>
  73      */
  74     CheckedFuture<Boolean, ReadFailedException> exists(
  75         LogicalDatastoreType store, YangInstanceIdentifier path);
  76
  77 }