cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/NetworkCmProxyDataService.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021 highstreet technologies GmbH
   4  *  Modifications Copyright (C) 2021-2022 Nordix Foundation
   5  *  Modifications Copyright (C) 2021 Pantheon.tech
   6  *  Modifications Copyright (C) 2022 Bell Canada
   7  *  ================================================================================
   8  *  Licensed under the Apache License, Version 2.0 (the "License");
   9  *  you may not use this file except in compliance with the License.
  10  *  You may obtain a copy of the License at
  11  *
  12  *        http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  *  Unless required by applicable law or agreed to in writing, software
  15  *  distributed under the License is distributed on an "AS IS" BASIS,
  16  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  *  See the License for the specific language governing permissions and
  18  *  limitations under the License.
  19  *
  20  *  SPDX-License-Identifier: Apache-2.0
  21  *  ============LICENSE_END=========================================================
  22  */
  23
  24 package org.onap.cps.ncmp.api;
  25
  26 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
  27
  28 import java.util.Collection;
  29 import org.onap.cps.ncmp.api.models.DmiPluginRegistration;
  30 import org.onap.cps.ncmp.api.models.DmiPluginRegistrationResponse;
  31 import org.onap.cps.ncmp.api.models.NcmpServiceCmHandle;
  32 import org.onap.cps.spi.model.ModuleReference;
  33
  34 /*
  35  * Datastore interface for handling CPS data.
  36  */
  37 public interface NetworkCmProxyDataService {
  38
  39     /**
  40      * Registration of New CM Handles.
  41      *
  42      * @param dmiPluginRegistration Dmi Plugin Registration
  43      * @return dmiPluginRegistrationResponse
  44      */
  45     DmiPluginRegistrationResponse updateDmiRegistrationAndSyncModule(DmiPluginRegistration dmiPluginRegistration);
  46
  47     /**
  48      * Get resource data for data store pass-through operational
  49      * using dmi.
  50      *
  51      * @param cmHandleId cm handle identifier
  52      * @param resourceIdentifier resource identifier
  53      * @param optionsParamInQuery options query
  54      * @param topicParamInQuery topic name for (triggering) async responses
  55      * @return {@code Object} resource data
  56      */
  57     Object getResourceDataOperationalForCmHandle(String cmHandleId,
  58                                                  String resourceIdentifier,
  59                                                  String optionsParamInQuery,
  60                                                  String topicParamInQuery);
  61
  62     /**
  63      * Get resource data for data store pass-through running
  64      * using dmi.
  65      *
  66      * @param cmHandleId cm handle identifier
  67      * @param resourceIdentifier resource identifier
  68      * @param optionsParamInQuery options query
  69      * @param topicParamInQuery topic query
  70      * @return {@code Object} resource data
  71      */
  72     Object getResourceDataPassThroughRunningForCmHandle(String cmHandleId,
  73                                                         String resourceIdentifier,
  74                                                         String optionsParamInQuery,
  75                                                         String topicParamInQuery);
  76
  77     /**
  78      * Write resource data for data store pass-through running
  79      * using dmi for given cm-handle.
  80      *  @param cmHandleId cm handle identifier
  81      * @param resourceIdentifier resource identifier
  82      * @param operation required operation
  83      * @param requestBody request body to create resource
  84      * @param contentType content type in body
  85      * @return {@code Object} return data
  86      */
  87     Object writeResourceDataPassThroughRunningForCmHandle(String cmHandleId,
  88                                                         String resourceIdentifier,
  89                                                         OperationEnum operation,
  90                                                         String requestBody,
  91                                                         String contentType);
  92
  93     /**
  94      * Retrieve module references for the given cm handle.
  95      *
  96      * @param cmHandleId cm handle identifier
  97      * @return a collection of modules names and revisions
  98      */
  99     Collection<ModuleReference> getYangResourcesModuleReferences(String cmHandleId);
 100
 101     /**
 102      * Query cm handle identifiers for the given collection of module names.
 103      *
 104      * @param moduleNames module names.
 105      * @return a collection of cm handle identifiers. The schema set for each cm handle must include all the
 106      *         given module names
 107      */
 108     Collection<String> executeCmHandleHasAllModulesSearch(Collection<String> moduleNames);
 109
 110     /**
 111      * Query cm handle details by cm handle's name.
 112      *
 113      * @param cmHandleId cm handle identifier
 114      * @return a collection of cm handle details.
 115      */
 116     NcmpServiceCmHandle getNcmpServiceCmHandle(String cmHandleId);
 117
 118 }