summaryrefslogtreecommitdiffstats
path: root/infra/data-api/src
diff options
context:
space:
mode:
Diffstat (limited to 'infra/data-api/src')
-rw-r--r--infra/data-api/src/main/java/io/fd/honeycomb/v3po/data/DataModification.java70
-rw-r--r--infra/data-api/src/main/java/io/fd/honeycomb/v3po/data/ModifiableDataManager.java33
-rw-r--r--infra/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableDataManager.java40
-rw-r--r--infra/data-api/src/main/yang/data-api.yang38
4 files changed, 181 insertions, 0 deletions
diff --git a/infra/data-api/src/main/java/io/fd/honeycomb/v3po/data/DataModification.java b/infra/data-api/src/main/java/io/fd/honeycomb/v3po/data/DataModification.java
new file mode 100644
index 0000000..d05c557
--- /dev/null
+++ b/infra/data-api/src/main/java/io/fd/honeycomb/v3po/data/DataModification.java
@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.fd.honeycomb.v3po.data;
+
+import com.google.common.annotations.Beta;
+import io.fd.honeycomb.v3po.translate.TranslationException;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
+
+/**
+ * Modification of a {@link ModifiableDataManager}.
+ */
+@Beta
+public interface DataModification extends ReadableDataManager {
+
+ /**
+ * Delete the node at specified path.
+ *
+ * @param path Node path
+ */
+ void delete(YangInstanceIdentifier path);
+
+ /**
+ * Merge the specified data with the currently-present data
+ * at specified path.
+ *
+ * @param path Node path
+ * @param data Data to be merged
+ */
+ void merge(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
+
+ /**
+ * Replace the data at specified path with supplied data.
+ *
+ * @param path Node path
+ * @param data New node data
+ */
+ void write(YangInstanceIdentifier path, NormalizedNode<?, ?> data);
+
+ /**
+ * Alters data tree using this modification.
+ *
+ * @throws DataValidationFailedException if modification data is not valid
+ * @throws TranslationException if failed while updating data tree state
+ */
+ void commit() throws DataValidationFailedException, TranslationException;
+
+ /**
+ * Validate and prepare modification before commit. Besides commit, no further operation is expected after validate
+ * and the behaviour is undefined.
+ *
+ * @throws DataValidationFailedException if modification data is not valid
+ */
+ void validate() throws DataValidationFailedException;
+}
diff --git a/infra/data-api/src/main/java/io/fd/honeycomb/v3po/data/ModifiableDataManager.java b/infra/data-api/src/main/java/io/fd/honeycomb/v3po/data/ModifiableDataManager.java
new file mode 100644
index 0000000..11cd513
--- /dev/null
+++ b/infra/data-api/src/main/java/io/fd/honeycomb/v3po/data/ModifiableDataManager.java
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.fd.honeycomb.v3po.data;
+
+import com.google.common.annotations.Beta;
+
+/**
+ * Facade over data tree that allows tree modification.
+ */
+@Beta
+public interface ModifiableDataManager extends ReadableDataManager {
+
+ /**
+ * Creates read-only snapshot of a ModifiableDataTree.
+ *
+ * @return modification
+ */
+ DataModification newModification();
+}
diff --git a/infra/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableDataManager.java b/infra/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableDataManager.java
new file mode 100644
index 0000000..0e98c09
--- /dev/null
+++ b/infra/data-api/src/main/java/io/fd/honeycomb/v3po/data/ReadableDataManager.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.fd.honeycomb.v3po.data;
+
+import com.google.common.annotations.Beta;
+import com.google.common.base.Optional;
+import com.google.common.util.concurrent.CheckedFuture;
+import javax.annotation.Nonnull;
+import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
+import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+
+/**
+ * Facade over data tree that allows reading tree nodes.
+ */
+@Beta
+public interface ReadableDataManager {
+
+ /**
+ * Reads a particular node from the data tree.
+ *
+ * @param path Path of the node
+ * @return a CheckFuture containing the result of the read.
+ */
+ CheckedFuture<Optional<NormalizedNode<?, ?>>, ReadFailedException> read(@Nonnull final YangInstanceIdentifier path);
+}
diff --git a/infra/data-api/src/main/yang/data-api.yang b/infra/data-api/src/main/yang/data-api.yang
new file mode 100644
index 0000000..693a73a
--- /dev/null
+++ b/infra/data-api/src/main/yang/data-api.yang
@@ -0,0 +1,38 @@
+module data-api {
+ yang-version 1;
+ namespace "urn:honeycomb:params:xml:ns:yang:data:api";
+ prefix "dapi";
+
+ import config { prefix config; revision-date 2013-04-05; }
+
+ description
+ "This module contains the base YANG data tree definitions
+ for data store modeling";
+
+ revision "2016-04-11" {
+ description
+ "Initial revision.";
+ }
+
+ identity data-tree {
+ base "config:service-type";
+ config:java-class org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
+ }
+
+ identity honeycomb-readable-data-tree {
+ base "config:service-type";
+ config:java-class io.fd.honeycomb.v3po.data.ReadableDataManager;
+ }
+
+ identity honeycomb-modifiable-data-tree {
+ base "config:service-type";
+ config:java-class io.fd.honeycomb.v3po.data.ModifiableDataManager;
+ }
+
+ typedef datatree-type {
+ type enumeration {
+ enum config;
+ enum oper;
+ }
+ }
+} \ No newline at end of file