cps-service/src/main/java/org/onap/cps/spi/CpsDataPersistenceService.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020-2023 Nordix Foundation.
   4  *  Modifications Copyright (C) 2021 Pantheon.tech
   5  *  Modifications Copyright (C) 2022 Bell Canada
   6  *  Modifications Copyright (C) 2022-2023 TechMahindra Ltd.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  *
  20  * SPDX-License-Identifier: Apache-2.0
  21  * ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.cps.spi;
  25
  26 import java.io.Serializable;
  27 import java.util.Collection;
  28 import java.util.List;
  29 import java.util.Map;
  30 import org.onap.cps.spi.model.DataNode;
  31
  32 /*
  33     Data Store interface that is responsible for handling yang data.
  34     Please follow guidelines in https://gerrit.nordix.org/#/c/onap/ccsdk/features/+/6698/19/cps/interface-proposal/src/main/java/cps/javadoc/spi/DataStoreService.java
  35     when adding methods.
  36  */
  37 public interface CpsDataPersistenceService {
  38
  39
  40     /**
  41      * Store a datanode.
  42      *
  43      * @param dataspaceName dataspace name
  44      * @param anchorName    anchor name
  45      * @param dataNode      data node
  46      * @deprecated Please use {@link #storeDataNodes(String, String, Collection)} as it supports multiple data nodes.
  47      */
  48     @Deprecated
  49     void storeDataNode(String dataspaceName, String anchorName, DataNode dataNode);
  50
  51     /**
  52      * Store multiple datanodes at once.
  53      * @param dataspaceName dataspace name
  54      * @param anchorName    anchor name
  55      * @param dataNodes     data nodes
  56      */
  57     void storeDataNodes(String dataspaceName, String anchorName, Collection<DataNode> dataNodes);
  58
  59     /**
  60      * Add a child to a Fragment.
  61      *
  62      * @param dataspaceName dataspace name
  63      * @param anchorName    anchor name
  64      * @param parentXpath   parent xpath
  65      * @param dataNode      dataNode
  66      */
  67     void addChildDataNode(String dataspaceName, String anchorName, String parentXpath, DataNode dataNode);
  68
  69     /**
  70      * Add multiple children to a Fragment.
  71      *
  72      * @param dataspaceName dataspace name
  73      * @param anchorName    anchor name
  74      * @param parentXpath   parent xpath
  75      * @param dataNodes     collection of dataNodes
  76      */
  77     void addChildDataNodes(String dataspaceName, String anchorName, String parentXpath, Collection<DataNode> dataNodes);
  78
  79     /**
  80      * Adds list child elements to a Fragment.
  81      *
  82      * @param dataspaceName          dataspace name
  83      * @param anchorName             anchor name
  84      * @param parentNodeXpath        parent node xpath
  85      * @param listElementsCollection collection of data nodes representing list elements
  86      */
  87     void addListElements(String dataspaceName, String anchorName, String parentNodeXpath,
  88         Collection<DataNode> listElementsCollection);
  89
  90     /**
  91      * Add multiple lists of data nodes to a parent node at the same time.
  92      *
  93      * @param dataspaceName           dataspace name
  94      * @param anchorName              anchor name
  95      * @param parentNodeXpath         parent node xpath
  96      * @param newLists collections of lists of data nodes representing list elements
  97      */
  98     void addMultipleLists(String dataspaceName, String anchorName, String parentNodeXpath,
  99             Collection<Collection<DataNode>> newLists);
 100
 101     /**
 102      * Retrieves multiple datanodes for a single XPath for given dataspace and anchor.
 103      * Multiple data nodes are returned when xPath is set to root '/', otherwise single data node
 104      * is returned when a specific xpath is used (Example: /bookstore).
 105      *
 106      * @param dataspaceName          dataspace name
 107      * @param anchorName             anchor name
 108      * @param xpath                  one xpath
 109      * @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
 110      *                               (recursively) as well
 111      * @return collection of data node object
 112      */
 113     Collection<DataNode> getDataNodes(String dataspaceName, String anchorName, String xpath,
 114                                       FetchDescendantsOption fetchDescendantsOption);
 115
 116     /**
 117      * Retrieves multiple datanodes for multiple XPaths, given a dataspace and anchor.
 118      *
 119      * @param dataspaceName           dataspace name
 120      * @param anchorName              anchor name
 121      * @param xpaths                  collection of xpaths
 122      * @param fetchDescendantsOption  defines the scope of data to fetch: either single node or all the descendant nodes
 123      *                                (recursively) as well
 124      * @return collection of data node object
 125      */
 126     Collection<DataNode> getDataNodesForMultipleXpaths(String dataspaceName, String anchorName,
 127                                                        Collection<String> xpaths,
 128                                                        FetchDescendantsOption fetchDescendantsOption);
 129
 130     /**
 131      * Updates leaves for existing data node.
 132      *
 133      * @param dataspaceName dataspace name
 134      * @param anchorName    anchor name
 135      * @param xpath         xpath
 136      * @param leaves        the leaves as a map where key is a leaf name and a value is a leaf value
 137      */
 138     void updateDataLeaves(String dataspaceName, String anchorName, String xpath, Map<String, Serializable> leaves);
 139
 140     /**
 141      * Replaces an existing data node's content including descendants.
 142      *
 143      * @param dataspaceName dataspace name
 144      * @param anchorName    anchor name
 145      * @param dataNode      data node
 146      */
 147     void updateDataNodeAndDescendants(String dataspaceName, String anchorName, DataNode dataNode);
 148
 149     /**
 150      * Replaces multiple existing data nodes' content including descendants in a batch operation.
 151      *
 152      * @param dataspaceName dataspace name
 153      * @param anchorName    anchor name
 154      * @param dataNodes     data nodes
 155      */
 156     void updateDataNodesAndDescendants(String dataspaceName, String anchorName, final List<DataNode> dataNodes);
 157
 158     /**
 159      * Replaces list content by removing all existing elements and inserting the given new elements
 160      * under given parent, anchor and dataspace.
 161      *
 162      * @param dataspaceName   dataspace name
 163      * @param anchorName      anchor name
 164      * @param parentNodeXpath parent node xpath
 165      * @param newListElements collection of data nodes representing the new list content
 166      */
 167     void replaceListContent(String dataspaceName, String anchorName,
 168                             String parentNodeXpath, Collection<DataNode> newListElements);
 169
 170     /**
 171      * Deletes any dataNode, yang container or yang list or yang list element.
 172      *
 173      * @param dataspaceName   dataspace name
 174      * @param anchorName      anchor name
 175      * @param targetXpath     xpath to list or list element (include [@key=value] to delete a single list element)
 176      */
 177     void deleteDataNode(String dataspaceName, String anchorName, String targetXpath);
 178
 179     /**
 180      * Deletes multiple dataNode, yang container or yang list or yang list element.
 181      *
 182      * @param dataspaceName   dataspace name
 183      * @param anchorName      anchor name
 184      * @param targetXpaths    xpaths of nodes to delete
 185      */
 186     void deleteDataNodes(String dataspaceName, String anchorName, Collection<String> targetXpaths);
 187
 188     /**
 189      * Deletes all dataNodes in a given anchor.
 190      *
 191      * @param dataspaceName   dataspace name
 192      * @param anchorName      anchor name
 193      */
 194     void deleteDataNodes(String dataspaceName, String anchorName);
 195
 196     /**
 197      * Deletes a single existing list element or the whole list.
 198      *
 199      * @param dataspaceName   dataspace name
 200      * @param anchorName      anchor name
 201      * @param targetXpath     xpath to list or list element (include [@key=value] to delete a single list element)
 202      */
 203     void deleteListDataNode(String dataspaceName, String anchorName, String targetXpath);
 204
 205     /**
 206      * Get a datanode by cps path.
 207      *
 208      * @param dataspaceName          dataspace name
 209      * @param anchorName             anchor name
 210      * @param cpsPath                cps path
 211      * @param fetchDescendantsOption defines whether the descendants of the node(s) found by the query should be
 212      *                               included in the output
 213      * @return the data nodes found i.e. 0 or more data nodes
 214      */
 215     List<DataNode> queryDataNodes(String dataspaceName, String anchorName,
 216                                   String cpsPath, FetchDescendantsOption fetchDescendantsOption);
 217
 218     /**
 219      * Starts a session which allows use of locks and batch interaction with the persistence service.
 220      *
 221      * @return Session ID string
 222      */
 223     String startSession();
 224
 225     /**
 226      * Close session.
 227      *
 228      * @param sessionId session ID
 229      */
 230     void closeSession(String sessionId);
 231
 232     /**
 233      * Lock anchor.
 234      * To release locks(s), the session holding the lock(s) must be closed.
 235      *
 236      * @param sessionID session ID
 237      * @param dataspaceName dataspace name
 238      * @param anchorName anchor name
 239      * @param timeoutInMilliseconds lock attempt timeout in milliseconds
 240      */
 241     void lockAnchor(String sessionID, String dataspaceName, String anchorName, Long timeoutInMilliseconds);
 242 }