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