opendaylight/md-sal/sal-binding-api/src/main/java/org/opendaylight/controller/md/sal/binding/api/ReadTransaction.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.controller.md.sal.binding.api;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.util.concurrent.CheckedFuture;
  12 import com.google.common.util.concurrent.Futures;
  13 import com.google.common.util.concurrent.MoreExecutors;
  14 import org.opendaylight.controller.md.sal.common.api.MappingCheckedFuture;
  15 import org.opendaylight.controller.md.sal.common.api.data.AsyncReadTransaction;
  16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  17 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
  18 import org.opendaylight.yangtools.yang.binding.DataObject;
  19 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  20
  21 /**
  22  * A transaction that provides read access to a logical data store.
  23  *
  24  * <p>
  25  * For more information on usage and examples, please see the documentation in {@link AsyncReadTransaction}.
  26  */
  27 public interface ReadTransaction extends AsyncReadTransaction<InstanceIdentifier<?>, DataObject> {
  28
  29     /**
  30      * Reads data from the provided logical data store located at the provided path.
  31      *<p>
  32      * If the target is a subtree, then the whole subtree is read (and will be
  33      * accessible from the returned data object).
  34      *
  35      * @param store
  36      *            Logical data store from which read should occur.
  37      * @param path
  38      *            Path which uniquely identifies subtree which client want to
  39      *            read
  40      * @return a CheckFuture containing the result of the read. The Future blocks until the
  41      *         commit operation is complete. Once complete:
  42      *         <ul>
  43      *         <li>If the data at the supplied path exists, the Future returns an Optional object
  44      *         containing the data.</li>
  45      *         <li>If the data at the supplied path does not exist, the Future returns
  46      *         Optional#absent().</li>
  47      *         <li>If the read of the data fails, the Future will fail with a
  48      *         {@link ReadFailedException} or an exception derived from ReadFailedException.</li>
  49      *         </ul>
  50      */
  51     <T extends DataObject> CheckedFuture<Optional<T>, ReadFailedException> read(
  52             LogicalDatastoreType store, InstanceIdentifier<T> path);
  53
  54     /**
  55      * Checks if data is available in the logical data store located at provided path.
  56      *
  57      * <p>
  58      * Note: a successful result from this method makes no guarantee that a subsequent call to {@link #read}
  59      * will succeed. It is possible that the data resides in a data store on a remote node and, if that
  60      * node goes down or a network failure occurs, a subsequent read would fail. Another scenario is if
  61      * the data is deleted in between the calls to <code>exists</code> and <code>read</code>
  62      *
  63      * <p>
  64      * Default implementation delegates to {@link #read(LogicalDatastoreType, InstanceIdentifier)}, implementations
  65      * are advised to provide a more efficient override.
  66      *
  67      * @param store
  68      *            Logical data store from which read should occur.
  69      * @param path
  70      *            Path which uniquely identifies subtree which client want to
  71      *            check existence of
  72      * @return a CheckFuture containing the result of the check.
  73      *         <ul>
  74      *         <li>If the data at the supplied path exists, the Future returns a Boolean
  75      *         whose value is true, false otherwise</li>
  76      *         <li>If checking for the data fails, the Future will fail with a
  77      *         {@link ReadFailedException} or an exception derived from ReadFailedException.</li>
  78      *         </ul>
  79      */
  80     default CheckedFuture<Boolean, ReadFailedException> exists(final LogicalDatastoreType store,
  81             final InstanceIdentifier<?> path) {
  82         return MappingCheckedFuture.create(Futures.transform(read(store, path), Optional::isPresent,
  83             MoreExecutors.directExecutor()), ReadFailedException.MAPPER);
  84     }
  85 }