X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-service%2Fsrc%2Fmain%2Fjava%2Forg%2Fonap%2Fcps%2Fspi%2FCpsDataPersistenceService.java;h=d28a3339fec60c896787af18c0561292f81572a8;hb=ec061d5caba23c76f0cdc183c1f5a37e0c11b6c7;hp=97aecaafd126c386e20e686a0733ee255c40d7ad;hpb=1f77f638a8da07d766c8c6d276e7170b24828f85;p=cps.git diff --git a/cps-service/src/main/java/org/onap/cps/spi/CpsDataPersistenceService.java b/cps-service/src/main/java/org/onap/cps/spi/CpsDataPersistenceService.java index 97aecaafd..d28a3339f 100644 --- a/cps-service/src/main/java/org/onap/cps/spi/CpsDataPersistenceService.java +++ b/cps-service/src/main/java/org/onap/cps/spi/CpsDataPersistenceService.java @@ -1,7 +1,9 @@ -/*- +/* * ============LICENSE_START======================================================= - * Copyright (C) 2020 Nordix Foundation. All rights reserved. + * 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. @@ -21,7 +23,10 @@ package org.onap.cps.spi; -import org.checkerframework.checker.nullness.qual.NonNull; +import java.io.Serializable; +import java.util.Collection; +import java.util.List; +import java.util.Map; import org.onap.cps.spi.model.DataNode; /* @@ -32,14 +37,12 @@ import org.onap.cps.spi.model.DataNode; 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(@NonNull String dataspaceName, @NonNull String anchorName, - @NonNull DataNode dataNode); + void storeDataNodes(String dataspaceName, String anchorName, Collection dataNodes); /** * Add a child to a Fragment. @@ -49,19 +52,191 @@ public interface CpsDataPersistenceService { * @param parentXpath parent xpath * @param dataNode dataNode */ - void addChildDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String parentXpath, - @NonNull DataNode dataNode); + void addChildDataNode(String dataspaceName, String anchorName, String parentXpath, DataNode dataNode); /** - * Retrieves datanode by XPath for given dataspace and anchor. + * Add multiple children to a Fragment. + * + * @param dataspaceName dataspace name + * @param anchorName anchor name + * @param parentXpath parent xpath + * @param dataNodes collection of dataNodes + */ + void addChildDataNodes(String dataspaceName, String anchorName, String parentXpath, Collection dataNodes); + + /** + * Adds list child elements to a Fragment. * * @param dataspaceName dataspace name * @param anchorName anchor name - * @param xpath xpath + * @param parentNodeXpath parent node xpath + * @param listElementsCollection collection of data nodes representing list elements + */ + void addListElements(String dataspaceName, String anchorName, String parentNodeXpath, + Collection listElementsCollection); + + /** + * Add multiple lists of data nodes to a parent node at the same time. + * + * @param dataspaceName dataspace name + * @param anchorName anchor name + * @param parentNodeXpath parent node xpath + * @param newLists collections of lists of data nodes representing list elements + */ + void addMultipleLists(String dataspaceName, String anchorName, String parentNodeXpath, + Collection> newLists); + + /** + * 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 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 + */ + Collection getDataNodes(String dataspaceName, String anchorName, String xpath, + FetchDescendantsOption fetchDescendantsOption); + + /** + * Retrieves multiple datanodes for multiple XPaths, given a dataspace and anchor. + * + * @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 + */ + Collection getDataNodesForMultipleXpaths(String dataspaceName, String anchorName, + Collection xpaths, + FetchDescendantsOption fetchDescendantsOption); + + /** + * Updates leaves for existing data node. + * + * @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 + */ + void updateDataLeaves(String dataspaceName, String anchorName, String xpath, Map leaves); + + /** + * Replaces multiple existing data nodes' content including descendants in a batch operation. + * + * @param dataspaceName dataspace name + * @param anchorName anchor name + * @param dataNodes data nodes + */ + void updateDataNodesAndDescendants(String dataspaceName, String anchorName, final Collection dataNodes); + + /** + * Replaces list content by removing all existing elements and inserting the given new elements + * under given parent, anchor and dataspace. + * + * @param dataspaceName dataspace name + * @param anchorName anchor name + * @param parentNodeXpath parent node xpath + * @param newListElements collection of data nodes representing the new list content + */ + void replaceListContent(String dataspaceName, String anchorName, + String parentNodeXpath, Collection newListElements); + + /** + * Deletes any dataNode, yang container or yang list or yang list element. + * + * @param dataspaceName dataspace name + * @param anchorName anchor name + * @param targetXpath xpath to list or list element (include [@key=value] to delete a single list element) + */ + 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 targetXpaths); + + /** + * Deletes all dataNodes in a given anchor. + * + * @param dataspaceName dataspace name + * @param anchorName anchor name + */ + void deleteDataNodes(String dataspaceName, String anchorName); + + /** + * Deletes all dataNodes in multiple anchors. + * + * @param dataspaceName dataspace name + * @param anchorNames anchor names + */ + void deleteDataNodes(String dataspaceName, Collection anchorNames); + + /** + * Deletes a single existing list element or the whole list. + * + * @param dataspaceName dataspace name + * @param anchorName anchor name + * @param targetXpath xpath to list or list element (include [@key=value] to delete a single list element) + */ + void deleteListDataNode(String dataspaceName, String anchorName, String targetXpath); + + /** + * Get a datanode by cps path. + * + * @param dataspaceName dataspace name + * @param anchorName anchor 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 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 queryDataNodesAcrossAnchors(String dataspaceName, + String cpsPath, FetchDescendantsOption fetchDescendantsOption); + + + /** + * Starts a session which allows use of locks and batch interaction with the persistence service. + * + * @return Session ID string + */ + String startSession(); + + /** + * Close session. + * + * @param sessionId session ID + */ + void closeSession(String sessionId); + + /** + * Lock anchor. + * To release locks(s), the session holding the lock(s) must be closed. + * + * @param sessionID session ID + * @param dataspaceName dataspace name + * @param anchorName anchor name + * @param timeoutInMilliseconds lock attempt timeout in milliseconds */ - DataNode getDataNode(@NonNull String dataspaceName, @NonNull String anchorName, @NonNull String xpath, - @NonNull FetchDescendantsOption fetchDescendantsOption); + void lockAnchor(String sessionID, String dataspaceName, String anchorName, Long timeoutInMilliseconds); }