cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/operations/DmiDataOperations.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2022 Nordix Foundation
   4  *  Modifications Copyright (C) 2022 Bell Canada
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.ncmp.api.impl.operations;
  23
  24 import static org.onap.cps.ncmp.api.impl.operations.DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING;
  25 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
  26 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.READ;
  27
  28 import org.onap.cps.ncmp.api.impl.client.DmiRestClient;
  29 import org.onap.cps.ncmp.api.impl.config.NcmpConfiguration;
  30 import org.onap.cps.ncmp.api.impl.utils.DmiServiceUrlBuilder;
  31 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  32 import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
  33 import org.onap.cps.utils.CpsValidator;
  34 import org.onap.cps.utils.JsonObjectMapper;
  35 import org.springframework.http.ResponseEntity;
  36 import org.springframework.stereotype.Component;
  37
  38 /**
  39  * Operations class for DMI data.
  40  */
  41 @Component
  42 public class DmiDataOperations extends DmiOperations {
  43
  44     /**
  45      * Constructor for {@code DmiOperations}. This method also manipulates url properties.
  46      *
  47      * @param dmiRestClient {@code DmiRestClient}
  48      */
  49     public DmiDataOperations(final InventoryPersistence inventoryPersistence,
  50                              final JsonObjectMapper jsonObjectMapper,
  51                              final NcmpConfiguration.DmiProperties dmiProperties,
  52                              final DmiRestClient dmiRestClient, final DmiServiceUrlBuilder dmiServiceUrlBuilder) {
  53         super(inventoryPersistence, jsonObjectMapper, dmiProperties, dmiRestClient, dmiServiceUrlBuilder);
  54     }
  55
  56     /**
  57      * This method fetches the resource data from operational data store for given cm handle
  58      * identifier on given resource using dmi client.
  59      *
  60      * @param cmHandleId    network resource identifier
  61      * @param resourceId  resource identifier
  62      * @param optionsParamInQuery options query
  63      * @param dataStore           data store enum
  64      * @param requestId           requestId for async responses
  65      * @param topicParamInQuery   topic name for (triggering) async responses
  66      * @return {@code ResponseEntity} response entity
  67      */
  68     public ResponseEntity<Object> getResourceDataFromDmi(final String cmHandleId,
  69                                                          final String resourceId,
  70                                                          final String optionsParamInQuery,
  71                                                          final DataStoreEnum dataStore,
  72                                                          final String requestId,
  73                                                          final String topicParamInQuery) {
  74         CpsValidator.validateNameCharacters(cmHandleId);
  75         final YangModelCmHandle yangModelCmHandle =
  76                 inventoryPersistence.getYangModelCmHandle(cmHandleId);
  77         final DmiRequestBody dmiRequestBody = DmiRequestBody.builder()
  78             .operation(READ)
  79             .requestId(requestId)
  80             .build();
  81         dmiRequestBody.asDmiProperties(yangModelCmHandle.getDmiProperties());
  82         final String jsonBody = jsonObjectMapper.asJsonString(dmiRequestBody);
  83         final String dmiResourceDataUrl = dmiServiceUrlBuilder.getDmiDatastoreUrl(
  84                 dmiServiceUrlBuilder.populateQueryParams(resourceId, optionsParamInQuery,
  85                 topicParamInQuery), dmiServiceUrlBuilder.populateUriVariables(
  86                         yangModelCmHandle, cmHandleId, dataStore));
  87         return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonBody, READ);
  88     }
  89
  90     /**
  91      * This method creates the resource data from pass-through running data store for given cm handle
  92      * identifier on given resource using dmi client.
  93      *
  94      * @param cmHandleId    network resource identifier
  95      * @param resourceId  resource identifier
  96      * @param operation   operation enum
  97      * @param requestData the request data
  98      * @param dataType    data type
  99      * @return {@code ResponseEntity} response entity
 100      */
 101     public ResponseEntity<Object> writeResourceDataPassThroughRunningFromDmi(final String cmHandleId,
 102                                                                              final String resourceId,
 103                                                                              final OperationEnum operation,
 104                                                                              final String requestData,
 105                                                                              final String dataType) {
 106         CpsValidator.validateNameCharacters(cmHandleId);
 107         final YangModelCmHandle yangModelCmHandle =
 108             inventoryPersistence.getYangModelCmHandle(cmHandleId);
 109         final DmiRequestBody dmiRequestBody = DmiRequestBody.builder()
 110             .operation(operation)
 111             .data(requestData)
 112             .dataType(dataType)
 113             .build();
 114         dmiRequestBody.asDmiProperties(yangModelCmHandle.getDmiProperties());
 115         final String jsonBody = jsonObjectMapper.asJsonString(dmiRequestBody);
 116         final String dmiUrl =
 117             dmiServiceUrlBuilder.getDmiDatastoreUrl(dmiServiceUrlBuilder.populateQueryParams(resourceId,
 118                     null, null),
 119                 dmiServiceUrlBuilder.populateUriVariables(yangModelCmHandle, cmHandleId, PASSTHROUGH_RUNNING));
 120         return dmiRestClient.postOperationWithJsonData(dmiUrl, jsonBody, operation);
 121     }
 122
 123 }