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-2024 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 static org.onap.cps.ncmp.api.NcmpResponseStatus.CM_HANDLES_NOT_FOUND;
  24 import static org.onap.cps.ncmp.api.NcmpResponseStatus.CM_HANDLES_NOT_READY;
  25
  26 import io.cloudevents.CloudEvent;
  27 import java.util.ArrayList;
  28 import java.util.Collection;
  29 import java.util.Collections;
  30 import java.util.HashMap;
  31 import java.util.List;
  32 import java.util.Map;
  33 import java.util.Set;
  34 import java.util.stream.Collectors;
  35 import lombok.AccessLevel;
  36 import lombok.NoArgsConstructor;
  37 import lombok.extern.slf4j.Slf4j;
  38 import org.onap.cps.events.EventsPublisher;
  39 import org.onap.cps.ncmp.api.NcmpResponseStatus;
  40 import org.onap.cps.ncmp.api.impl.inventory.CmHandleState;
  41 import org.onap.cps.ncmp.api.impl.operations.CmHandle;
  42 import org.onap.cps.ncmp.api.impl.operations.DmiDataOperation;
  43 import org.onap.cps.ncmp.api.impl.utils.DmiServiceNameOrganizer;
  44 import org.onap.cps.ncmp.api.impl.utils.context.CpsApplicationContext;
  45 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  46 import org.onap.cps.ncmp.api.models.DataOperationDefinition;
  47 import org.onap.cps.ncmp.api.models.DataOperationRequest;
  48 import org.springframework.util.LinkedMultiValueMap;
  49 import org.springframework.util.MultiValueMap;
  50
  51 @Slf4j
  52 @NoArgsConstructor(access = AccessLevel.PRIVATE)
  53 public class ResourceDataOperationRequestUtils {
  54
  55     private static final String UNKNOWN_SERVICE_NAME = null;
  56
  57     /**
  58      * Create a list of DMI data operation per DMI service (name).
  59      *
  60      * @param topicParamInQuery      client given topic
  61      * @param requestId              unique identifier per request
  62      * @param dataOperationRequestIn incoming data operation request details
  63      * @param yangModelCmHandles     involved cm handles represented as YangModelCmHandle (incl. metadata)
  64      * @return {@code Map<String, List<DmiBatchOperation>>} Create a list of DMI batch operation per DMI service (name).
  65      */
  66     public static Map<String, List<DmiDataOperation>> processPerDefinitionInDataOperationsRequest(
  67             final String topicParamInQuery,
  68             final String requestId,
  69             final DataOperationRequest dataOperationRequestIn,
  70             final Collection<YangModelCmHandle> yangModelCmHandles) {
  71
  72         final Map<String, List<DmiDataOperation>> dmiDataOperationsOutPerDmiServiceName = new HashMap<>();
  73         final MultiValueMap<DmiDataOperation, Map<NcmpResponseStatus,
  74                 List<String>>> cmHandleIdsPerResponseCodesPerOperation = new LinkedMultiValueMap<>();
  75         final Set<String> nonReadyCmHandleIdsLookup = filterAndGetNonReadyCmHandleIds(yangModelCmHandles);
  76
  77         final Map<String, Map<String, Map<String, String>>> dmiPropertiesPerCmHandleIdPerServiceName =
  78                 DmiServiceNameOrganizer.getDmiPropertiesPerCmHandleIdPerServiceName(yangModelCmHandles);
  79
  80         final Map<String, String> dmiServiceNamesPerCmHandleId =
  81                 getDmiServiceNamesPerCmHandleId(dmiPropertiesPerCmHandleIdPerServiceName);
  82
  83         for (final DataOperationDefinition dataOperationDefinitionIn :
  84                 dataOperationRequestIn.getDataOperationDefinitions()) {
  85             final List<String> nonExistingCmHandleIds = new ArrayList<>();
  86             final List<String> nonReadyCmHandleIds = new ArrayList<>();
  87             for (final String cmHandleId : dataOperationDefinitionIn.getCmHandleIds()) {
  88                 if (nonReadyCmHandleIdsLookup.contains(cmHandleId)) {
  89                     nonReadyCmHandleIds.add(cmHandleId);
  90                 } else {
  91                     final String dmiServiceName = dmiServiceNamesPerCmHandleId.get(cmHandleId);
  92                     final Map<String, String> cmHandleIdProperties
  93                             = dmiPropertiesPerCmHandleIdPerServiceName.get(dmiServiceName).get(cmHandleId);
  94                     if (cmHandleIdProperties == null) {
  95                         nonExistingCmHandleIds.add(cmHandleId);
  96                     } else {
  97                         final DmiDataOperation dmiBatchOperationOut = getOrAddDmiBatchOperation(dmiServiceName,
  98                                 dataOperationDefinitionIn, dmiDataOperationsOutPerDmiServiceName);
  99                         final CmHandle cmHandle = CmHandle.buildCmHandleWithProperties(cmHandleId,
 100                                 cmHandleIdProperties);
 101                         dmiBatchOperationOut.getCmHandles().add(cmHandle);
 102                     }
 103                 }
 104             }
 105             populateCmHandleIdsPerOperationIdPerResponseCode(cmHandleIdsPerResponseCodesPerOperation,
 106                     DmiDataOperation.buildDmiDataOperationRequestBodyWithoutCmHandles(dataOperationDefinitionIn),
 107                     CM_HANDLES_NOT_FOUND, nonExistingCmHandleIds);
 108             populateCmHandleIdsPerOperationIdPerResponseCode(cmHandleIdsPerResponseCodesPerOperation,
 109                     DmiDataOperation.buildDmiDataOperationRequestBodyWithoutCmHandles(dataOperationDefinitionIn),
 110                     CM_HANDLES_NOT_READY, nonReadyCmHandleIds);
 111         }
 112         if (!cmHandleIdsPerResponseCodesPerOperation.isEmpty()) {
 113             publishErrorMessageToClientTopic(topicParamInQuery, requestId, cmHandleIdsPerResponseCodesPerOperation);
 114         }
 115         return dmiDataOperationsOutPerDmiServiceName;
 116     }
 117
 118     /**
 119      * Creates data operation cloud event and publish it to client topic.
 120      *
 121      * @param clientTopic                              client given topic
 122      * @param requestId                                unique identifier per request
 123      * @param cmHandleIdsPerResponseCodesPerOperation list of cm handle ids per operation with response code
 124      */
 125     public static void publishErrorMessageToClientTopic(final String clientTopic,
 126                                                          final String requestId,
 127                                                          final MultiValueMap<DmiDataOperation,
 128                                                                  Map<NcmpResponseStatus, List<String>>>
 129                                                                     cmHandleIdsPerResponseCodesPerOperation) {
 130         final CloudEvent dataOperationCloudEvent = DataOperationEventCreator.createDataOperationEvent(clientTopic,
 131                 requestId, cmHandleIdsPerResponseCodesPerOperation);
 132         final EventsPublisher<CloudEvent> eventsPublisher = CpsApplicationContext.getCpsBean(EventsPublisher.class);
 133         eventsPublisher.publishCloudEvent(clientTopic, requestId, dataOperationCloudEvent);
 134     }
 135
 136     private static Map<String, String> getDmiServiceNamesPerCmHandleId(
 137             final Map<String, Map<String, Map<String, String>>> dmiDmiPropertiesPerCmHandleIdPerServiceName) {
 138         final Map<String, String> dmiServiceNamesPerCmHandleId = new HashMap<>();
 139         for (final Map.Entry<String, Map<String, Map<String, String>>> dmiDmiPropertiesEntry
 140                 : dmiDmiPropertiesPerCmHandleIdPerServiceName.entrySet()) {
 141             final String dmiServiceName = dmiDmiPropertiesEntry.getKey();
 142             final Set<String> cmHandleIds = dmiDmiPropertiesPerCmHandleIdPerServiceName.get(dmiServiceName).keySet();
 143             for (final String cmHandleId : cmHandleIds) {
 144                 dmiServiceNamesPerCmHandleId.put(cmHandleId, dmiServiceName);
 145             }
 146         }
 147         dmiDmiPropertiesPerCmHandleIdPerServiceName.put(UNKNOWN_SERVICE_NAME, Collections.emptyMap());
 148         return dmiServiceNamesPerCmHandleId;
 149     }
 150
 151     private static DmiDataOperation getOrAddDmiBatchOperation(final String dmiServiceName,
 152                                                                final DataOperationDefinition
 153                                                                        dataOperationDefinitionIn,
 154                                                                final Map<String, List<DmiDataOperation>>
 155                                                                        dmiBatchOperationsOutPerDmiServiceName) {
 156         dmiBatchOperationsOutPerDmiServiceName
 157                 .computeIfAbsent(dmiServiceName, dmiServiceNameAsKey -> new ArrayList<>());
 158         final List<DmiDataOperation> dmiBatchOperationsOut
 159                 = dmiBatchOperationsOutPerDmiServiceName.get(dmiServiceName);
 160         final boolean isNewOperation = dmiBatchOperationsOut.isEmpty()
 161                 || !dmiBatchOperationsOut.get(dmiBatchOperationsOut.size() - 1).getOperationId()
 162                 .equals(dataOperationDefinitionIn.getOperationId());
 163         if (isNewOperation) {
 164             final DmiDataOperation newDmiBatchOperationOut =
 165                     DmiDataOperation.buildDmiDataOperationRequestBodyWithoutCmHandles(dataOperationDefinitionIn);
 166             dmiBatchOperationsOut.add(newDmiBatchOperationOut);
 167             return newDmiBatchOperationOut;
 168         }
 169         return dmiBatchOperationsOut.get(dmiBatchOperationsOut.size() - 1);
 170     }
 171
 172     private static Set<String> filterAndGetNonReadyCmHandleIds(final Collection<YangModelCmHandle> yangModelCmHandles) {
 173         return yangModelCmHandles.stream()
 174                 .filter(yangModelCmHandle -> yangModelCmHandle.getCompositeState().getCmHandleState()
 175                         != CmHandleState.READY).map(YangModelCmHandle::getId).collect(Collectors.toSet());
 176     }
 177
 178     private static void populateCmHandleIdsPerOperationIdPerResponseCode(final MultiValueMap<DmiDataOperation,
 179             Map<NcmpResponseStatus, List<String>>> cmHandleIdsPerResponseCodesPerOperation,
 180                                                                         final DmiDataOperation dmiDataOperation,
 181                                                                         final NcmpResponseStatus
 182                                                                                  ncmpResponseStatus,
 183                                                                         final List<String> cmHandleIds) {
 184         if (!cmHandleIds.isEmpty()) {
 185             cmHandleIdsPerResponseCodesPerOperation.add(dmiDataOperation, Map.of(ncmpResponseStatus, cmHandleIds));
 186         }
 187     }
 188 }