Initial opendaylight infrastructure commit!!

[controller.git] / opendaylight / sal / yang-prototype / sal / sal-core-api / src / main / java / org / opendaylight / controller / sal / core / api / data / DataBrokerService.java

diff --git a/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/data/DataBrokerService.java b/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/data/DataBrokerService.java
new file mode 100644 (file)
index 0000000..f5f3938
--- /dev/null
+++ b/opendaylight/sal/yang-prototype/sal/sal-core-api/src/main/java/org/opendaylight/controller/sal/core/api/data/DataBrokerService.java
@@ -0,0 +1,132 @@
+/*\r
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
+ *\r
+ * This program and the accompanying materials are made available under the\r
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
+ * and is available at http://www.eclipse.org/legal/epl-v10.html\r
+ */\r
+package org.opendaylight.controller.sal.core.api.data;\r
+\r
+import java.util.concurrent.Future;\r
+\r
+import org.opendaylight.controller.sal.common.DataStoreIdentifier;\r
+import org.opendaylight.controller.sal.core.api.BrokerService;\r
+import org.opendaylight.controller.sal.core.api.Consumer;\r
+import org.opendaylight.controller.sal.core.api.Provider;\r
+import org.opendaylight.controller.yang.common.RpcResult;\r
+import org.opendaylight.controller.yang.data.api.CompositeNode;\r
+import org.opendaylight.controller.yang.data.api.CompositeNodeModification;\r
+import org.opendaylight.controller.yang.data.api.Node;\r
+\r
+\r
+/**\r
+ * DataBrokerService provides unified access to the data stores available in the\r
+ * system.\r
+ * \r
+ * \r
+ * @see DataProviderService\r
+ * \r
+ */\r
+public interface DataBrokerService extends BrokerService {\r
+\r
+    /**\r
+     * Returns a data from specified Data Store.\r
+     * \r
+     * Returns all the data visible to the consumer from specified Data Store.\r
+     * \r
+     * @param store\r
+     *            Identifier of the store, from which will be data retrieved\r
+     * @return data visible to the consumer\r
+     */\r
+    CompositeNode getData(DataStoreIdentifier store);\r
+\r
+    /**\r
+     * Returns a filtered subset of data from specified Data Store.\r
+     * \r
+     * <p>\r
+     * The filter is modeled as an hierarchy of {@link Node} starting with\r
+     * {@link CompositeNode} representing data root. The semantics of the filter\r
+     * tree is the same as filter semantics defined in the NETCONF protocol for\r
+     * rpc operations <code>get</code> and <code>get-config</code> in Section 6\r
+     * of RFC6241.\r
+     * \r
+     * \r
+     * @see http://tools.ietf.org/html/rfc6241#section-6\r
+     * @param store\r
+     *            Identifier of the store, from which will be data retrieved\r
+     * @param filter\r
+     *            Data tree filter similar to the NETCONF filter\r
+     * @return\r
+     */\r
+    CompositeNode getData(DataStoreIdentifier store, CompositeNode filter);\r
+\r
+    /**\r
+     * Returns a candidate data which are not yet commited.\r
+     * \r
+     * \r
+     * @param store\r
+     *            Identifier of the store, from which will be data retrieved\r
+     * @return\r
+     */\r
+    CompositeNode getCandidateData(DataStoreIdentifier store);\r
+\r
+    /**\r
+     * Returns a filtered subset of candidate data from specified Data Store.\r
+     * \r
+     * <p>\r
+     * The filter is modeled as an hierarchy of {@link Node} starting with\r
+     * {@link CompositeNode} representing data root. The semantics of the filter\r
+     * tree is the same as filter semantics defined in the NETCONF protocol for\r
+     * rpc operations <code>get</code> and <code>get-config</code> in Section 6\r
+     * of RFC6241.\r
+     * \r
+     * \r
+     * @see http://tools.ietf.org/html/rfc6241#section-6\r
+     * @param store\r
+     *            Identifier of the store, from which will be data retrieved\r
+     * @param filter\r
+     *            A CompositeNode filter\r
+     * @return\r
+     */\r
+    CompositeNode getCandidateData(DataStoreIdentifier store,\r
+            CompositeNode filter);\r
+\r
+    /**\r
+     * \r
+     * @param store\r
+     *            Identifier of the store, in which will be the candidate data\r
+     *            modified\r
+     * @param changeSet\r
+     *            Modification of data tree.\r
+     * @return Result object containing the modified data tree if the operation\r
+     *         was successful, otherwise list of the encountered errors.\r
+     */\r
+    RpcResult<CompositeNode> editCandidateData(DataStoreIdentifier store,\r
+            CompositeNodeModification changeSet);\r
+\r
+    /**\r
+     * Initiates a two-phase commit of candidate data.\r
+     * \r
+     * <p>\r
+     * The {@link Consumer} could initiate a commit of candidate data\r
+     * \r
+     * <p>\r
+     * The successful commit changes the state of the system and may affect\r
+     * several components.\r
+     * \r
+     * <p>\r
+     * The effects of successful commit of data are described in the\r
+     * specifications and YANG models describing the {@link Provider} components\r
+     * of controller. It is assumed that {@link Consumer} has an understanding\r
+     * of this changes.\r
+     * \r
+     * \r
+     * @see DataCommitHandler for further information how two-phase commit is\r
+     *      processed.\r
+     * @param store\r
+     *            Identifier of the store, where commit should occur.\r
+     * @return Result of the commit, containing success information or list of\r
+     *         encountered errors, if commit was not successful.\r
+     */\r
+    Future<RpcResult<Void>> commit(DataStoreIdentifier store);\r
+}\r