Cleanup DOMStoreReadTransaction/DOMDataReadTransaction exists API documentation
[controller.git] / opendaylight / md-sal / sal-dom-api / src / main / java / org / opendaylight / controller / md / sal / dom / api / DOMDataReadTransaction.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.dom.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.controller.md.sal.common.api.data.ReadFailedException;
13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
14 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
15
16 import com.google.common.base.Optional;
17 import com.google.common.util.concurrent.CheckedFuture;
18
19 /**
20  * A transaction that provides read access to a logical data store.
21  * <p>
22  * For more information on usage and examples, please see the documentation in {@link AsyncReadTransaction}.
23  */
24 public interface DOMDataReadTransaction extends AsyncReadTransaction<YangInstanceIdentifier, NormalizedNode<?, ?>> {
25
26     /**
27      * Reads data from provided logical data store located at the provided path.
28      *<p>
29      * If the target is a subtree, then the whole subtree is read (and will be
30      * accessible from the returned data object).
31      *
32      * @param store
33      *            Logical data store from which read should occur.
34      * @param path
35      *            Path which uniquely identifies subtree which client want to
36      *            read
37      * @return a CheckFuture containing the result of the read. The Future blocks until the
38      *         commit operation is complete. Once complete:
39      *         <ul>
40      *         <li>If the data at the supplied path exists, the Future returns an Optional object
41      *         containing the data.</li>
42      *         <li>If the data at the supplied path does not exist, the Future returns
43      *         Optional#absent().</li>
44      *         <li>If the read of the data fails, the Future will fail with a
45      *         {@link ReadFailedException} or an exception derived from ReadFailedException.</li>
46      *         </ul>
47      */
48     CheckedFuture<Optional<NormalizedNode<?,?>>, ReadFailedException> read(
49             LogicalDatastoreType store, YangInstanceIdentifier path);
50
51     /**
52      /**
53      * Checks if data is available in the logical data store located at provided path.
54      * <p>
55      *
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 }

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.