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 org.opendaylight.controller.md.sal.common.api.data.AsyncReadTransaction;
  11 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  12 import org.opendaylight.yangtools.yang.binding.DataObject;
  13 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  14
  15 import com.google.common.base.Optional;
  16 import com.google.common.util.concurrent.ListenableFuture;
  17
  18 /**
  19  * A transaction that provides read access to a logical data store.
  20  * <p>
  21  * For more information on usage and examples, please see the documentation in {@link AsyncReadTransaction}.
  22  */
  23 public interface ReadTransaction extends AsyncReadTransaction<InstanceIdentifier<?>, DataObject> {
  24
  25     /**
  26      * Reads data from the provided logical data store located at the provided path.
  27      *<p>
  28      * If the target is a subtree, then the whole subtree is read (and will be
  29      * accessible from the returned data object).
  30      *
  31      * @param store
  32      *            Logical data store from which read should occur.
  33      * @param path
  34      *            Path which uniquely identifies subtree which client want to
  35      *            read
  36      * @return Listenable Future which contains read result
  37      *         <ul>
  38      *         <li>If data at supplied path exists the
  39      *         {@link ListeblaFuture#get()} returns Optional object containing
  40      *         data once read is done.
  41      *         <li>If data at supplied path does not exists the
  42      *         {@link ListenbleFuture#get()} returns {@link Optional#absent()}.
  43      *         </ul>
  44      */
  45     <T extends DataObject> ListenableFuture<Optional<T>> read(LogicalDatastoreType store, InstanceIdentifier<T> path);
  46 }