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=45d5bd911a6d1b16a0c7a6887230998ace922872;hb=6c7791e04e43b056ab944c3f7935f182fcbb13fb;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..45d5bd911 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 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. @@ -21,9 +23,12 @@ package org.onap.cps.ncmp.api; 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; /* * Datastore interface for handling CPS data. @@ -56,6 +61,26 @@ public interface NetworkCmProxyDataService { 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. * @@ -76,4 +101,82 @@ public interface NetworkCmProxyDataService { */ void replaceNodeTree(@NonNull String cmHandle, @NonNull String parentNodeXpath, @NonNull String jsonData); + /** + * Registration of New CM Handles. + * + * @param dmiPluginRegistration Dmi Plugin Registration + */ + void updateDmiRegistrationAndSyncModule(DmiPluginRegistration dmiPluginRegistration); + + /** + * Get resource data for data store pass-through operational + * using dmi. + * + * @param cmHandle cm handle + * @param resourceIdentifier resource identifier + * @param acceptParamInHeader accept param + * @param optionsParamInQuery options query + * @return {@code Object} resource data + */ + Object getResourceDataOperationalForCmHandle(@NotNull String cmHandle, + @NotNull 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(@NotNull String cmHandle, + @NotNull String resourceIdentifier, + String acceptParamInHeader, + String optionsParamInQuery); + + /** + * Create resource data for data store pass-through running + * using dmi for given cm-handle. + * + * @param cmHandle cm handle + * @param resourceIdentifier resource identifier + * @param requestBody request body to create resource + * @param contentType content type in body + */ + void createResourceDataPassThroughRunningForCmHandle(@NotNull String cmHandle, + @NotNull String resourceIdentifier, + @NotNull String requestBody, + String contentType); + + /** + * Retrieve module references for the given cm handle. + * + * @param cmHandle cm handle + * @return a collection of modules names and revisions + */ + Collection getYangResourcesModuleReferences(@NotNull 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); + + /** + * Update resource data for data store pass-through running using dmi for the given cm-handle. + * + * @param cmHandle cm handle + * @param resourceIdentifier resource identifier + * @param requestBody request body to create resource + * @param contentType content type in body + */ + void updateResourceDataPassThroughRunningForCmHandle(String cmHandle, String resourceIdentifier, + String requestBody, String contentType); }