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.utils.JsonObjectMapper;
  33 import org.springframework.http.ResponseEntity;
  34 import org.springframework.stereotype.Component;
  35
  36 /**
  37  * Operations class for DMI data.
  38  */
  39 @Component
  40 public class DmiDataOperations extends DmiOperations {
  41
  42     /**
  43      * Constructor for {@code DmiOperations}. This method also manipulates url properties.
  44      *
  45      * @param dmiRestClient {@code DmiRestClient}
  46      */
  47     public DmiDataOperations(final YangModelCmHandleRetriever cmHandlePropertiesRetriever,
  48                              final JsonObjectMapper jsonObjectMapper,
  49                              final NcmpConfiguration.DmiProperties dmiProperties,
  50                              final DmiRestClient dmiRestClient, final DmiServiceUrlBuilder dmiServiceUrlBuilder) {
  51         super(cmHandlePropertiesRetriever, jsonObjectMapper, dmiProperties, dmiRestClient, dmiServiceUrlBuilder);
  52     }
  53
  54     /**
  55      * This method fetches the resource data from operational data store for given cm handle
  56      * identifier on given resource using dmi client.
  57      *
  58      * @param cmHandleId    network resource identifier
  59      * @param resourceId  resource identifier
  60      * @param optionsParamInQuery options query
  61      * @param dataStore           data store enum
  62      * @param requestId           requestId for async responses
  63      * @param topicParamInQuery   topic name for (triggering) async responses
  64      * @return {@code ResponseEntity} response entity
  65      */
  66     public ResponseEntity<Object> getResourceDataFromDmi(final String cmHandleId,
  67                                                          final String resourceId,
  68                                                          final String optionsParamInQuery,
  69                                                          final DataStoreEnum dataStore,
  70                                                          final String requestId,
  71                                                          final String topicParamInQuery) {
  72         final YangModelCmHandle yangModelCmHandle =
  73                 yangModelCmHandleRetriever.getDmiServiceNamesAndProperties(cmHandleId);
  74         final DmiRequestBody dmiRequestBody = DmiRequestBody.builder()
  75             .operation(READ)
  76             .requestId(requestId)
  77             .build();
  78         dmiRequestBody.asDmiProperties(yangModelCmHandle.getDmiProperties());
  79         final String jsonBody = jsonObjectMapper.asJsonString(dmiRequestBody);
  80         final var dmiResourceDataUrl = dmiServiceUrlBuilder.getDmiDatastoreUrl(
  81                 dmiServiceUrlBuilder.populateQueryParams(resourceId, optionsParamInQuery,
  82                 topicParamInQuery), dmiServiceUrlBuilder.populateUriVariables(
  83                         yangModelCmHandle, cmHandleId, dataStore));
  84         return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonBody);
  85     }
  86
  87     /**
  88      * This method creates the resource data from pass-through running data store for given cm handle
  89      * identifier on given resource using dmi client.
  90      *
  91      * @param cmHandleId    network resource identifier
  92      * @param resourceId  resource identifier
  93      * @param operation   operation enum
  94      * @param requestData the request data
  95      * @param dataType    data type
  96      * @return {@code ResponseEntity} response entity
  97      */
  98     public ResponseEntity<Object> writeResourceDataPassThroughRunningFromDmi(final String cmHandleId,
  99                                                                              final String resourceId,
 100                                                                              final OperationEnum operation,
 101                                                                              final String requestData,
 102                                                                              final String dataType) {
 103         final YangModelCmHandle yangModelCmHandle =
 104             yangModelCmHandleRetriever.getDmiServiceNamesAndProperties(cmHandleId);
 105         final DmiRequestBody dmiRequestBody = DmiRequestBody.builder()
 106             .operation(operation)
 107             .data(requestData)
 108             .dataType(dataType)
 109             .build();
 110         dmiRequestBody.asDmiProperties(yangModelCmHandle.getDmiProperties());
 111         final String jsonBody = jsonObjectMapper.asJsonString(dmiRequestBody);
 112         final String dmiUrl =
 113                 dmiServiceUrlBuilder.getDmiDatastoreUrl(dmiServiceUrlBuilder.populateQueryParams(resourceId,
 114                                 null, null),
 115                         dmiServiceUrlBuilder.populateUriVariables(yangModelCmHandle, cmHandleId, PASSTHROUGH_RUNNING));
 116         return dmiRestClient.postOperationWithJsonData(dmiUrl, jsonBody);
 117     }
 118
 119 }