X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-common-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fmd%2Fsal%2Fcommon%2Fapi%2Fdata%2FAsyncDataBroker.java;h=26935f2df8c07cbc4472a85a183768967d1970f3;hb=0f69f9e83ca8602d7ad7646ff4e146f802c534c1;hp=87bbfd3d065a374e729c5f4e894bc4f40ddb17f9;hpb=88f3fac27f5dbc4043cdeadacaca34bd6f57c854;p=controller.git diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataBroker.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataBroker.java index 87bbfd3d06..26935f2df8 100644 --- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataBroker.java +++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/data/AsyncDataBroker.java @@ -7,62 +7,58 @@ */ package org.opendaylight.controller.md.sal.common.api.data; -import org.opendaylight.yangtools.concepts.ListenerRegistration; import org.opendaylight.yangtools.concepts.Path; -public interface AsyncDataBroker
, D, L extends AsyncDataChangeListener
> extends // - AsyncDataTransactionFactory
{ - - /** - * - * Scope of Data Change - * - * Represents scope of data change (addition, replacement, deletion). - * - * The terminology for types is reused from LDAP - * - * @see http://www.idevelopment.info/data/LDAP/LDAP_Resources/SEARCH_Setting_the_SCOPE_Parameter.shtml - */ - public enum DataChangeScope { - - /** - * Represents only a direct change of the node, such as replacement of node, - * addition or deletion. - * - */ - BASE, - /** - * Represent a change (addition,replacement,deletion) - * of the node or one of it's direct childs. - * - */ - ONE, - /** - * Represents a change of the node or any of it's child nodes. - * - */ - SUBTREE - } +/** + * Base interface that provides access to a conceptual data tree store and also provides the ability to + * subscribe for changes to data under a given branch of the tree. + * + *
+ * All operations on the data tree are performed via one of the transactions: + *
+ * These transactions provide a stable isolated view of data tree, which is + * guaranteed to be not affected by other concurrent transactions, until + * transaction is committed. + * + *
+ * For a detailed explanation of how transaction are isolated and how transaction-local + * changes are committed to global data tree, see + * {@link AsyncReadTransaction}, {@link AsyncWriteTransaction}, + * {@link AsyncReadWriteTransaction} and {@link AsyncWriteTransaction#submit()}. + * + * + *
+ * It is strongly recommended to use the type of transaction, which + * provides only the minimal capabilities you need. This allows for + * optimizations at the data broker / data store level. For example, + * implementations may optimize the transaction for reading if they know ahead + * of time that you only need to read data - such as not keeping additional meta-data, + * which may be required for write transactions. + * + *
+ * Implementation Note: This interface is not intended to be implemented + * by users of MD-SAL, but only to be consumed by them. + * + * @param
+ * Type of path (subtree identifier), which represents location in
+ * tree
+ * @param , D> extends AsyncDataTransactionFactory {
@Override
- public AsyncReadTransaction newReadOnlyTransaction();
+ AsyncReadOnlyTransaction newReadOnlyTransaction();
@Override
- public AsyncReadWriteTransaction newReadWriteTransaction();
+ AsyncReadWriteTransaction newReadWriteTransaction();
@Override
- public AsyncWriteTransaction newWriteOnlyTransaction();
-
- /**
- * Registers {@link DataChangeListener} for Data Change callbacks
- * which will be triggered on which will be triggered on the store
- *
- *Â @param store Logical store in which listener is registered.
- * @param path Path (subtree identifier) on which client listener will be invoked.
- * @param listener Instance of listener which should be invoked on
- * @param triggeringScope Scope of change which triggers callback.
- * @return Listener registration of the listener, call {@link ListenerRegistration#close()}
- * to stop delivery of change events.
- */
- ListenerRegistration newWriteOnlyTransaction();
}