X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=cps-ncmp-service%2Fsrc%2Fmain%2Fjava%2Forg%2Fonap%2Fcps%2Fncmp%2Fapi%2FNetworkCmProxyDataService.java;h=5d2ab533940c428a1ce2c28b48569357cc9e85d6;hb=db1e983f40be1db7bca5acacf5a3369d74a29c95;hp=cb2f78206ca625afc6e673df7cc90b2d7a9bdb66;hpb=8640868a6d2cb0a33bdd324c8078e63def9dbe16;p=cps.git diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyDataService.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyDataService.java index cb2f78206..5d2ab5339 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyDataService.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyDataService.java @@ -1,7 +1,7 @@ /* * ============LICENSE_START======================================================= * Copyright (C) 2021 highstreet technologies GmbH - * Modifications Copyright (C) 2021 Nordix Foundation + * Modifications Copyright (C) 2021-2022 Nordix Foundation * Modifications Copyright (C) 2021 Pantheon.tech * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); @@ -22,12 +22,10 @@ package org.onap.cps.ncmp.api; +import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum; + import java.util.Collection; -import javax.validation.constraints.NotNull; -import org.checkerframework.checker.nullness.qual.NonNull; import org.onap.cps.ncmp.api.models.DmiPluginRegistration; -import org.onap.cps.spi.FetchDescendantsOption; -import org.onap.cps.spi.model.DataNode; import org.onap.cps.spi.model.ModuleReference; /* @@ -35,72 +33,6 @@ import org.onap.cps.spi.model.ModuleReference; */ public interface NetworkCmProxyDataService { - /** - * Retrieves datanode by XPath for a given cm handle. - * - * @param cmHandle The identifier for a network function, network element, subnetwork or any other cm - * object by managed Network CM Proxy - * @param xpath 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 - */ - DataNode getDataNode(@NonNull String cmHandle, @NonNull String xpath, - @NonNull FetchDescendantsOption fetchDescendantsOption); - - /** - * Get datanodes for the given cm handle by cps path. - * - * @param cmHandle The identifier for a network function, network element, subnetwork or any other cm - * object by managed Network CM Proxy - * @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 a collection of datanodes - */ - Collection queryDataNodes(@NonNull String cmHandle, @NonNull String cpsPath, - @NonNull FetchDescendantsOption fetchDescendantsOption); - - /** - * Creates data node with descendants at root level or under existing node (if parent node xpath is provided). - * - * @param cmHandle The identifier for a network function, network element, subnetwork or any other cm - * object managed by Network CM Proxy - * @param parentNodeXpath xpath to parent node or '/' for root level - * @param jsonData data as JSON string - */ - void createDataNode(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData); - - /** - * Creates one or more child node elements with descendants under existing node from list-node data fragment. - * - * @param cmHandle The identifier for a network function, network element, subnetwork or any other cm - * object managed by Network CM Proxy - * @param parentNodeXpath xpath to parent node - * @param jsonData data as JSON string - */ - void addListNodeElements(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData); - - /** - * Updates data node for given cm handle using xpath to parent node. - * - * @param cmHandle The identifier for a network function, network element, subnetwork or any other cm object - * by managed Network CM Proxy - * @param parentNodeXpath xpath to parent node - * @param jsonData json data - */ - void updateNodeLeaves(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData); - - /** - * Replaces existing data node content including descendants. - * - * @param cmHandle The identifier for a network function, network element, subnetwork or any other cm object - * by managed Network CM Proxy - * @param parentNodeXpath xpath to parent node - * @param jsonData json data - */ - void replaceNodeTree(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData); - /** * Registration of New CM Handles. * @@ -118,8 +50,8 @@ public interface NetworkCmProxyDataService { * @param optionsParamInQuery options query * @return {@code Object} resource data */ - Object getResourceDataOperationalForCmHandle(@NotNull String cmHandle, - @NotNull String resourceIdentifier, + Object getResourceDataOperationalForCmHandle(String cmHandle, + String resourceIdentifier, String acceptParamInHeader, String optionsParamInQuery); @@ -133,24 +65,26 @@ public interface NetworkCmProxyDataService { * @param optionsParamInQuery options query * @return {@code Object} resource data */ - Object getResourceDataPassThroughRunningForCmHandle(@NotNull String cmHandle, - @NotNull String resourceIdentifier, + Object getResourceDataPassThroughRunningForCmHandle(String cmHandle, + String resourceIdentifier, String acceptParamInHeader, String optionsParamInQuery); /** - * Create resource data for data store pass-through running + * Write resource data for data store pass-through running * using dmi for given cm-handle. - * - * @param cmHandle cm handle + * @param cmHandle cm handle * @param resourceIdentifier resource identifier + * @param operation required operation * @param requestBody request body to create resource * @param contentType content type in body + * @return {@code Object} return data */ - void createResourceDataPassThroughRunningForCmHandle(@NotNull String cmHandle, - @NotNull String resourceIdentifier, - @NotNull String requestBody, - String contentType); + Object writeResourceDataPassThroughRunningForCmHandle(String cmHandle, + String resourceIdentifier, + OperationEnum operation, + String requestBody, + String contentType); /** * Retrieve module references for the given cm handle. @@ -158,5 +92,15 @@ public interface NetworkCmProxyDataService { * @param cmHandle cm handle * @return a collection of modules names and revisions */ - Collection getYangResourcesModuleReferences(@NotNull String cmHandle); + Collection getYangResourcesModuleReferences(String cmHandle); + + /** + * Query cm handle identifiers for the given collection of module names. + * + * @param moduleNames module names. + * @return a collection of cm handle identifiers. The schema set for each cm handle must include all the + * given module names + */ + Collection executeCmHandleHasAllModulesSearch(Collection moduleNames); + }