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=dddf089107b79fdc2aedb4fc725dd1a72cb987b8;hb=fd50018df540ab3689e2bc5db9d2bcfb2d11c922;hp=158f20ef93222a948dd89cd2952283776065c62e;hpb=6b300ead182d9724658f0188631e538851e8f566;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 158f20ef9..dddf08910 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,13 +1,15 @@ /* - * ============LICENSE_START======================================================= + * ============LICENSE_START======================================================= * Copyright (C) 2021 highstreet technologies GmbH - * 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"); * 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,10 +22,11 @@ package org.onap.cps.ncmp.api; +import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum; + import java.util.Collection; -import org.checkerframework.checker.nullness.qual.NonNull; -import org.onap.cps.spi.FetchDescendantsOption; -import org.onap.cps.spi.model.DataNode; +import org.onap.cps.ncmp.api.models.DmiPluginRegistration; +import org.onap.cps.spi.model.ModuleReference; /* * Datastore interface for handling CPS data. @@ -31,49 +34,72 @@ import org.onap.cps.spi.model.DataNode; public interface NetworkCmProxyDataService { /** - * Retrieves datanode by XPath for a given cm handle. + * Registration of New CM Handles. * - * @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 + * @param dmiPluginRegistration Dmi Plugin Registration */ - DataNode getDataNode(@NonNull String cmHandle, @NonNull String xpath, - @NonNull FetchDescendantsOption fetchDescendantsOption); + void updateDmiRegistrationAndSyncModule(DmiPluginRegistration dmiPluginRegistration); /** - * Get datanodes for the given cm handle by cps path. + * Get resource data for data store pass-through operational + * using dmi. * - * @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 + * @param cmHandle cm handle + * @param resourceIdentifier resource identifier + * @param acceptParamInHeader accept param + * @param optionsParamInQuery options query + * @return {@code Object} resource data + */ + Object getResourceDataOperationalForCmHandle(String cmHandle, + String resourceIdentifier, + String acceptParamInHeader, + String optionsParamInQuery); + + /** + * Get resource data for data store pass-through running + * using dmi. + * + * @param cmHandle cm handle + * @param resourceIdentifier resource identifier + * @param acceptParamInHeader accept param + * @param optionsParamInQuery options query + * @return {@code Object} resource data + */ + Object getResourceDataPassThroughRunningForCmHandle(String cmHandle, + String resourceIdentifier, + String acceptParamInHeader, + String optionsParamInQuery); + + /** + * Write resource data for data store pass-through running + * using dmi for given 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 */ - Collection queryDataNodes(@NonNull String cmHandle, @NonNull String cpsPath, - @NonNull FetchDescendantsOption fetchDescendantsOption); + void writeResourceDataPassThroughRunningForCmHandle(String cmHandle, + String resourceIdentifier, + OperationEnum operation, + String requestBody, + String contentType); /** - * Updates data node for given cm handle using xpath to parent node. + * Retrieve module references for the 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 parentNodeXpath xpath to parent node - * @param jsonData json data + * @param cmHandle cm handle + * @return a collection of modules names and revisions */ - void updateNodeLeaves(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData); + Collection getYangResourcesModuleReferences(String cmHandle); /** - * Replaces existing data node content including descendants. + * Query cm handle identifiers for the given collection of module names. * - * @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 + * @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 */ - void replaceNodeTree(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData); + Collection executeCmHandleHasAllModulesSearch(Collection moduleNames); }