528324151710fdf8abd1c670c05f3de38744a04d
[controller.git] / opendaylight / md-sal / sal-common-api / src / main / java / org / opendaylight / controller / md / sal / common / api / data / AsyncDataBroker.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.common.api.data;
9
10 import org.opendaylight.yangtools.concepts.ListenerRegistration;
11 import org.opendaylight.yangtools.concepts.Path;
12
13 /**
14  *
15  * Base interface that provides access to a conceptual data tree store and also provides the ability to
16  * subscribe for changes to data under a given branch of the tree.
17  *
18  * <p>
19  * All operations on the data tree are performed via one of the transactions:
20  * <ul>
21  * <li>Read-Only - allocated using {@link #newReadOnlyTransaction()}
22  * <li>Write-Only - allocated using {@link #newWriteOnlyTransaction()}
23  * <li>Read-Write - allocated using {@link #newReadWriteTransaction()}
24  * </ul>
25  *
26  * <p>
27  * These transactions provide a stable isolated view of data tree, which is
28  * guaranteed to be not affected by other concurrent transactions, until
29  * transaction is committed.
30  *
31  * <p>
32  * For a detailed explanation of how transaction are isolated and how transaction-local
33  * changes are committed to global data tree, see
34  * {@link AsyncReadTransaction}, {@link AsyncWriteTransaction},
35  * {@link AsyncReadWriteTransaction} and {@link AsyncWriteTransaction#commit()}.
36  *
37  *
38  * <p>
39  * It is strongly recommended to use the type of transaction, which
40  * provides only the minimal capabilities you need. This allows for
41  * optimizations at the data broker / data store level. For example,
42  * implementations may optimize the transaction for reading if they know ahead
43  * of time that you only need to read data - such as not keeping additional meta-data,
44  * which may be required for write transactions.
45  *
46  * <p>
47  * <b>Implementation Note:</b> This interface is not intended to be implemented
48  * by users of MD-SAL, but only to be consumed by them.
49  *
50  * @param <P>
51  *            Type of path (subtree identifier), which represents location in
52  *            tree
53  * @param <D>
54  *            Type of data (payload), which represents data payload
55  */
56 public interface AsyncDataBroker<P extends Path<P>, D, L extends AsyncDataChangeListener<P, D>> extends //
57         AsyncDataTransactionFactory<P, D> {
58
59     /**
60      *
61      * Scope of Data Change
62      *
63      * <p>
64      * Represents scope of data change (addition, replacement, deletion).
65      *
66      * The terminology for scope types is reused from LDAP.
67      *
68      * <h2>Examples</h2>
69      *
70      * Following is an example model with comments describing what notifications
71      * you would receive based on the scope you specify, when you are
72      * registering for changes on container a.
73      *
74      * <pre>
75      * container a              // scope BASE, ONE, SUBTREE
76      *    leaf "foo"            // scope ONE, SUBTREE
77      *    container             // scope ONE, SUBTREE
78      *       leaf  "bar"        // scope SUBTREE
79      *    list list             // scope ONE, SUBTREE
80      *      list [a]            // scope SUBTREE
81      *        id "a"            // scope SUBTREE
82      *      list [b]            // scope SUBTREE
83      *        id "b"            // scope SUBTREE
84      * </pre>
85      *
86      * Following is an example model with comments describing what notifications
87      * you would receive based on the scope you specify, when you are
88      * registering for changes on list list (without specifying concrete item in
89      * the list).
90      *
91      * <pre>
92      *  list list               // scope BASE, ONE, SUBTREE
93      *      list [a]            // scope ONE, SUBTREE
94      *        id "a"            // scope SUBTREE
95      *      list [b]            // scope ONE, SUBTREE
96      *        id "b"            // scope SUBTREE
97      * </pre>
98      *
99      *
100      * @see <a href="http://www.idevelopment.info/data/LDAP/LDAP_Resources/SEARCH_Setting_the_SCOPE_Parameter.shtml">LDAP</a>
101      */
102     enum DataChangeScope {
103
104         /**
105          * Represents only a direct change of the node, such as replacement of a node, addition or
106          * deletion. Note that, as described in {@link #ONE}, this may have counterintuitive
107          * interactions when viewed from a <i>binding aware</i> application, in particular when it
108          * pertains to lists.
109          *
110          */
111         BASE,
112         /**
113          * Represent a change (addition,replacement,deletion) of the node or one of its direct
114          * children.
115          * <p>
116          * Note that this is done in the <i>binding independent</i> data tree and so the behavior
117          * might be counterintuitive when used with <i>binding aware</i> interfaces particularly
118          * when it comes to lists. The list itself is a node in the <i>binding independent</i> tree,
119          * which means that if you want to listen on new elements you must listen on the list itself
120          * with the scope of {@link #ONE}.
121          * <p>
122          * As an example, in the below YANG snippet, listening on <tt>node</tt> with scope
123          * {@link #ONE} would tell you if the <tt>node-connector</tt> list was created or deleted,
124          * but not when elements were added or removed from the list assuming the list itself
125          * already existed.
126          *
127          * <pre>
128          * container nodes {
129          *   list node {
130          *     key "id";
131          *     leaf id {
132          *       type string;
133          *     }
134          *     list node-connector {
135          *       leaf id {
136          *         type string;
137          *       }
138          *     }
139          *   }
140          * }
141          * </pre>
142          *
143          * This scope is superset of {@link #BASE}.
144          *
145          */
146         ONE,
147         /**
148          * Represents a change of the node or any of or any of its child nodes,
149          * direct and nested.
150          *
151          * This scope is superset of {@link #ONE} and {@link #BASE}.
152          *
153          */
154         SUBTREE
155     }
156
157     /**
158      * {@inheritDoc}
159      */
160     @Override
161     AsyncReadOnlyTransaction<P, D> newReadOnlyTransaction();
162
163     /**
164      * {@inheritDoc}
165      */
166     @Override
167     AsyncReadWriteTransaction<P, D> newReadWriteTransaction();
168
169     /**
170      * {@inheritDoc}
171      */
172     @Override
173     AsyncWriteTransaction<P, D> newWriteOnlyTransaction();
174
175     /**
176      * Registers a {@link AsyncDataChangeListener} to receive
177      * notifications when data changes under a given path in the conceptual data
178      * tree.
179      * <p>
180      * You are able to register for notifications  for any node or subtree
181      * which can be reached via the supplied path.
182      * <p>
183      * If path type <code>P</code> allows it, you may specify paths up to the leaf nodes
184      * then it is possible to listen on leaf nodes.
185      * <p>
186      * You are able to register for data change notifications for a subtree even
187      * if it does not exist. You will receive notification once that node is
188      * created.
189      * <p>
190      * If there is any preexisting data in data tree on path for which you are
191      * registering, you will receive initial data change event, which will
192      * contain all preexisting data, marked as created.
193      *
194      * <p>
195      * You are also able to specify the scope of the changes you want to be
196      * notified.
197      * <p>
198      * Supported scopes are:
199      * <ul>
200      * <li>{@link DataChangeScope#BASE} - notification events will only be
201      * triggered when a node referenced by path is created, removed or replaced.
202      * <li>{@link DataChangeScope#ONE} - notifications events will only be
203      * triggered when a node referenced by path is created, removed or replaced,
204      * or any or any of its immediate children are created, updated or removed.
205      * <li>{@link DataChangeScope#SUBTREE} - notification events will be
206      * triggered when a node referenced by the path is created, removed
207      * or replaced or any of the children in its subtree are created, removed
208      * or replaced.
209      * </ul>
210      * See {@link DataChangeScope} for examples.
211      * <p>
212      * This method returns a {@link ListenerRegistration} object. To
213      * "unregister" your listener for changes call the "close" method on this
214      * returned object.
215      * <p>
216      * You MUST call close when you no longer need to receive notifications
217      * (such as during shutdown or for example if your bundle is shutting down).
218      *
219      * @param store
220      *            Logical Data Store - Logical Datastore you want to listen for
221      *            changes in. For example
222      *            {@link LogicalDatastoreType#OPERATIONAL} or
223      *            {@link LogicalDatastoreType#CONFIGURATION}
224      * @param path
225      *            Path (subtree identifier) on which client listener will be
226      *            invoked.
227      * @param listener
228      *            Instance of listener which should be invoked on
229      * @param triggeringScope
230      *            Scope of change which triggers callback.
231      * @return Listener registration object, which may be used to unregister
232      *         your listener using {@link ListenerRegistration#close()} to stop
233      *         delivery of change events.
234      */
235     @Deprecated
236     default ListenerRegistration<L> registerDataChangeListener(LogicalDatastoreType store, P path, L listener,
237             DataChangeScope triggeringScope) {
238         throw new UnsupportedOperationException("Data change listeners are no longer supported.");
239     }
240 }

©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.