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