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

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2024 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.NcmpResponseStatus.DMI_SERVICE_NOT_RESPONDING;
  25 import static org.onap.cps.ncmp.api.NcmpResponseStatus.UNABLE_TO_READ_RESOURCE_DATA;
  26 import static org.onap.cps.ncmp.api.impl.operations.DatastoreType.PASSTHROUGH_RUNNING;
  27 import static org.onap.cps.ncmp.api.impl.operations.OperationType.READ;
  28
  29 import io.micrometer.core.annotation.Timed;
  30 import java.util.Collection;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Set;
  34 import java.util.stream.Collectors;
  35 import lombok.extern.slf4j.Slf4j;
  36 import org.onap.cps.ncmp.api.NcmpResponseStatus;
  37 import org.onap.cps.ncmp.api.impl.client.DmiRestClient;
  38 import org.onap.cps.ncmp.api.impl.config.NcmpConfiguration;
  39 import org.onap.cps.ncmp.api.impl.exception.HttpClientRequestException;
  40 import org.onap.cps.ncmp.api.impl.inventory.CmHandleState;
  41 import org.onap.cps.ncmp.api.impl.inventory.InventoryPersistence;
  42 import org.onap.cps.ncmp.api.impl.utils.DmiServiceUrlBuilder;
  43 import org.onap.cps.ncmp.api.impl.utils.data.operation.ResourceDataOperationRequestUtils;
  44 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  45 import org.onap.cps.ncmp.api.models.CmResourceAddress;
  46 import org.onap.cps.ncmp.api.models.DataOperationRequest;
  47 import org.onap.cps.spi.exceptions.CpsException;
  48 import org.onap.cps.utils.JsonObjectMapper;
  49 import org.springframework.http.ResponseEntity;
  50 import org.springframework.stereotype.Component;
  51 import org.springframework.util.LinkedMultiValueMap;
  52 import org.springframework.util.MultiValueMap;
  53 import org.springframework.web.util.UriComponentsBuilder;
  54
  55 /**
  56  * Operations class for DMI data.
  57  */
  58 @Component
  59 @Slf4j
  60 public class DmiDataOperations extends DmiOperations {
  61
  62     public DmiDataOperations(final InventoryPersistence inventoryPersistence,
  63                              final JsonObjectMapper jsonObjectMapper,
  64                              final NcmpConfiguration.DmiProperties dmiProperties,
  65                              final DmiRestClient dmiRestClient,
  66                              final DmiServiceUrlBuilder dmiServiceUrlBuilder) {
  67         super(inventoryPersistence, jsonObjectMapper, dmiProperties, dmiRestClient, dmiServiceUrlBuilder);
  68     }
  69
  70     /**
  71      * This method fetches the resource data from operational data store for given cm handle
  72      * identifier on given resource using dmi client.
  73      *
  74      * @param cmResourceAddress   target datastore, cm handle and resource identifier
  75      * @param optionsParamInQuery options query
  76      * @param topicParamInQuery   topic name for (triggering) async responses
  77      * @param requestId           requestId for async responses
  78      * @param authorization       contents of Authorization header, or null if not present
  79      * @return {@code ResponseEntity} response entity
  80      */
  81     @Timed(value = "cps.ncmp.dmi.get",
  82             description = "Time taken to fetch the resource data from operational data store for given cm handle "
  83                     + "identifier on given resource using dmi client")
  84     public ResponseEntity<Object> getResourceDataFromDmi(final CmResourceAddress cmResourceAddress,
  85                                                          final String optionsParamInQuery,
  86                                                          final String topicParamInQuery,
  87                                                          final String requestId,
  88                                                          final String authorization) {
  89         final YangModelCmHandle yangModelCmHandle = getYangModelCmHandle(cmResourceAddress.cmHandleId());
  90         final CmHandleState cmHandleState = yangModelCmHandle.getCompositeState().getCmHandleState();
  91         validateIfCmHandleStateReady(yangModelCmHandle, cmHandleState);
  92         final String jsonRequestBody = getDmiRequestBody(READ, requestId, null, null, yangModelCmHandle);
  93         final String dmiResourceDataUrl = getDmiRequestUrl(cmResourceAddress.datastoreName(),
  94             cmResourceAddress.cmHandleId(), cmResourceAddress.resourceIdentifier(), optionsParamInQuery,
  95                 topicParamInQuery, yangModelCmHandle.resolveDmiServiceName(RequiredDmiService.DATA));
  96         return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonRequestBody, READ, authorization);
  97     }
  98
  99     /**
 100      * This method fetches all the resource data from operational data store for given cm handle
 101      * identifier using dmi client.
 102      *
 103      * @param dataStoreName data store name
 104      * @param cmHandleId    network resource identifier
 105      * @param requestId     requestId for async responses
 106      * @return {@code ResponseEntity} response entity
 107      */
 108     public ResponseEntity<Object> getResourceDataFromDmi(final String dataStoreName,
 109                                                          final String cmHandleId,
 110                                                          final String requestId) {
 111         final YangModelCmHandle yangModelCmHandle = getYangModelCmHandle(cmHandleId);
 112         final String jsonRequestBody = getDmiRequestBody(READ, requestId, null, null,
 113                 yangModelCmHandle);
 114         final String dmiResourceDataUrl = getDmiRequestUrl(dataStoreName, cmHandleId, "/",
 115                 null, null,
 116                 yangModelCmHandle.resolveDmiServiceName(RequiredDmiService.DATA));
 117         final CmHandleState cmHandleState = yangModelCmHandle.getCompositeState().getCmHandleState();
 118         validateIfCmHandleStateReady(yangModelCmHandle, cmHandleState);
 119         return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonRequestBody, READ, null);
 120     }
 121
 122     /**
 123      * This method requests the resource data by data store for given list of cm handles using dmi client.
 124      * The data wil be returned as message on the topic specified.
 125      *
 126      * @param topicParamInQuery        topic name for (triggering) async responses
 127      * @param dataOperationRequest     data operation request to execute operations
 128      * @param requestId                requestId for as a response
 129      * @param authorization            contents of Authorization header, or null if not present
 130      */
 131     public void requestResourceDataFromDmi(final String topicParamInQuery,
 132                                            final DataOperationRequest dataOperationRequest,
 133                                            final String requestId,
 134                                            final String authorization)  {
 135
 136         final Set<String> cmHandlesIds
 137                 = getDistinctCmHandleIdsFromDataOperationRequest(dataOperationRequest);
 138
 139         final Collection<YangModelCmHandle> yangModelCmHandles
 140                 = inventoryPersistence.getYangModelCmHandles(cmHandlesIds);
 141
 142         final Map<String, List<DmiDataOperation>> operationsOutPerDmiServiceName
 143                 = ResourceDataOperationRequestUtils.processPerDefinitionInDataOperationsRequest(topicParamInQuery,
 144                 requestId, dataOperationRequest, yangModelCmHandles);
 145
 146         buildDataOperationRequestUrlAndSendToDmiService(topicParamInQuery, requestId, operationsOutPerDmiServiceName,
 147                 authorization);
 148     }
 149
 150     /**
 151      * This method creates the resource data from pass-through running data store for given cm handle
 152      * identifier on given resource using dmi client.
 153      *
 154      * @param cmHandleId    network resource identifier
 155      * @param resourceId    resource identifier
 156      * @param operationType operation enum
 157      * @param requestData   the request data
 158      * @param dataType      data type
 159      * @param authorization contents of Authorization header, or null if not present
 160      * @return {@code ResponseEntity} response entity
 161      */
 162     public ResponseEntity<Object> writeResourceDataPassThroughRunningFromDmi(final String cmHandleId,
 163                                                                              final String resourceId,
 164                                                                              final OperationType operationType,
 165                                                                              final String requestData,
 166                                                                              final String dataType,
 167                                                                              final String authorization) {
 168         final YangModelCmHandle yangModelCmHandle = getYangModelCmHandle(cmHandleId);
 169         final String jsonRequestBody = getDmiRequestBody(operationType, null, requestData, dataType,
 170                 yangModelCmHandle);
 171         final String dmiUrl = getDmiRequestUrl(PASSTHROUGH_RUNNING.getDatastoreName(), cmHandleId, resourceId,
 172                 null, null,
 173                 yangModelCmHandle.resolveDmiServiceName(RequiredDmiService.DATA));
 174         final CmHandleState cmHandleState = yangModelCmHandle.getCompositeState().getCmHandleState();
 175         validateIfCmHandleStateReady(yangModelCmHandle, cmHandleState);
 176         return dmiRestClient.postOperationWithJsonData(dmiUrl, jsonRequestBody, operationType, authorization);
 177     }
 178
 179     private YangModelCmHandle getYangModelCmHandle(final String cmHandleId) {
 180         return inventoryPersistence.getYangModelCmHandle(cmHandleId);
 181     }
 182
 183     private String getDmiRequestBody(final OperationType operationType,
 184                                      final String requestId,
 185                                      final String requestData,
 186                                      final String dataType,
 187                                      final YangModelCmHandle yangModelCmHandle) {
 188         final DmiRequestBody dmiRequestBody = DmiRequestBody.builder()
 189                 .operationType(operationType)
 190                 .requestId(requestId)
 191                 .data(requestData)
 192                 .dataType(dataType)
 193                 .build();
 194         dmiRequestBody.asDmiProperties(yangModelCmHandle.getDmiProperties());
 195         return jsonObjectMapper.asJsonString(dmiRequestBody);
 196     }
 197
 198     private String getDmiRequestUrl(final String dataStoreName,
 199                                     final String cmHandleId,
 200                                     final String resourceId,
 201                                     final String optionsParamInQuery,
 202                                     final String topicParamInQuery,
 203                                     final String dmiServiceName) {
 204         return dmiServiceUrlBuilder.getDmiDatastoreUrl(
 205                 dmiServiceUrlBuilder.populateQueryParams(resourceId, optionsParamInQuery,
 206                         topicParamInQuery), dmiServiceUrlBuilder.populateUriVariables(dataStoreName, dmiServiceName,
 207                         cmHandleId));
 208     }
 209
 210     private String getDmiServiceDataOperationRequestUrl(final String dmiServiceName,
 211                                                         final String topicParamInQuery,
 212                                                         final String requestId) {
 213         final MultiValueMap<String, String> dataOperationRequestQueryParams = dmiServiceUrlBuilder
 214                 .getDataOperationRequestQueryParams(topicParamInQuery, requestId);
 215         return dmiServiceUrlBuilder.getDataOperationRequestUrl(dataOperationRequestQueryParams,
 216                 dmiServiceUrlBuilder.populateDataOperationRequestUriVariables(dmiServiceName));
 217     }
 218
 219     private void validateIfCmHandleStateReady(final YangModelCmHandle yangModelCmHandle,
 220                                               final CmHandleState cmHandleState) {
 221         if (cmHandleState != CmHandleState.READY) {
 222             throw new CpsException("State mismatch exception.", "Cm-Handle not in READY state. "
 223                     + "cm handle state is "
 224                     + yangModelCmHandle.getCompositeState().getCmHandleState());
 225         }
 226     }
 227
 228     private static Set<String> getDistinctCmHandleIdsFromDataOperationRequest(final DataOperationRequest
 229                                                                               dataOperationRequest) {
 230         return dataOperationRequest.getDataOperationDefinitions().stream()
 231                 .flatMap(dataOperationDefinition ->
 232                         dataOperationDefinition.getCmHandleIds().stream()).collect(Collectors.toSet());
 233     }
 234
 235     private void buildDataOperationRequestUrlAndSendToDmiService(final String topicParamInQuery,
 236                                                                  final String requestId,
 237                                                                  final Map<String, List<DmiDataOperation>>
 238                                                                 groupsOutPerDmiServiceName,
 239                                                                  final String authorization) {
 240
 241         groupsOutPerDmiServiceName.forEach((dmiServiceName, dmiDataOperationRequestBodies) -> {
 242             final String dmiDataOperationResourceUrl =
 243                     getDmiServiceDataOperationRequestUrl(dmiServiceName, topicParamInQuery, requestId);
 244             sendDataOperationRequestToDmiService(dmiDataOperationResourceUrl, dmiDataOperationRequestBodies,
 245                     authorization);
 246         });
 247     }
 248
 249     private void sendDataOperationRequestToDmiService(final String dataOperationResourceUrl,
 250                                                       final List<DmiDataOperation> dmiDataOperationRequestBodies,
 251                                                       final String authorization) {
 252         final DmiDataOperationRequest dmiDataOperationRequest = DmiDataOperationRequest.builder()
 253                 .operations(dmiDataOperationRequestBodies).build();
 254         final String dmiDataOperationRequestAsJsonString =
 255                 jsonObjectMapper.asJsonString(dmiDataOperationRequest);
 256         try {
 257             dmiRestClient.postOperationWithJsonData(dataOperationResourceUrl, dmiDataOperationRequestAsJsonString, READ,
 258                     authorization);
 259         } catch (final Exception exception) {
 260             handleTaskCompletionException(exception, dataOperationResourceUrl, dmiDataOperationRequestBodies);
 261         }
 262     }
 263
 264     private void handleTaskCompletionException(final Throwable throwable,
 265                                                final String dataOperationResourceUrl,
 266                                                final List<DmiDataOperation> dmiDataOperationRequestBodies) {
 267         if (throwable != null) {
 268             final MultiValueMap<String, String> dataOperationResourceUrlParameters =
 269                     UriComponentsBuilder.fromUriString(dataOperationResourceUrl).build().getQueryParams();
 270             final String topicName = dataOperationResourceUrlParameters.get("topic").get(0);
 271             final String requestId = dataOperationResourceUrlParameters.get("requestId").get(0);
 272
 273             final MultiValueMap<DmiDataOperation, Map<NcmpResponseStatus, List<String>>>
 274                     cmHandleIdsPerResponseCodesPerOperation = new LinkedMultiValueMap<>();
 275
 276             dmiDataOperationRequestBodies.forEach(dmiDataOperationRequestBody -> {
 277                 final List<String> cmHandleIds = dmiDataOperationRequestBody.getCmHandles().stream()
 278                         .map(CmHandle::getId).toList();
 279                 if (throwable.getCause() instanceof HttpClientRequestException) {
 280                     cmHandleIdsPerResponseCodesPerOperation.add(dmiDataOperationRequestBody,
 281                             Map.of(UNABLE_TO_READ_RESOURCE_DATA, cmHandleIds));
 282                 } else {
 283                     cmHandleIdsPerResponseCodesPerOperation.add(dmiDataOperationRequestBody,
 284                             Map.of(DMI_SERVICE_NOT_RESPONDING, cmHandleIds));
 285                 }
 286             });
 287             ResourceDataOperationRequestUtils.publishErrorMessageToClientTopic(topicName, requestId,
 288                     cmHandleIdsPerResponseCodesPerOperation);
 289         }
 290     }
 291 }