Clean Up Code around List Nodes

[cps.git] / cps-service / src / main / java / org / onap / cps / api / CpsDataService.java

diff --git a/cps-service/src/main/java/org/onap/cps/api/CpsDataService.java b/cps-service/src/main/java/org/onap/cps/api/CpsDataService.java
index 8552c6c..e6cb65f 100644 (file)
--- a/cps-service/src/main/java/org/onap/cps/api/CpsDataService.java
+++ b/cps-service/src/main/java/org/onap/cps/api/CpsDataService.java
@@ -1,13 +1,15 @@
 /*
- * ============LICENSE_START=======================================================
+ *  ============LICENSE_START=======================================================
  *  Copyright (C) 2020 Nordix Foundation
  *  Modifications Copyright (C) 2021 Pantheon.tech
+ *  Modifications Copyright (C) 2021 Bell Canada
  *  ================================================================================
  *  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.
@@ -20,11 +22,9 @@
 
 package org.onap.cps.api;
 
+import java.time.OffsetDateTime;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.onap.cps.spi.FetchDescendantsOption;
-import org.onap.cps.spi.exceptions.AlreadyDefinedException;
-import org.onap.cps.spi.exceptions.DataNodeNotFoundException;
-import org.onap.cps.spi.exceptions.DataValidationException;
 import org.onap.cps.spi.model.DataNode;
 
 /*
@@ -38,9 +38,10 @@ public interface CpsDataService {
      * @param dataspaceName dataspace name
      * @param anchorName    anchor name
      * @param jsonData      json data
-     * @throws DataValidationException when json data is invalid
+     * @param observedTimestamp observedTimestamp
      */
-    void saveData(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String jsonData);
+    void saveData(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String jsonData,
+        OffsetDateTime observedTimestamp);
 
     /**
      * Persists child data fragment under existing data node for the given anchor and dataspace.
@@ -49,12 +50,24 @@ public interface CpsDataService {
      * @param anchorName      anchor name
      * @param parentNodeXpath parent node xpath
      * @param jsonData        json data
-     * @throws DataValidationException   when json data is invalid
-     * @throws DataNodeNotFoundException when parent node cannot be found by parent node xpath
-     * @throws AlreadyDefinedException   when child data node with same xpath already exists
+     * @param observedTimestamp observedTimestamp
      */
     void saveData(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
-        @NonNull String jsonData);
+        @NonNull String jsonData, OffsetDateTime observedTimestamp);
+
+    /**
+     * Persists child data fragment representing one or more list elements under existing data node for the
+     * given anchor and dataspace.
+     *
+     * @param dataspaceName     dataspace name
+     * @param anchorName        anchor name
+     * @param parentNodeXpath   parent node xpath
+     * @param jsonData          json data representing list element(s)
+     * @param observedTimestamp observedTimestamp
+     */
+    void saveListElements(@NonNull String dataspaceName, @NonNull String anchorName,
+                              @NonNull String parentNodeXpath,
+                              @NonNull String jsonData, OffsetDateTime observedTimestamp);
 
     /**
      * Retrieves datanode by XPath for given dataspace and anchor.
@@ -76,9 +89,10 @@ public interface CpsDataService {
      * @param anchorName      anchor name
      * @param parentNodeXpath xpath to parent node
      * @param jsonData        json data
+     * @param observedTimestamp observedTimestamp
      */
     void updateNodeLeaves(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
-        @NonNull String jsonData);
+        @NonNull String jsonData, OffsetDateTime observedTimestamp);
 
     /**
      * Replaces existing data node content including descendants.
@@ -87,7 +101,46 @@ public interface CpsDataService {
      * @param anchorName      anchor name
      * @param parentNodeXpath xpath to parent node
      * @param jsonData        json data
+     * @param observedTimestamp observedTimestamp
      */
     void replaceNodeTree(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
-        @NonNull String jsonData);
+        @NonNull String jsonData, OffsetDateTime observedTimestamp);
+
+    /**
+     * Replaces list content by removing all existing elements and inserting the given new elements as json
+     * under given parent, anchor and dataspace.
+     *
+     * @param dataspaceName     dataspace name
+     * @param anchorName        anchor name
+     * @param parentNodeXpath   parent node xpath
+     * @param jsonData          json data representing the new list elements
+     * @param observedTimestamp observedTimestamp
+     */
+    void replaceListContent(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentNodeXpath,
+                            @NonNull String jsonData, OffsetDateTime observedTimestamp);
+
+    /**
+     * Deletes a list or a list-element under given anchor and dataspace.
+     *
+     * @param dataspaceName dataspace name
+     * @param anchorName    anchor name
+     * @param listElementXpath list element xpath
+     * @param observedTimestamp observedTimestamp
+     */
+    void deleteListOrListElement(@NonNull String dataspaceName, @NonNull String anchorName,
+                             @NonNull String listElementXpath, OffsetDateTime observedTimestamp);
+
+    /**
+     * Updates leaves of DataNode for given dataspace and anchor using xpath, along with the leaves of each Child Data
+     * Node which already exists. This method will throw an exception if data node update or any descendant update does
+     * not exist.
+     *
+     * @param dataspaceName         dataspace name
+     * @param anchorName            anchor name
+     * @param parentNodeXpath       xpath
+     * @param dataNodeUpdatesAsJson json data representing data node updates
+     * @param observedTimestamp observedTimestamp
+     */
+    void updateNodeLeavesAndExistingDescendantLeaves(String dataspaceName, String anchorName, String parentNodeXpath,
+        String dataNodeUpdatesAsJson, OffsetDateTime observedTimestamp);
 }