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  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.api.impl.operations;
  22
  23 import static org.onap.cps.ncmp.api.impl.operations.DmiOperations.DataStoreEnum.PASSTHROUGH_RUNNING;
  24 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum;
  25 import static org.onap.cps.ncmp.api.impl.operations.DmiRequestBody.OperationEnum.READ;
  26
  27 import org.onap.cps.ncmp.api.impl.client.DmiRestClient;
  28 import org.onap.cps.ncmp.api.impl.config.NcmpConfiguration;
  29 import org.onap.cps.ncmp.api.impl.utils.DmiServiceUrlBuilder;
  30 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  31 import org.onap.cps.utils.JsonObjectMapper;
  32 import org.springframework.http.HttpHeaders;
  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 acceptParamInHeader accept parameter
  62      * @param dataStore           data store enum
  63      * @param requestId           requestId for async responses
  64      * @param topicParamInQuery   topic name for (triggering) async responses
  65      * @return {@code ResponseEntity} response entity
  66      */
  67     public ResponseEntity<Object> getResourceDataFromDmi(final String cmHandleId,
  68                                                          final String resourceId,
  69                                                          final String optionsParamInQuery,
  70                                                          final String acceptParamInHeader,
  71                                                          final DataStoreEnum dataStore,
  72                                                          final String requestId,
  73                                                          final String topicParamInQuery) {
  74         final YangModelCmHandle yangModelCmHandle =
  75                 yangModelCmHandleRetriever.getDmiServiceNamesAndProperties(cmHandleId);
  76         final DmiRequestBody dmiRequestBody = DmiRequestBody.builder()
  77             .operation(READ)
  78             .requestId(requestId)
  79             .build();
  80         dmiRequestBody.asDmiProperties(yangModelCmHandle.getDmiProperties());
  81         final String jsonBody = jsonObjectMapper.asJsonString(dmiRequestBody);
  82
  83         final var dmiResourceDataUrl = dmiServiceUrlBuilder.getDmiDatastoreUrl(
  84                 dmiServiceUrlBuilder.populateQueryParams(resourceId, optionsParamInQuery,
  85                 topicParamInQuery), dmiServiceUrlBuilder.populateUriVariables(
  86                         yangModelCmHandle, cmHandleId, dataStore));
  87         final var httpHeaders = prepareHeader(acceptParamInHeader);
  88         return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonBody, httpHeaders);
  89     }
  90
  91     /**
  92      * This method creates the resource data from pass-through running data store for given cm handle
  93      * identifier on given resource using dmi client.
  94      *
  95      * @param cmHandleId    network resource identifier
  96      * @param resourceId  resource identifier
  97      * @param operation   operation enum
  98      * @param requestData the request data
  99      * @param dataType    data type
 100      * @return {@code ResponseEntity} response entity
 101      */
 102     public ResponseEntity<Object> writeResourceDataPassThroughRunningFromDmi(final String cmHandleId,
 103                                                                              final String resourceId,
 104                                                                              final OperationEnum operation,
 105                                                                              final String requestData,
 106                                                                              final String dataType) {
 107         final YangModelCmHandle yangModelCmHandle =
 108             yangModelCmHandleRetriever.getDmiServiceNamesAndProperties(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, new HttpHeaders());
 121     }
 122
 123 }