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 java.util.Collection;
  30 import java.util.List;
  31 import java.util.Map;
  32 import java.util.Set;
  33 import java.util.stream.Collectors;
  34 import lombok.extern.slf4j.Slf4j;
  35 import org.onap.cps.ncmp.api.NcmpResponseStatus;
  36 import org.onap.cps.ncmp.api.impl.client.DmiRestClient;
  37 import org.onap.cps.ncmp.api.impl.config.NcmpConfiguration;
  38 import org.onap.cps.ncmp.api.impl.exception.HttpClientRequestException;
  39 import org.onap.cps.ncmp.api.impl.executor.TaskExecutor;
  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.DataOperationRequest;
  46 import org.onap.cps.spi.exceptions.CpsException;
  47 import org.onap.cps.utils.JsonObjectMapper;
  48 import org.springframework.http.ResponseEntity;
  49 import org.springframework.stereotype.Component;
  50 import org.springframework.util.LinkedMultiValueMap;
  51 import org.springframework.util.MultiValueMap;
  52 import org.springframework.web.util.UriComponentsBuilder;
  53
  54 /**
  55  * Operations class for DMI data.
  56  */
  57 @Component
  58 @Slf4j
  59 public class DmiDataOperations extends DmiOperations {
  60
  61     private static final long DEFAULT_ASYNC_TASK_EXECUTOR_TIMEOUT_IN_MILLISECONDS = 30000L;
  62
  63     public DmiDataOperations(final InventoryPersistence inventoryPersistence,
  64                              final JsonObjectMapper jsonObjectMapper,
  65                              final NcmpConfiguration.DmiProperties dmiProperties,
  66                              final DmiRestClient dmiRestClient,
  67                              final DmiServiceUrlBuilder dmiServiceUrlBuilder) {
  68         super(inventoryPersistence, jsonObjectMapper, dmiProperties, dmiRestClient, dmiServiceUrlBuilder);
  69     }
  70
  71     /**
  72      * This method fetches the resource data from operational data store for given cm handle
  73      * identifier on given resource using dmi client.
  74      *
  75      * @param dataStoreName       name of data store
  76      * @param cmHandleId          network resource identifier
  77      * @param resourceId          resource identifier
  78      * @param optionsParamInQuery options query
  79      * @param topicParamInQuery   topic name for (triggering) async responses
  80      * @param requestId           requestId for async responses
  81      * @return {@code ResponseEntity} response entity
  82      */
  83     public ResponseEntity<Object> getResourceDataFromDmi(final String dataStoreName,
  84                                                          final String cmHandleId,
  85                                                          final String resourceId,
  86                                                          final String optionsParamInQuery,
  87                                                          final String topicParamInQuery,
  88                                                          final String requestId) {
  89         final YangModelCmHandle yangModelCmHandle = getYangModelCmHandle(cmHandleId);
  90         final CmHandleState cmHandleState = yangModelCmHandle.getCompositeState().getCmHandleState();
  91         validateIfCmHandleStateReady(yangModelCmHandle, cmHandleState);
  92         final String jsonRequestBody = getDmiRequestBody(READ, requestId, null, null,
  93                 yangModelCmHandle);
  94         final String dmiResourceDataUrl = getDmiRequestUrl(dataStoreName, cmHandleId, resourceId, optionsParamInQuery,
  95                 topicParamInQuery, yangModelCmHandle.resolveDmiServiceName(RequiredDmiService.DATA));
  96         return dmiRestClient.postOperationWithJsonData(dmiResourceDataUrl, jsonRequestBody, READ);
  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);
 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      */
 130     public void requestResourceDataFromDmi(final String topicParamInQuery,
 131                                            final DataOperationRequest dataOperationRequest,
 132                                            final String requestId)  {
 133
 134         final Set<String> cmHandlesIds
 135                 = getDistinctCmHandleIdsFromDataOperationRequest(dataOperationRequest);
 136
 137         final Collection<YangModelCmHandle> yangModelCmHandles
 138                 = inventoryPersistence.getYangModelCmHandles(cmHandlesIds);
 139
 140         final Map<String, List<DmiDataOperation>> operationsOutPerDmiServiceName
 141                 = ResourceDataOperationRequestUtils.processPerDefinitionInDataOperationsRequest(topicParamInQuery,
 142                 requestId, dataOperationRequest, yangModelCmHandles);
 143
 144         buildDataOperationRequestUrlAndSendToDmiService(topicParamInQuery, requestId, operationsOutPerDmiServiceName);
 145     }
 146
 147     /**
 148      * This method creates the resource data from pass-through running data store for given cm handle
 149      * identifier on given resource using dmi client.
 150      *
 151      * @param cmHandleId    network resource identifier
 152      * @param resourceId    resource identifier
 153      * @param operationType operation enum
 154      * @param requestData   the request data
 155      * @param dataType      data type
 156      * @return {@code ResponseEntity} response entity
 157      */
 158     public ResponseEntity<Object> writeResourceDataPassThroughRunningFromDmi(final String cmHandleId,
 159                                                                              final String resourceId,
 160                                                                              final OperationType operationType,
 161                                                                              final String requestData,
 162                                                                              final String dataType) {
 163         final YangModelCmHandle yangModelCmHandle = getYangModelCmHandle(cmHandleId);
 164         final String jsonRequestBody = getDmiRequestBody(operationType, null, requestData, dataType,
 165                 yangModelCmHandle);
 166         final String dmiUrl = getDmiRequestUrl(PASSTHROUGH_RUNNING.getDatastoreName(), cmHandleId, resourceId,
 167                 null, null,
 168                 yangModelCmHandle.resolveDmiServiceName(RequiredDmiService.DATA));
 169         final CmHandleState cmHandleState = yangModelCmHandle.getCompositeState().getCmHandleState();
 170         validateIfCmHandleStateReady(yangModelCmHandle, cmHandleState);
 171         return dmiRestClient.postOperationWithJsonData(dmiUrl, jsonRequestBody, operationType);
 172     }
 173
 174     private YangModelCmHandle getYangModelCmHandle(final String cmHandleId) {
 175         return inventoryPersistence.getYangModelCmHandle(cmHandleId);
 176     }
 177
 178     private String getDmiRequestBody(final OperationType operationType,
 179                                      final String requestId,
 180                                      final String requestData,
 181                                      final String dataType,
 182                                      final YangModelCmHandle yangModelCmHandle) {
 183         final DmiRequestBody dmiRequestBody = DmiRequestBody.builder()
 184                 .operationType(operationType)
 185                 .requestId(requestId)
 186                 .data(requestData)
 187                 .dataType(dataType)
 188                 .build();
 189         dmiRequestBody.asDmiProperties(yangModelCmHandle.getDmiProperties());
 190         return jsonObjectMapper.asJsonString(dmiRequestBody);
 191     }
 192
 193     private String getDmiRequestUrl(final String dataStoreName,
 194                                     final String cmHandleId,
 195                                     final String resourceId,
 196                                     final String optionsParamInQuery,
 197                                     final String topicParamInQuery,
 198                                     final String dmiServiceName) {
 199         return dmiServiceUrlBuilder.getDmiDatastoreUrl(
 200                 dmiServiceUrlBuilder.populateQueryParams(resourceId, optionsParamInQuery,
 201                         topicParamInQuery), dmiServiceUrlBuilder.populateUriVariables(dataStoreName, dmiServiceName,
 202                         cmHandleId));
 203     }
 204
 205     private String getDmiServiceDataOperationRequestUrl(final String dmiServiceName,
 206                                                         final String topicParamInQuery,
 207                                                         final String requestId) {
 208         final MultiValueMap<String, String> dataOperationRequestQueryParams = dmiServiceUrlBuilder
 209                 .getDataOperationRequestQueryParams(topicParamInQuery, requestId);
 210         return dmiServiceUrlBuilder.getDataOperationRequestUrl(dataOperationRequestQueryParams,
 211                 dmiServiceUrlBuilder.populateDataOperationRequestUriVariables(dmiServiceName));
 212     }
 213
 214     private void validateIfCmHandleStateReady(final YangModelCmHandle yangModelCmHandle,
 215                                               final CmHandleState cmHandleState) {
 216         if (cmHandleState != CmHandleState.READY) {
 217             throw new CpsException("State mismatch exception.", "Cm-Handle not in READY state. "
 218                     + "cm handle state is "
 219                     + yangModelCmHandle.getCompositeState().getCmHandleState());
 220         }
 221     }
 222
 223     private static Set<String> getDistinctCmHandleIdsFromDataOperationRequest(final DataOperationRequest
 224                                                                               dataOperationRequest) {
 225         return dataOperationRequest.getDataOperationDefinitions().stream()
 226                 .flatMap(dataOperationDefinition ->
 227                         dataOperationDefinition.getCmHandleIds().stream()).collect(Collectors.toSet());
 228     }
 229
 230     private void buildDataOperationRequestUrlAndSendToDmiService(final String topicParamInQuery,
 231                                                                  final String requestId,
 232                                                                  final Map<String, List<DmiDataOperation>>
 233                                                                 groupsOutPerDmiServiceName) {
 234
 235         groupsOutPerDmiServiceName.forEach((dmiServiceName, dmiDataOperationRequestBodies) -> {
 236             final String dmiDataOperationResourceUrl =
 237                     getDmiServiceDataOperationRequestUrl(dmiServiceName, topicParamInQuery, requestId);
 238             sendDataOperationRequestToDmiService(dmiDataOperationResourceUrl, dmiDataOperationRequestBodies);
 239         });
 240     }
 241
 242     private void sendDataOperationRequestToDmiService(final String dataOperationResourceUrl,
 243                                                       final List<DmiDataOperation> dmiDataOperationRequestBodies) {
 244         final DmiDataOperationRequest dmiDataOperationRequest = DmiDataOperationRequest.builder()
 245                 .operations(dmiDataOperationRequestBodies).build();
 246         final String dmiDataOperationRequestAsJsonString =
 247                 jsonObjectMapper.asJsonString(dmiDataOperationRequest);
 248         TaskExecutor.executeTask(() -> dmiRestClient.postOperationWithJsonData(dataOperationResourceUrl,
 249                                 dmiDataOperationRequestAsJsonString, READ),
 250                         DEFAULT_ASYNC_TASK_EXECUTOR_TIMEOUT_IN_MILLISECONDS)
 251                 .whenCompleteAsync((response, throwable) -> handleTaskCompletionException(throwable,
 252                         dataOperationResourceUrl, dmiDataOperationRequestBodies));
 253     }
 254
 255     private void handleTaskCompletionException(final Throwable throwable,
 256                                                final String dataOperationResourceUrl,
 257                                                final List<DmiDataOperation> dmiDataOperationRequestBodies) {
 258         if (throwable != null) {
 259             final MultiValueMap<String, String> dataOperationResourceUrlParameters =
 260                     UriComponentsBuilder.fromUriString(dataOperationResourceUrl).build().getQueryParams();
 261             final String topicName = dataOperationResourceUrlParameters.get("topic").get(0);
 262             final String requestId = dataOperationResourceUrlParameters.get("requestId").get(0);
 263
 264             final MultiValueMap<DmiDataOperation, Map<NcmpResponseStatus, List<String>>>
 265                     cmHandleIdsPerResponseCodesPerOperation = new LinkedMultiValueMap<>();
 266
 267             dmiDataOperationRequestBodies.forEach(dmiDataOperationRequestBody -> {
 268                 final List<String> cmHandleIds = dmiDataOperationRequestBody.getCmHandles().stream()
 269                         .map(CmHandle::getId).toList();
 270                 if (throwable.getCause() instanceof HttpClientRequestException) {
 271                     cmHandleIdsPerResponseCodesPerOperation.add(dmiDataOperationRequestBody,
 272                             Map.of(UNABLE_TO_READ_RESOURCE_DATA, cmHandleIds));
 273                 } else {
 274                     cmHandleIdsPerResponseCodesPerOperation.add(dmiDataOperationRequestBody,
 275                             Map.of(DMI_SERVICE_NOT_RESPONDING, cmHandleIds));
 276                 }
 277             });
 278             ResourceDataOperationRequestUtils.publishErrorMessageToClientTopic(topicName, requestId,
 279                     cmHandleIdsPerResponseCodesPerOperation);
 280         }
 281     }
 282 }