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