/* * ============LICENSE_START======================================================= * Copyright (C) 2023-2024 Nordix Foundation * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * * SPDX-License-Identifier: Apache-2.0 * ============LICENSE_END========================================================= */ package org.onap.cps.ncmp.api.impl.utils.data.operation; import static org.onap.cps.ncmp.api.NcmpResponseStatus.CM_HANDLES_NOT_FOUND; import static org.onap.cps.ncmp.api.NcmpResponseStatus.CM_HANDLES_NOT_READY; import io.cloudevents.CloudEvent; import java.util.ArrayList; import java.util.Collection; import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Set; import java.util.stream.Collectors; import lombok.AccessLevel; import lombok.NoArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.onap.cps.events.EventsPublisher; import org.onap.cps.ncmp.api.NcmpResponseStatus; import org.onap.cps.ncmp.api.impl.inventory.CmHandleState; import org.onap.cps.ncmp.api.impl.operations.CmHandle; import org.onap.cps.ncmp.api.impl.operations.DmiDataOperation; import org.onap.cps.ncmp.api.impl.utils.DmiServiceNameOrganizer; import org.onap.cps.ncmp.api.impl.utils.context.CpsApplicationContext; import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle; import org.onap.cps.ncmp.api.models.DataOperationDefinition; import org.onap.cps.ncmp.api.models.DataOperationRequest; import org.springframework.scheduling.annotation.Async; import org.springframework.util.LinkedMultiValueMap; import org.springframework.util.MultiValueMap; @Slf4j @NoArgsConstructor(access = AccessLevel.PRIVATE) public class ResourceDataOperationRequestUtils { private static final String UNKNOWN_SERVICE_NAME = null; /** * Create a list of DMI data operation per DMI service (name). * * @param topicParamInQuery client given topic * @param requestId unique identifier per request * @param dataOperationRequestIn incoming data operation request details * @param yangModelCmHandles involved cm handles represented as YangModelCmHandle (incl. metadata) * @return {@code Map>} Create a list of DMI batch operation per DMI service (name). */ public static Map> processPerDefinitionInDataOperationsRequest( final String topicParamInQuery, final String requestId, final DataOperationRequest dataOperationRequestIn, final Collection yangModelCmHandles) { final Map> dmiDataOperationsOutPerDmiServiceName = new HashMap<>(); final MultiValueMap>> cmHandleIdsPerResponseCodesPerOperation = new LinkedMultiValueMap<>(); final Set nonReadyCmHandleIdsLookup = filterAndGetNonReadyCmHandleIds(yangModelCmHandles); final Map>> dmiPropertiesPerCmHandleIdPerServiceName = DmiServiceNameOrganizer.getDmiPropertiesPerCmHandleIdPerServiceName(yangModelCmHandles); final Map dmiServiceNamesPerCmHandleId = getDmiServiceNamesPerCmHandleId(dmiPropertiesPerCmHandleIdPerServiceName); for (final DataOperationDefinition dataOperationDefinitionIn : dataOperationRequestIn.getDataOperationDefinitions()) { final List nonExistingCmHandleIds = new ArrayList<>(); final List nonReadyCmHandleIds = new ArrayList<>(); for (final String cmHandleId : dataOperationDefinitionIn.getCmHandleIds()) { if (nonReadyCmHandleIdsLookup.contains(cmHandleId)) { nonReadyCmHandleIds.add(cmHandleId); } else { final String dmiServiceName = dmiServiceNamesPerCmHandleId.get(cmHandleId); final Map cmHandleIdProperties = dmiPropertiesPerCmHandleIdPerServiceName.get(dmiServiceName).get(cmHandleId); if (cmHandleIdProperties == null) { nonExistingCmHandleIds.add(cmHandleId); } else { final DmiDataOperation dmiBatchOperationOut = getOrAddDmiBatchOperation(dmiServiceName, dataOperationDefinitionIn, dmiDataOperationsOutPerDmiServiceName); final CmHandle cmHandle = CmHandle.buildCmHandleWithProperties(cmHandleId, cmHandleIdProperties); dmiBatchOperationOut.getCmHandles().add(cmHandle); } } } populateCmHandleIdsPerOperationIdPerResponseCode(cmHandleIdsPerResponseCodesPerOperation, DmiDataOperation.buildDmiDataOperationRequestBodyWithoutCmHandles(dataOperationDefinitionIn), CM_HANDLES_NOT_FOUND, nonExistingCmHandleIds); populateCmHandleIdsPerOperationIdPerResponseCode(cmHandleIdsPerResponseCodesPerOperation, DmiDataOperation.buildDmiDataOperationRequestBodyWithoutCmHandles(dataOperationDefinitionIn), CM_HANDLES_NOT_READY, nonReadyCmHandleIds); } if (!cmHandleIdsPerResponseCodesPerOperation.isEmpty()) { publishErrorMessageToClientTopic(topicParamInQuery, requestId, cmHandleIdsPerResponseCodesPerOperation); } return dmiDataOperationsOutPerDmiServiceName; } /** * Creates data operation cloud event and publish it to client topic. * * @param clientTopic client given topic * @param requestId unique identifier per request * @param cmHandleIdsPerResponseCodesPerOperation list of cm handle ids per operation with response code */ @Async public static void publishErrorMessageToClientTopic(final String clientTopic, final String requestId, final MultiValueMap>> cmHandleIdsPerResponseCodesPerOperation) { final CloudEvent dataOperationCloudEvent = DataOperationEventCreator.createDataOperationEvent(clientTopic, requestId, cmHandleIdsPerResponseCodesPerOperation); final EventsPublisher eventsPublisher = CpsApplicationContext.getCpsBean(EventsPublisher.class); eventsPublisher.publishCloudEvent(clientTopic, requestId, dataOperationCloudEvent); } private static Map getDmiServiceNamesPerCmHandleId( final Map>> dmiDmiPropertiesPerCmHandleIdPerServiceName) { final Map dmiServiceNamesPerCmHandleId = new HashMap<>(); for (final Map.Entry>> dmiDmiPropertiesEntry : dmiDmiPropertiesPerCmHandleIdPerServiceName.entrySet()) { final String dmiServiceName = dmiDmiPropertiesEntry.getKey(); final Set cmHandleIds = dmiDmiPropertiesPerCmHandleIdPerServiceName.get(dmiServiceName).keySet(); for (final String cmHandleId : cmHandleIds) { dmiServiceNamesPerCmHandleId.put(cmHandleId, dmiServiceName); } } dmiDmiPropertiesPerCmHandleIdPerServiceName.put(UNKNOWN_SERVICE_NAME, Collections.emptyMap()); return dmiServiceNamesPerCmHandleId; } private static DmiDataOperation getOrAddDmiBatchOperation(final String dmiServiceName, final DataOperationDefinition dataOperationDefinitionIn, final Map> dmiBatchOperationsOutPerDmiServiceName) { dmiBatchOperationsOutPerDmiServiceName .computeIfAbsent(dmiServiceName, dmiServiceNameAsKey -> new ArrayList<>()); final List dmiBatchOperationsOut = dmiBatchOperationsOutPerDmiServiceName.get(dmiServiceName); final boolean isNewOperation = dmiBatchOperationsOut.isEmpty() || !dmiBatchOperationsOut.get(dmiBatchOperationsOut.size() - 1).getOperationId() .equals(dataOperationDefinitionIn.getOperationId()); if (isNewOperation) { final DmiDataOperation newDmiBatchOperationOut = DmiDataOperation.buildDmiDataOperationRequestBodyWithoutCmHandles(dataOperationDefinitionIn); dmiBatchOperationsOut.add(newDmiBatchOperationOut); return newDmiBatchOperationOut; } return dmiBatchOperationsOut.get(dmiBatchOperationsOut.size() - 1); } private static Set filterAndGetNonReadyCmHandleIds(final Collection yangModelCmHandles) { return yangModelCmHandles.stream() .filter(yangModelCmHandle -> yangModelCmHandle.getCompositeState().getCmHandleState() != CmHandleState.READY).map(YangModelCmHandle::getId).collect(Collectors.toSet()); } private static void populateCmHandleIdsPerOperationIdPerResponseCode(final MultiValueMap>> cmHandleIdsPerResponseCodesPerOperation, final DmiDataOperation dmiDataOperation, final NcmpResponseStatus ncmpResponseStatus, final List cmHandleIds) { if (!cmHandleIds.isEmpty()) { cmHandleIdsPerResponseCodesPerOperation.add(dmiDataOperation, Map.of(ncmpResponseStatus, cmHandleIds)); } } }