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=cbd0756c09a92b336b0c56d0199861d3947153c5;hb=ea01d09861289ff162dff318713d1c24eba89259;hp=158f20ef93222a948dd89cd2952283776065c62e;hpb=34a94b92edd0c359291445735eb3d7e974deea1f;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..cbd0756c0 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,16 @@ /* - * ============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 + * Modifications Copyright (C) 2022 Bell Canada * ================================================================================ * 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 +23,13 @@ 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.ncmp.api.models.DmiPluginRegistrationResponse; +import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle; +import org.onap.cps.spi.model.ModuleReference; /* * Datastore interface for handling CPS data. @@ -31,49 +37,86 @@ 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 + * @return dmiPluginRegistrationResponse + */ + DmiPluginRegistrationResponse updateDmiRegistrationAndSyncModule(DmiPluginRegistration dmiPluginRegistration); + + /** + * Get resource data for data store pass-through operational + * using dmi. + * + * @param cmHandleId cm handle identifier + * @param resourceIdentifier resource identifier + * @param optionsParamInQuery options query + * @param topicParamInQuery topic name for (triggering) async responses + * @param requestId unique requestId for async request + * @return {@code Object} resource data + */ + Object getResourceDataOperationalForCmHandle(String cmHandleId, + String resourceIdentifier, + String optionsParamInQuery, + String topicParamInQuery, + String requestId); + + /** + * Get resource data for data store pass-through running + * using dmi. + * + * @param cmHandleId cm handle identifier + * @param resourceIdentifier resource identifier + * @param optionsParamInQuery options query + * @param topicParamInQuery topic name for (triggering) async responses + * @param requestId unique requestId for async request + * @return {@code Object} resource data + */ + Object getResourceDataPassThroughRunningForCmHandle(String cmHandleId, + String resourceIdentifier, + String optionsParamInQuery, + String topicParamInQuery, + String requestId); + + /** + * Write resource data for data store pass-through running + * using dmi for given cm-handle. + * @param cmHandleId cm handle identifier + * @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 */ - DataNode getDataNode(@NonNull String cmHandle, @NonNull String xpath, - @NonNull FetchDescendantsOption fetchDescendantsOption); + Object writeResourceDataPassThroughRunningForCmHandle(String cmHandleId, + String resourceIdentifier, + OperationEnum operation, + String requestBody, + String contentType); /** - * Get datanodes for the given cm handle by cps path. + * 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 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 cmHandleId cm handle identifier + * @return a collection of modules names and revisions */ - Collection queryDataNodes(@NonNull String cmHandle, @NonNull String cpsPath, - @NonNull FetchDescendantsOption fetchDescendantsOption); + Collection getYangResourcesModuleReferences(String cmHandleId); /** - * Updates data node for given cm handle using xpath to parent node. + * 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 updateNodeLeaves(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData); + Collection executeCmHandleHasAllModulesSearch(Collection moduleNames); /** - * Replaces existing data node content including descendants. + * Query cm handle details by cm handle's name. * - * @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 cmHandleId cm handle identifier + * @return a collection of cm handle details. */ - void replaceNodeTree(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData); + NcmpServiceCmHandle getNcmpServiceCmHandle(String cmHandleId); }