cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/utils/ResourceDataBatchRequestUtils.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;
  22
  23 import java.util.ArrayList;
  24 import java.util.Collection;
  25 import java.util.Collections;
  26 import java.util.HashMap;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.Set;
  30 import lombok.AccessLevel;
  31 import lombok.NoArgsConstructor;
  32 import lombok.extern.slf4j.Slf4j;
  33 import org.onap.cps.ncmp.api.impl.operations.CmHandle;
  34 import org.onap.cps.ncmp.api.impl.operations.DmiBatchOperation;
  35 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  36 import org.onap.cps.ncmp.api.models.BatchOperationDefinition;
  37 import org.onap.cps.ncmp.api.models.ResourceDataBatchRequest;
  38
  39 @Slf4j
  40 @NoArgsConstructor(access = AccessLevel.PRIVATE)
  41 public class ResourceDataBatchRequestUtils {
  42
  43     private static final String UNKNOWN_SERVICE_NAME = null;
  44
  45     /**
  46      * Create a list of DMI batch operation per DMI service (name).
  47      *
  48      * @param resourceDataBatchRequestIn incoming batch request details for resource data
  49      * @param yangModelCmHandles involved cm handles represented as YangModelCmHandle (incl. metadata)
  50      *
  51      * @return {@code Map<String, List<DmiBatchOperation>>} Create a list of DMI batch operation per DMI service (name).
  52      */
  53     public static Map<String, List<DmiBatchOperation>> processPerOperationInBatchRequest(
  54             final ResourceDataBatchRequest resourceDataBatchRequestIn,
  55             final Collection<YangModelCmHandle> yangModelCmHandles) {
  56
  57         final Map<String, Map<String, Map<String, String>>> dmiPropertiesPerCmHandleIdPerServiceName =
  58                 DmiServiceNameOrganizer.getDmiPropertiesPerCmHandleIdPerServiceName(yangModelCmHandles);
  59
  60         final Map<String, String> dmiServiceNamesPerCmHandleId =
  61             getDmiServiceNamesPerCmHandleId(dmiPropertiesPerCmHandleIdPerServiceName);
  62
  63         final Map<String, List<DmiBatchOperation>> dmiBatchOperationsOutPerDmiServiceName = new HashMap<>();
  64
  65         for (final BatchOperationDefinition batchOperationDefinitionIn :
  66             resourceDataBatchRequestIn.getBatchOperationDefinitions()) {
  67             for (final String cmHandleId : batchOperationDefinitionIn.getCmHandleIds()) {
  68                 final String dmiServiceName = dmiServiceNamesPerCmHandleId.get(cmHandleId);
  69                 final Map<String, String> cmHandleIdProperties
  70                         = dmiPropertiesPerCmHandleIdPerServiceName.get(dmiServiceName).get(cmHandleId);
  71                 if (cmHandleIdProperties == null) {
  72                     publishErrorMessageToClientTopic(cmHandleId);
  73                 } else {
  74                     final DmiBatchOperation dmiBatchOperationOut = getOrAddDmiBatchOperation(dmiServiceName,
  75                         batchOperationDefinitionIn, dmiBatchOperationsOutPerDmiServiceName);
  76                     final CmHandle cmHandle = CmHandle.buildCmHandleWithProperties(cmHandleId, cmHandleIdProperties);
  77                     dmiBatchOperationOut.getCmHandles().add(cmHandle);
  78                 }
  79             }
  80         }
  81         return dmiBatchOperationsOutPerDmiServiceName;
  82     }
  83
  84     private static void publishErrorMessageToClientTopic(final String requestedCmHandleId) {
  85         log.warn("cm handle {} not found", requestedCmHandleId);
  86         // TODO Need to publish an error response to client given topic.
  87         //  Code should be implemented into https://jira.onap.org/browse/CPS-1583 (
  88         //  NCMP : Handle non-existing cm handles)
  89     }
  90
  91     private static Map<String, String> getDmiServiceNamesPerCmHandleId(
  92             final Map<String, Map<String, Map<String, String>>> dmiDmiPropertiesPerCmHandleIdPerServiceName) {
  93         final Map<String, String> dmiServiceNamesPerCmHandleId = new HashMap<>();
  94         for (final Map.Entry<String, Map<String, Map<String, String>>> dmiDmiPropertiesEntry
  95                 : dmiDmiPropertiesPerCmHandleIdPerServiceName.entrySet()) {
  96             final String dmiServiceName = dmiDmiPropertiesEntry.getKey();
  97             final Set<String> cmHandleIds = dmiDmiPropertiesPerCmHandleIdPerServiceName.get(dmiServiceName).keySet();
  98             for (final String cmHandleId : cmHandleIds) {
  99                 dmiServiceNamesPerCmHandleId.put(cmHandleId, dmiServiceName);
 100             }
 101         }
 102         dmiDmiPropertiesPerCmHandleIdPerServiceName.put(UNKNOWN_SERVICE_NAME, Collections.emptyMap());
 103         return dmiServiceNamesPerCmHandleId;
 104     }
 105
 106     private static DmiBatchOperation getOrAddDmiBatchOperation(final String dmiServiceName,
 107                                                                final BatchOperationDefinition
 108                                                                        batchOperationDefinitionIn,
 109                                                                final Map<String, List<DmiBatchOperation>>
 110                                                                        dmiBatchOperationsOutPerDmiServiceName) {
 111         dmiBatchOperationsOutPerDmiServiceName
 112                 .computeIfAbsent(dmiServiceName, dmiServiceNameAsKey -> new ArrayList<>());
 113         final List<DmiBatchOperation> dmiBatchOperationsOut
 114                 = dmiBatchOperationsOutPerDmiServiceName.get(dmiServiceName);
 115         final boolean isNewOperation = dmiBatchOperationsOut.isEmpty()
 116                 || !dmiBatchOperationsOut.get(dmiBatchOperationsOut.size() - 1).getOperationId()
 117                 .equals(batchOperationDefinitionIn.getOperationId());
 118         if (isNewOperation) {
 119             final DmiBatchOperation newDmiBatchOperationOut =
 120                     DmiBatchOperation.buildDmiBatchRequestBodyWithoutCmHandles(batchOperationDefinitionIn);
 121             dmiBatchOperationsOut.add(newDmiBatchOperationOut);
 122             return newDmiBatchOperationOut;
 123         }
 124         return dmiBatchOperationsOut.get(dmiBatchOperationsOut.size() - 1);
 125     }
 126 }