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

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