cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/utils/data/operation/ResourceDataOperationRequestUtils.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 2023 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.api.impl.utils.data.operation;
  22
  23 import io.cloudevents.CloudEvent;
  24 import java.util.ArrayList;
  25 import java.util.Collection;
  26 import java.util.Collections;
  27 import java.util.HashMap;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Set;
  31 import java.util.stream.Collectors;
  32 import lombok.AccessLevel;
  33 import lombok.NoArgsConstructor;
  34 import lombok.extern.slf4j.Slf4j;
  35 import org.onap.cps.ncmp.api.NcmpEventResponseCode;
  36 import org.onap.cps.ncmp.api.impl.events.EventsPublisher;
  37 import org.onap.cps.ncmp.api.impl.operations.CmHandle;
  38 import org.onap.cps.ncmp.api.impl.operations.DmiDataOperation;
  39 import org.onap.cps.ncmp.api.impl.utils.DmiServiceNameOrganizer;
  40 import org.onap.cps.ncmp.api.impl.utils.context.CpsApplicationContext;
  41 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  42 import org.onap.cps.ncmp.api.inventory.CmHandleState;
  43 import org.onap.cps.ncmp.api.models.DataOperationDefinition;
  44 import org.onap.cps.ncmp.api.models.DataOperationRequest;
  45 import org.springframework.scheduling.annotation.Async;
  46 import org.springframework.util.LinkedMultiValueMap;
  47 import org.springframework.util.MultiValueMap;
  48
  49 @Slf4j
  50 @NoArgsConstructor(access = AccessLevel.PRIVATE)
  51 public class ResourceDataOperationRequestUtils {
  52
  53     private static final String UNKNOWN_SERVICE_NAME = null;
  54
  55     /**
  56      * Create a list of DMI data operation per DMI service (name).
  57      *
  58      * @param topicParamInQuery      client given topic
  59      * @param requestId              unique identifier per request
  60      * @param dataOperationRequestIn incoming data operation request details
  61      * @param yangModelCmHandles     involved cm handles represented as YangModelCmHandle (incl. metadata)
  62      * @return {@code Map<String, List<DmiBatchOperation>>} Create a list of DMI batch operation per DMI service (name).
  63      */
  64     public static Map<String, List<DmiDataOperation>> processPerDefinitionInDataOperationsRequest(
  65             final String topicParamInQuery,
  66             final String requestId,
  67             final DataOperationRequest dataOperationRequestIn,
  68             final Collection<YangModelCmHandle> yangModelCmHandles) {
  69
  70         final Map<String, List<DmiDataOperation>> dmiDataOperationsOutPerDmiServiceName = new HashMap<>();
  71         final MultiValueMap<DmiDataOperation, Map<NcmpEventResponseCode,
  72                 List<String>>> cmHandleIdsPerResponseCodesPerOperation = new LinkedMultiValueMap<>();
  73         final Set<String> nonReadyCmHandleIdsLookup = filterAndGetNonReadyCmHandleIds(yangModelCmHandles);
  74
  75         final Map<String, Map<String, Map<String, String>>> dmiPropertiesPerCmHandleIdPerServiceName =
  76                 DmiServiceNameOrganizer.getDmiPropertiesPerCmHandleIdPerServiceName(yangModelCmHandles);
  77
  78         final Map<String, String> dmiServiceNamesPerCmHandleId =
  79                 getDmiServiceNamesPerCmHandleId(dmiPropertiesPerCmHandleIdPerServiceName);
  80
  81         for (final DataOperationDefinition dataOperationDefinitionIn :
  82                 dataOperationRequestIn.getDataOperationDefinitions()) {
  83             final List<String> nonExistingCmHandleIds = new ArrayList<>();
  84             final List<String> nonReadyCmHandleIds = new ArrayList<>();
  85             for (final String cmHandleId : dataOperationDefinitionIn.getCmHandleIds()) {
  86                 if (nonReadyCmHandleIdsLookup.contains(cmHandleId)) {
  87                     nonReadyCmHandleIds.add(cmHandleId);
  88                 } else {
  89                     final String dmiServiceName = dmiServiceNamesPerCmHandleId.get(cmHandleId);
  90                     final Map<String, String> cmHandleIdProperties
  91                             = dmiPropertiesPerCmHandleIdPerServiceName.get(dmiServiceName).get(cmHandleId);
  92                     if (cmHandleIdProperties == null) {
  93                         nonExistingCmHandleIds.add(cmHandleId);
  94                     } else {
  95                         final DmiDataOperation dmiBatchOperationOut = getOrAddDmiBatchOperation(dmiServiceName,
  96                                 dataOperationDefinitionIn, dmiDataOperationsOutPerDmiServiceName);
  97                         final CmHandle cmHandle = CmHandle.buildCmHandleWithProperties(cmHandleId,
  98                                 cmHandleIdProperties);
  99                         dmiBatchOperationOut.getCmHandles().add(cmHandle);
 100                     }
 101                 }
 102             }
 103             populateCmHandleIdsPerOperationIdPerResponseCode(cmHandleIdsPerResponseCodesPerOperation,
 104                     DmiDataOperation.buildDmiDataOperationRequestBodyWithoutCmHandles(dataOperationDefinitionIn),
 105                     NcmpEventResponseCode.CM_HANDLES_NOT_FOUND, nonExistingCmHandleIds);
 106             populateCmHandleIdsPerOperationIdPerResponseCode(cmHandleIdsPerResponseCodesPerOperation,
 107                     DmiDataOperation.buildDmiDataOperationRequestBodyWithoutCmHandles(dataOperationDefinitionIn),
 108                     NcmpEventResponseCode.CM_HANDLES_NOT_READY, nonReadyCmHandleIds);
 109         }
 110         if (!cmHandleIdsPerResponseCodesPerOperation.isEmpty()) {
 111             publishErrorMessageToClientTopic(topicParamInQuery, requestId, cmHandleIdsPerResponseCodesPerOperation);
 112         }
 113         return dmiDataOperationsOutPerDmiServiceName;
 114     }
 115
 116     /**
 117      * Creates data operation cloud event and publish it to client topic.
 118      *
 119      * @param clientTopic                              client given topic
 120      * @param requestId                                unique identifier per request
 121      * @param cmHandleIdsPerResponseCodesPerOperation list of cm handle ids per operation with response code
 122      */
 123     @Async
 124     public static void publishErrorMessageToClientTopic(final String clientTopic,
 125                                                          final String requestId,
 126                                                          final MultiValueMap<DmiDataOperation,
 127                                                                  Map<NcmpEventResponseCode, List<String>>>
 128                                                                     cmHandleIdsPerResponseCodesPerOperation) {
 129         final CloudEvent dataOperationCloudEvent = DataOperationEventCreator.createDataOperationEvent(clientTopic,
 130                 requestId, cmHandleIdsPerResponseCodesPerOperation);
 131         final EventsPublisher<CloudEvent> eventsPublisher = CpsApplicationContext.getCpsBean(EventsPublisher.class);
 132         eventsPublisher.publishCloudEvent(clientTopic, requestId, dataOperationCloudEvent);
 133     }
 134
 135     private static Map<String, String> getDmiServiceNamesPerCmHandleId(
 136             final Map<String, Map<String, Map<String, String>>> dmiDmiPropertiesPerCmHandleIdPerServiceName) {
 137         final Map<String, String> dmiServiceNamesPerCmHandleId = new HashMap<>();
 138         for (final Map.Entry<String, Map<String, Map<String, String>>> dmiDmiPropertiesEntry
 139                 : dmiDmiPropertiesPerCmHandleIdPerServiceName.entrySet()) {
 140             final String dmiServiceName = dmiDmiPropertiesEntry.getKey();
 141             final Set<String> cmHandleIds = dmiDmiPropertiesPerCmHandleIdPerServiceName.get(dmiServiceName).keySet();
 142             for (final String cmHandleId : cmHandleIds) {
 143                 dmiServiceNamesPerCmHandleId.put(cmHandleId, dmiServiceName);
 144             }
 145         }
 146         dmiDmiPropertiesPerCmHandleIdPerServiceName.put(UNKNOWN_SERVICE_NAME, Collections.emptyMap());
 147         return dmiServiceNamesPerCmHandleId;
 148     }
 149
 150     private static DmiDataOperation getOrAddDmiBatchOperation(final String dmiServiceName,
 151                                                                final DataOperationDefinition
 152                                                                        dataOperationDefinitionIn,
 153                                                                final Map<String, List<DmiDataOperation>>
 154                                                                        dmiBatchOperationsOutPerDmiServiceName) {
 155         dmiBatchOperationsOutPerDmiServiceName
 156                 .computeIfAbsent(dmiServiceName, dmiServiceNameAsKey -> new ArrayList<>());
 157         final List<DmiDataOperation> dmiBatchOperationsOut
 158                 = dmiBatchOperationsOutPerDmiServiceName.get(dmiServiceName);
 159         final boolean isNewOperation = dmiBatchOperationsOut.isEmpty()
 160                 || !dmiBatchOperationsOut.get(dmiBatchOperationsOut.size() - 1).getOperationId()
 161                 .equals(dataOperationDefinitionIn.getOperationId());
 162         if (isNewOperation) {
 163             final DmiDataOperation newDmiBatchOperationOut =
 164                     DmiDataOperation.buildDmiDataOperationRequestBodyWithoutCmHandles(dataOperationDefinitionIn);
 165             dmiBatchOperationsOut.add(newDmiBatchOperationOut);
 166             return newDmiBatchOperationOut;
 167         }
 168         return dmiBatchOperationsOut.get(dmiBatchOperationsOut.size() - 1);
 169     }
 170
 171     private static Set<String> filterAndGetNonReadyCmHandleIds(final Collection<YangModelCmHandle> yangModelCmHandles) {
 172         return yangModelCmHandles.stream()
 173                 .filter(yangModelCmHandle -> yangModelCmHandle.getCompositeState().getCmHandleState()
 174                         != CmHandleState.READY).map(YangModelCmHandle::getId).collect(Collectors.toSet());
 175     }
 176
 177     private static void populateCmHandleIdsPerOperationIdPerResponseCode(final MultiValueMap<DmiDataOperation,
 178             Map<NcmpEventResponseCode, List<String>>> cmHandleIdsPerResponseCodesPerOperation,
 179                                                                         final DmiDataOperation dmiDataOperation,
 180                                                                         final NcmpEventResponseCode
 181                                                                                 ncmpEventResponseCode,
 182                                                                         final List<String> cmHandleIds) {
 183         if (!cmHandleIds.isEmpty()) {
 184             cmHandleIdsPerResponseCodesPerOperation.add(dmiDataOperation, Map.of(ncmpEventResponseCode, cmHandleIds));
 185         }
 186     }
 187 }