cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/events/avcsubscription/SubscriptionEventForwarder.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.events.avcsubscription;
  22
  23 import com.hazelcast.map.IMap;
  24 import io.cloudevents.CloudEvent;
  25 import java.util.ArrayList;
  26 import java.util.Collection;
  27 import java.util.HashSet;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Set;
  31 import java.util.concurrent.Executors;
  32 import java.util.concurrent.ScheduledExecutorService;
  33 import java.util.concurrent.TimeUnit;
  34 import java.util.stream.Collectors;
  35 import lombok.RequiredArgsConstructor;
  36 import lombok.extern.slf4j.Slf4j;
  37 import org.onap.cps.ncmp.api.impl.config.embeddedcache.ForwardedSubscriptionEventCacheConfig;
  38 import org.onap.cps.ncmp.api.impl.events.EventsPublisher;
  39 import org.onap.cps.ncmp.api.impl.subscriptions.SubscriptionPersistence;
  40 import org.onap.cps.ncmp.api.impl.subscriptions.SubscriptionStatus;
  41 import org.onap.cps.ncmp.api.impl.utils.DmiServiceNameOrganizer;
  42 import org.onap.cps.ncmp.api.impl.utils.SubscriptionEventCloudMapper;
  43 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  44 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelSubscriptionEvent;
  45 import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
  46 import org.onap.cps.ncmp.events.avcsubscription1_0_0.client_to_ncmp.SubscriptionEvent;
  47 import org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.Data;
  48 import org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.SubscriptionEventResponse;
  49 import org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.CmHandle;
  50 import org.springframework.beans.factory.annotation.Value;
  51 import org.springframework.stereotype.Component;
  52
  53
  54 @Component
  55 @Slf4j
  56 @RequiredArgsConstructor
  57 public class SubscriptionEventForwarder {
  58
  59     private final InventoryPersistence inventoryPersistence;
  60     private final EventsPublisher<CloudEvent> eventsPublisher;
  61     private final IMap<String, Set<String>> forwardedSubscriptionEventCache;
  62     private final SubscriptionEventResponseOutcome subscriptionEventResponseOutcome;
  63     private final SubscriptionEventMapper subscriptionEventMapper;
  64     private final ClientSubscriptionEventMapper clientSubscriptionEventMapper;
  65     private final SubscriptionPersistence subscriptionPersistence;
  66     private final ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor();
  67     @Value("${app.ncmp.avc.subscription-forward-topic-prefix}")
  68     private String dmiAvcSubscriptionTopicPrefix;
  69
  70     @Value("${ncmp.timers.subscription-forwarding.dmi-response-timeout-ms:30000}")
  71     private int dmiResponseTimeoutInMs;
  72
  73     /**
  74      * Forward subscription event.
  75      *
  76      * @param subscriptionEvent the event to be forwarded
  77      */
  78     public void forwardCreateSubscriptionEvent(final SubscriptionEvent subscriptionEvent, final String eventType) {
  79         final List<String> cmHandleTargets = subscriptionEvent.getData().getPredicates().getTargets();
  80         if (cmHandleTargets == null || cmHandleTargets.isEmpty()
  81                 || cmHandleTargets.stream().anyMatch(id -> (id).contains("*"))) {
  82             throw new UnsupportedOperationException(
  83                     "CMHandle targets are required. \"Wildcard\" operations are not yet supported");
  84         }
  85         final Collection<YangModelCmHandle> yangModelCmHandles =
  86                 inventoryPersistence.getYangModelCmHandles(cmHandleTargets);
  87         final Map<String, Map<String, Map<String, String>>> dmiPropertiesPerCmHandleIdPerServiceName
  88                 = DmiServiceNameOrganizer.getDmiPropertiesPerCmHandleIdPerServiceName(yangModelCmHandles);
  89         findDmisAndRespond(subscriptionEvent, eventType, cmHandleTargets, dmiPropertiesPerCmHandleIdPerServiceName);
  90     }
  91
  92     private void findDmisAndRespond(final SubscriptionEvent subscriptionEvent, final String eventType,
  93                                     final List<String> cmHandleTargetsAsStrings,
  94                            final Map<String, Map<String, Map<String, String>>>
  95                                             dmiPropertiesPerCmHandleIdPerServiceName) {
  96         final SubscriptionEventResponse emptySubscriptionEventResponse =
  97                 new SubscriptionEventResponse().withData(new Data());
  98         emptySubscriptionEventResponse.getData().setSubscriptionName(
  99                 subscriptionEvent.getData().getSubscription().getName());
 100         emptySubscriptionEventResponse.getData().setClientId(
 101                 subscriptionEvent.getData().getSubscription().getClientID());
 102         final List<String> cmHandlesThatExistsInDb = dmiPropertiesPerCmHandleIdPerServiceName.entrySet().stream()
 103                 .map(Map.Entry::getValue).map(Map::keySet).flatMap(Set::stream).collect(Collectors.toList());
 104
 105         final List<String> targetCmHandlesDoesNotExistInDb = new ArrayList<>(cmHandleTargetsAsStrings);
 106         targetCmHandlesDoesNotExistInDb.removeAll(cmHandlesThatExistsInDb);
 107
 108         final Set<String> dmisToRespond = new HashSet<>(dmiPropertiesPerCmHandleIdPerServiceName.keySet());
 109
 110         if (dmisToRespond.isEmpty() || !targetCmHandlesDoesNotExistInDb.isEmpty()) {
 111             updatesCmHandlesToRejectedAndPersistSubscriptionEvent(subscriptionEvent, targetCmHandlesDoesNotExistInDb);
 112         }
 113         if (dmisToRespond.isEmpty()) {
 114             subscriptionEventResponseOutcome.sendResponse(emptySubscriptionEventResponse,
 115                     "subscriptionCreatedStatus");
 116         } else {
 117             startResponseTimeout(emptySubscriptionEventResponse, dmisToRespond);
 118             final org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.SubscriptionEvent ncmpSubscriptionEvent =
 119                     clientSubscriptionEventMapper.toNcmpSubscriptionEvent(subscriptionEvent);
 120             forwardEventToDmis(dmiPropertiesPerCmHandleIdPerServiceName, ncmpSubscriptionEvent, eventType);
 121         }
 122     }
 123
 124     private void startResponseTimeout(final SubscriptionEventResponse emptySubscriptionEventResponse,
 125                                       final Set<String> dmisToRespond) {
 126         final String subscriptionClientId = emptySubscriptionEventResponse.getData().getClientId();
 127         final String subscriptionName = emptySubscriptionEventResponse.getData().getSubscriptionName();
 128         final String subscriptionEventId = subscriptionClientId + subscriptionName;
 129
 130         forwardedSubscriptionEventCache.put(subscriptionEventId, dmisToRespond,
 131                 ForwardedSubscriptionEventCacheConfig.SUBSCRIPTION_FORWARD_STARTED_TTL_SECS, TimeUnit.SECONDS);
 132         final ResponseTimeoutTask responseTimeoutTask =
 133             new ResponseTimeoutTask(forwardedSubscriptionEventCache, subscriptionEventResponseOutcome,
 134                     emptySubscriptionEventResponse);
 135         try {
 136             executorService.schedule(responseTimeoutTask, dmiResponseTimeoutInMs, TimeUnit.MILLISECONDS);
 137         } catch (final RuntimeException ex) {
 138             log.info("Caught exception in ScheduledExecutorService for ResponseTimeoutTask. StackTrace: {}",
 139                     ex.toString());
 140         }
 141     }
 142
 143     private void forwardEventToDmis(final Map<String, Map<String, Map<String, String>>> dmiNameCmHandleMap,
 144                                     final org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.SubscriptionEvent
 145                                             ncmpSubscriptionEvent, final String eventType) {
 146         dmiNameCmHandleMap.forEach((dmiName, cmHandlePropertiesMap) -> {
 147             final List<CmHandle> cmHandleTargets = cmHandlePropertiesMap.entrySet().stream().map(
 148                     cmHandleAndProperties -> {
 149                         final CmHandle cmHandle = new CmHandle();
 150                         cmHandle.setId(cmHandleAndProperties.getKey());
 151                         cmHandle.setAdditionalProperties(cmHandleAndProperties.getValue());
 152                         return cmHandle;
 153                     }).collect(Collectors.toList());
 154
 155             ncmpSubscriptionEvent.getData().getPredicates().setTargets(cmHandleTargets);
 156             final String eventKey = createEventKey(ncmpSubscriptionEvent, dmiName);
 157             final String dmiAvcSubscriptionTopic = dmiAvcSubscriptionTopicPrefix + dmiName;
 158
 159             final CloudEvent ncmpSubscriptionCloudEvent =
 160                     SubscriptionEventCloudMapper.toCloudEvent(ncmpSubscriptionEvent, eventKey, eventType);
 161             eventsPublisher.publishCloudEvent(dmiAvcSubscriptionTopic, eventKey, ncmpSubscriptionCloudEvent);
 162         });
 163     }
 164
 165     private String createEventKey(
 166             final org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.SubscriptionEvent subscriptionEvent,
 167             final String dmiName) {
 168         return subscriptionEvent.getData().getSubscription().getClientID()
 169             + "-"
 170             + subscriptionEvent.getData().getSubscription().getName()
 171             + "-"
 172             + dmiName;
 173     }
 174
 175     private void updatesCmHandlesToRejectedAndPersistSubscriptionEvent(
 176             final SubscriptionEvent subscriptionEvent,
 177             final List<String> targetCmHandlesDoesNotExistInDb) {
 178         final YangModelSubscriptionEvent yangModelSubscriptionEvent =
 179                 subscriptionEventMapper.toYangModelSubscriptionEvent(subscriptionEvent);
 180         yangModelSubscriptionEvent.getPredicates()
 181                 .setTargetCmHandles(findRejectedCmHandles(targetCmHandlesDoesNotExistInDb,
 182                         yangModelSubscriptionEvent));
 183         subscriptionPersistence.saveSubscriptionEvent(yangModelSubscriptionEvent);
 184     }
 185
 186     private static List<YangModelSubscriptionEvent.TargetCmHandle> findRejectedCmHandles(
 187             final List<String> targetCmHandlesDoesNotExistInDb,
 188             final YangModelSubscriptionEvent yangModelSubscriptionEvent) {
 189         return yangModelSubscriptionEvent.getPredicates().getTargetCmHandles().stream()
 190                     .filter(targetCmHandle -> targetCmHandlesDoesNotExistInDb.contains(targetCmHandle.getCmHandleId()))
 191                     .map(target -> new YangModelSubscriptionEvent.TargetCmHandle(target.getCmHandleId(),
 192                                     SubscriptionStatus.REJECTED, "Targets not found"))
 193                 .collect(Collectors.toList());
 194     }
 195 }