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