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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.cps.ncmp.api.impl.utils.data.operation;
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;
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;
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.ncmp.api.NcmpResponseStatus;
39 import org.onap.cps.ncmp.api.impl.events.EventsPublisher;
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.scheduling.annotation.Async;
49 import org.springframework.util.LinkedMultiValueMap;
50 import org.springframework.util.MultiValueMap;
53 @NoArgsConstructor(access = AccessLevel.PRIVATE)
54 public class ResourceDataOperationRequestUtils {
56 private static final String UNKNOWN_SERVICE_NAME = null;
59 * Create a list of DMI data operation per DMI service (name).
61 * @param topicParamInQuery client given topic
62 * @param requestId unique identifier per request
63 * @param dataOperationRequestIn incoming data operation request details
64 * @param yangModelCmHandles involved cm handles represented as YangModelCmHandle (incl. metadata)
65 * @return {@code Map<String, List<DmiBatchOperation>>} Create a list of DMI batch operation per DMI service (name).
67 public static Map<String, List<DmiDataOperation>> processPerDefinitionInDataOperationsRequest(
68 final String topicParamInQuery,
69 final String requestId,
70 final DataOperationRequest dataOperationRequestIn,
71 final Collection<YangModelCmHandle> yangModelCmHandles) {
73 final Map<String, List<DmiDataOperation>> dmiDataOperationsOutPerDmiServiceName = new HashMap<>();
74 final MultiValueMap<DmiDataOperation, Map<NcmpResponseStatus,
75 List<String>>> cmHandleIdsPerResponseCodesPerOperation = new LinkedMultiValueMap<>();
76 final Set<String> nonReadyCmHandleIdsLookup = filterAndGetNonReadyCmHandleIds(yangModelCmHandles);
78 final Map<String, Map<String, Map<String, String>>> dmiPropertiesPerCmHandleIdPerServiceName =
79 DmiServiceNameOrganizer.getDmiPropertiesPerCmHandleIdPerServiceName(yangModelCmHandles);
81 final Map<String, String> dmiServiceNamesPerCmHandleId =
82 getDmiServiceNamesPerCmHandleId(dmiPropertiesPerCmHandleIdPerServiceName);
84 for (final DataOperationDefinition dataOperationDefinitionIn :
85 dataOperationRequestIn.getDataOperationDefinitions()) {
86 final List<String> nonExistingCmHandleIds = new ArrayList<>();
87 final List<String> nonReadyCmHandleIds = new ArrayList<>();
88 for (final String cmHandleId : dataOperationDefinitionIn.getCmHandleIds()) {
89 if (nonReadyCmHandleIdsLookup.contains(cmHandleId)) {
90 nonReadyCmHandleIds.add(cmHandleId);
92 final String dmiServiceName = dmiServiceNamesPerCmHandleId.get(cmHandleId);
93 final Map<String, String> cmHandleIdProperties
94 = dmiPropertiesPerCmHandleIdPerServiceName.get(dmiServiceName).get(cmHandleId);
95 if (cmHandleIdProperties == null) {
96 nonExistingCmHandleIds.add(cmHandleId);
98 final DmiDataOperation dmiBatchOperationOut = getOrAddDmiBatchOperation(dmiServiceName,
99 dataOperationDefinitionIn, dmiDataOperationsOutPerDmiServiceName);
100 final CmHandle cmHandle = CmHandle.buildCmHandleWithProperties(cmHandleId,
101 cmHandleIdProperties);
102 dmiBatchOperationOut.getCmHandles().add(cmHandle);
106 populateCmHandleIdsPerOperationIdPerResponseCode(cmHandleIdsPerResponseCodesPerOperation,
107 DmiDataOperation.buildDmiDataOperationRequestBodyWithoutCmHandles(dataOperationDefinitionIn),
108 CM_HANDLES_NOT_FOUND, nonExistingCmHandleIds);
109 populateCmHandleIdsPerOperationIdPerResponseCode(cmHandleIdsPerResponseCodesPerOperation,
110 DmiDataOperation.buildDmiDataOperationRequestBodyWithoutCmHandles(dataOperationDefinitionIn),
111 CM_HANDLES_NOT_READY, nonReadyCmHandleIds);
113 if (!cmHandleIdsPerResponseCodesPerOperation.isEmpty()) {
114 publishErrorMessageToClientTopic(topicParamInQuery, requestId, cmHandleIdsPerResponseCodesPerOperation);
116 return dmiDataOperationsOutPerDmiServiceName;
120 * Creates data operation cloud event and publish it to client topic.
122 * @param clientTopic client given topic
123 * @param requestId unique identifier per request
124 * @param cmHandleIdsPerResponseCodesPerOperation list of cm handle ids per operation with response code
127 public static void publishErrorMessageToClientTopic(final String clientTopic,
128 final String requestId,
129 final MultiValueMap<DmiDataOperation,
130 Map<NcmpResponseStatus, List<String>>>
131 cmHandleIdsPerResponseCodesPerOperation) {
132 final CloudEvent dataOperationCloudEvent = DataOperationEventCreator.createDataOperationEvent(clientTopic,
133 requestId, cmHandleIdsPerResponseCodesPerOperation);
134 final EventsPublisher<CloudEvent> eventsPublisher = CpsApplicationContext.getCpsBean(EventsPublisher.class);
135 eventsPublisher.publishCloudEvent(clientTopic, requestId, dataOperationCloudEvent);
138 private static Map<String, String> getDmiServiceNamesPerCmHandleId(
139 final Map<String, Map<String, Map<String, String>>> dmiDmiPropertiesPerCmHandleIdPerServiceName) {
140 final Map<String, String> dmiServiceNamesPerCmHandleId = new HashMap<>();
141 for (final Map.Entry<String, Map<String, Map<String, String>>> dmiDmiPropertiesEntry
142 : dmiDmiPropertiesPerCmHandleIdPerServiceName.entrySet()) {
143 final String dmiServiceName = dmiDmiPropertiesEntry.getKey();
144 final Set<String> cmHandleIds = dmiDmiPropertiesPerCmHandleIdPerServiceName.get(dmiServiceName).keySet();
145 for (final String cmHandleId : cmHandleIds) {
146 dmiServiceNamesPerCmHandleId.put(cmHandleId, dmiServiceName);
149 dmiDmiPropertiesPerCmHandleIdPerServiceName.put(UNKNOWN_SERVICE_NAME, Collections.emptyMap());
150 return dmiServiceNamesPerCmHandleId;
153 private static DmiDataOperation getOrAddDmiBatchOperation(final String dmiServiceName,
154 final DataOperationDefinition
155 dataOperationDefinitionIn,
156 final Map<String, List<DmiDataOperation>>
157 dmiBatchOperationsOutPerDmiServiceName) {
158 dmiBatchOperationsOutPerDmiServiceName
159 .computeIfAbsent(dmiServiceName, dmiServiceNameAsKey -> new ArrayList<>());
160 final List<DmiDataOperation> dmiBatchOperationsOut
161 = dmiBatchOperationsOutPerDmiServiceName.get(dmiServiceName);
162 final boolean isNewOperation = dmiBatchOperationsOut.isEmpty()
163 || !dmiBatchOperationsOut.get(dmiBatchOperationsOut.size() - 1).getOperationId()
164 .equals(dataOperationDefinitionIn.getOperationId());
165 if (isNewOperation) {
166 final DmiDataOperation newDmiBatchOperationOut =
167 DmiDataOperation.buildDmiDataOperationRequestBodyWithoutCmHandles(dataOperationDefinitionIn);
168 dmiBatchOperationsOut.add(newDmiBatchOperationOut);
169 return newDmiBatchOperationOut;
171 return dmiBatchOperationsOut.get(dmiBatchOperationsOut.size() - 1);
174 private static Set<String> filterAndGetNonReadyCmHandleIds(final Collection<YangModelCmHandle> yangModelCmHandles) {
175 return yangModelCmHandles.stream()
176 .filter(yangModelCmHandle -> yangModelCmHandle.getCompositeState().getCmHandleState()
177 != CmHandleState.READY).map(YangModelCmHandle::getId).collect(Collectors.toSet());
180 private static void populateCmHandleIdsPerOperationIdPerResponseCode(final MultiValueMap<DmiDataOperation,
181 Map<NcmpResponseStatus, List<String>>> cmHandleIdsPerResponseCodesPerOperation,
182 final DmiDataOperation dmiDataOperation,
183 final NcmpResponseStatus
185 final List<String> cmHandleIds) {
186 if (!cmHandleIds.isEmpty()) {
187 cmHandleIdsPerResponseCodesPerOperation.add(dmiDataOperation, Map.of(ncmpResponseStatus, cmHandleIds));