/*
* ============LICENSE_START=======================================================
- * Copyright (C) 2020-2022 Nordix Foundation.
+ * Copyright (C) 2020-2023 Nordix Foundation.
* Modifications Copyright (C) 2021 Pantheon.tech
* Modifications Copyright (C) 2022 Bell Canada
+ * Modifications Copyright (C) 2022-2023 TechMahindra Ltd.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
public interface CpsDataPersistenceService {
/**
- * Store a datanode.
- *
+ * Store multiple datanodes at once.
* @param dataspaceName dataspace name
* @param anchorName anchor name
- * @param dataNode data node
+ * @param dataNodes data nodes
*/
- void storeDataNode(String dataspaceName, String anchorName, DataNode dataNode);
+ void storeDataNodes(String dataspaceName, String anchorName, Collection<DataNode> dataNodes);
+
/**
- * Add a child to a Fragment.
+ * Add multiple children to a Fragment.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
* @param parentXpath parent xpath
- * @param dataNode dataNode
+ * @param dataNodes collection of dataNodes
*/
- void addChildDataNode(String dataspaceName, String anchorName, String parentXpath, DataNode dataNode);
+ void addChildDataNodes(String dataspaceName, String anchorName, String parentXpath, Collection<DataNode> dataNodes);
/**
* Adds list child elements to a Fragment.
* @param parentNodeXpath parent node xpath
* @param listElementsCollection collection of data nodes representing list elements
*/
-
void addListElements(String dataspaceName, String anchorName, String parentNodeXpath,
Collection<DataNode> listElementsCollection);
Collection<Collection<DataNode>> newLists);
/**
- * Retrieves datanode by XPath for given dataspace and anchor.
+ * Retrieves multiple datanodes for a single XPath for given dataspace and anchor.
+ * Multiple data nodes are returned when xPath is set to root '/', otherwise single data node
+ * is returned when a specific xpath is used (Example: /bookstore).
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
- * @param xpath xpath
+ * @param xpath one xpath
* @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
* (recursively) as well
- * @return data node object
+ * @return collection of data node object
*/
- DataNode getDataNode(String dataspaceName, String anchorName, String xpath,
- FetchDescendantsOption fetchDescendantsOption);
+ Collection<DataNode> getDataNodes(String dataspaceName, String anchorName, String xpath,
+ FetchDescendantsOption fetchDescendantsOption);
/**
- * Updates leaves for existing data node.
+ * Retrieves multiple datanodes for multiple XPaths, given a dataspace and anchor.
*
- * @param dataspaceName dataspace name
- * @param anchorName anchor name
- * @param xpath xpath
- * @param leaves the leaves as a map where key is a leaf name and a value is a leaf value
+ * @param dataspaceName dataspace name
+ * @param anchorName anchor name
+ * @param xpaths collection of xpaths
+ * @param fetchDescendantsOption defines the scope of data to fetch: either single node or all the descendant nodes
+ * (recursively) as well
+ * @return collection of data node object
*/
- void updateDataLeaves(String dataspaceName, String anchorName, String xpath, Map<String, Serializable> leaves);
+ Collection<DataNode> getDataNodesForMultipleXpaths(String dataspaceName, String anchorName,
+ Collection<String> xpaths,
+ FetchDescendantsOption fetchDescendantsOption);
/**
- * Replaces an existing data node's content including descendants.
+ * Updates data leaves for multiple data nodes.
*
- * @param dataspaceName dataspace name
- * @param anchorName anchor name
- * @param dataNode data node
+ * @param dataspaceName dataspace name
+ * @param anchorName anchor name
+ * @param updatedLeavesPerXPath Map of xPaths to updated leaf nodes
*/
- void updateDataNodeAndDescendants(String dataspaceName, String anchorName, DataNode dataNode);
+ void batchUpdateDataLeaves(String dataspaceName, String anchorName,
+ Map<String, Map<String, Serializable>> updatedLeavesPerXPath);
/**
* Replaces multiple existing data nodes' content including descendants in a batch operation.
* @param anchorName anchor name
* @param dataNodes data nodes
*/
- void updateDataNodesAndDescendants(String dataspaceName, String anchorName, final List<DataNode> dataNodes);
+ void updateDataNodesAndDescendants(String dataspaceName, String anchorName, final Collection<DataNode> dataNodes);
/**
* Replaces list content by removing all existing elements and inserting the given new elements
*/
void deleteDataNode(String dataspaceName, String anchorName, String targetXpath);
+ /**
+ * Deletes multiple dataNode, yang container or yang list or yang list element.
+ *
+ * @param dataspaceName dataspace name
+ * @param anchorName anchor name
+ * @param targetXpaths xpaths of nodes to delete
+ */
+ void deleteDataNodes(String dataspaceName, String anchorName, Collection<String> targetXpaths);
+
/**
* Deletes all dataNodes in a given anchor.
*
void deleteDataNodes(String dataspaceName, String anchorName);
/**
- * Deletes existing a single list element or the whole list.
+ * Deletes all dataNodes in multiple anchors.
+ *
+ * @param dataspaceName dataspace name
+ * @param anchorNames anchor names
+ */
+ void deleteDataNodes(String dataspaceName, Collection<String> anchorNames);
+
+ /**
+ * Deletes a single existing list element or the whole list.
*
* @param dataspaceName dataspace name
* @param anchorName anchor name
List<DataNode> queryDataNodes(String dataspaceName, String anchorName,
String cpsPath, FetchDescendantsOption fetchDescendantsOption);
+ /**
+ * Get a datanode by dataspace name and cps path across all anchors.
+ *
+ * @param dataspaceName dataspace name
+ * @param cpsPath cps path
+ * @param fetchDescendantsOption defines whether the descendants of the node(s) found by the query should be
+ * included in the output
+ * @return the data nodes found i.e. 0 or more data nodes
+ */
+ List<DataNode> queryDataNodesAcrossAnchors(String dataspaceName,
+ String cpsPath, FetchDescendantsOption fetchDescendantsOption);
+
+
/**
* Starts a session which allows use of locks and batch interaction with the persistence service.
*
Code Review / cps.git / blobdiff