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 java.util.ArrayList;
  25 import java.util.Collection;
  26 import java.util.Collections;
  27 import java.util.HashSet;
  28 import java.util.List;
  29 import java.util.Map;
  30 import java.util.Objects;
  31 import java.util.Set;
  32 import java.util.concurrent.Executors;
  33 import java.util.concurrent.ScheduledExecutorService;
  34 import java.util.concurrent.TimeUnit;
  35 import java.util.stream.Collectors;
  36 import lombok.RequiredArgsConstructor;
  37 import lombok.extern.slf4j.Slf4j;
  38 import org.apache.kafka.common.header.Headers;
  39 import org.onap.cps.ncmp.api.impl.config.embeddedcache.ForwardedSubscriptionEventCacheConfig;
  40 import org.onap.cps.ncmp.api.impl.events.EventsPublisher;
  41 import org.onap.cps.ncmp.api.impl.subscriptions.SubscriptionPersistence;
  42 import org.onap.cps.ncmp.api.impl.subscriptions.SubscriptionStatus;
  43 import org.onap.cps.ncmp.api.impl.utils.DmiServiceNameOrganizer;
  44 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  45 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelSubscriptionEvent;
  46 import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
  47 import org.onap.cps.ncmp.event.model.SubscriptionEvent;
  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<SubscriptionEvent> eventsPublisher;
  60     private final IMap<String, Set<String>> forwardedSubscriptionEventCache;
  61     private final SubscriptionEventResponseOutcome subscriptionEventResponseOutcome;
  62     private final SubscriptionEventMapper subscriptionEventMapper;
  63     private final SubscriptionPersistence subscriptionPersistence;
  64     private final ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor();
  65     @Value("${app.ncmp.avc.subscription-forward-topic-prefix}")
  66     private String dmiAvcSubscriptionTopicPrefix;
  67
  68     @Value("${ncmp.timers.subscription-forwarding.dmi-response-timeout-ms:30000}")
  69     private int dmiResponseTimeoutInMs;
  70
  71     /**
  72      * Forward subscription event.
  73      *
  74      * @param subscriptionEvent the event to be forwarded
  75      */
  76     public void forwardCreateSubscriptionEvent(final SubscriptionEvent subscriptionEvent,
  77                                                final Headers eventHeaders) {
  78         final List<Object> cmHandleTargets = subscriptionEvent.getEvent().getPredicates().getTargets();
  79         if (cmHandleTargets == null || cmHandleTargets.isEmpty()
  80                 || cmHandleTargets.stream().anyMatch(id -> ((String) id).contains("*"))) {
  81             throw new OperationNotYetSupportedException(
  82                     "CMHandle targets are required. \"Wildcard\" operations are not yet supported");
  83         }
  84         final List<String> cmHandleTargetsAsStrings = cmHandleTargets.stream().map(
  85                 Objects::toString).collect(Collectors.toList());
  86         final Collection<YangModelCmHandle> yangModelCmHandles =
  87                 inventoryPersistence.getYangModelCmHandles(cmHandleTargetsAsStrings);
  88
  89         final Map<String, Map<String, Map<String, String>>> dmiPropertiesPerCmHandleIdPerServiceName
  90                 = DmiServiceNameOrganizer.getDmiPropertiesPerCmHandleIdPerServiceName(yangModelCmHandles);
  91
  92         findDmisAndRespond(subscriptionEvent, eventHeaders, cmHandleTargetsAsStrings,
  93                 dmiPropertiesPerCmHandleIdPerServiceName);
  94     }
  95
  96     private void findDmisAndRespond(final SubscriptionEvent subscriptionEvent, final Headers eventHeaders,
  97                            final List<String> cmHandleTargetsAsStrings,
  98                            final Map<String, Map<String, Map<String, String>>>
  99                                             dmiPropertiesPerCmHandleIdPerServiceName) {
 100         final List<String> cmHandlesThatExistsInDb = dmiPropertiesPerCmHandleIdPerServiceName.entrySet().stream()
 101                 .map(Map.Entry::getValue).map(Map::keySet).flatMap(Set::stream).collect(Collectors.toList());
 102
 103         final List<String> targetCmHandlesDoesNotExistInDb = new ArrayList<>(cmHandleTargetsAsStrings);
 104         targetCmHandlesDoesNotExistInDb.removeAll(cmHandlesThatExistsInDb);
 105
 106         final Set<String> dmisToRespond = new HashSet<>(dmiPropertiesPerCmHandleIdPerServiceName.keySet());
 107
 108         if (dmisToRespond.isEmpty() || !targetCmHandlesDoesNotExistInDb.isEmpty()) {
 109             updatesCmHandlesToRejectedAndPersistSubscriptionEvent(subscriptionEvent, targetCmHandlesDoesNotExistInDb);
 110         }
 111         if (dmisToRespond.isEmpty()) {
 112             final String clientID = subscriptionEvent.getEvent().getSubscription().getClientID();
 113             final String subscriptionName = subscriptionEvent.getEvent().getSubscription().getName();
 114             subscriptionEventResponseOutcome.sendResponse(clientID, subscriptionName);
 115         } else {
 116             startResponseTimeout(subscriptionEvent, dmisToRespond);
 117             forwardEventToDmis(dmiPropertiesPerCmHandleIdPerServiceName, subscriptionEvent, eventHeaders);
 118         }
 119     }
 120
 121     private void startResponseTimeout(final SubscriptionEvent subscriptionEvent, final Set<String> dmisToRespond) {
 122         final String subscriptionClientId = subscriptionEvent.getEvent().getSubscription().getClientID();
 123         final String subscriptionName = subscriptionEvent.getEvent().getSubscription().getName();
 124         final String subscriptionEventId = subscriptionClientId + subscriptionName;
 125
 126         forwardedSubscriptionEventCache.put(subscriptionEventId, dmisToRespond,
 127                 ForwardedSubscriptionEventCacheConfig.SUBSCRIPTION_FORWARD_STARTED_TTL_SECS, TimeUnit.SECONDS);
 128         final ResponseTimeoutTask responseTimeoutTask =
 129             new ResponseTimeoutTask(forwardedSubscriptionEventCache, subscriptionEventResponseOutcome,
 130                     subscriptionClientId, subscriptionName);
 131         try {
 132             executorService.schedule(responseTimeoutTask, dmiResponseTimeoutInMs, TimeUnit.MILLISECONDS);
 133         } catch (final RuntimeException ex) {
 134             log.info("Caught exception in ScheduledExecutorService for ResponseTimeoutTask. StackTrace: {}",
 135                     ex.toString());
 136         }
 137     }
 138
 139     private void forwardEventToDmis(final Map<String, Map<String, Map<String, String>>> dmiNameCmHandleMap,
 140                                     final SubscriptionEvent subscriptionEvent,
 141                                     final Headers eventHeaders) {
 142         dmiNameCmHandleMap.forEach((dmiName, cmHandlePropertiesMap) -> {
 143             subscriptionEvent.getEvent().getPredicates().setTargets(Collections.singletonList(cmHandlePropertiesMap));
 144             final String eventKey = createEventKey(subscriptionEvent, dmiName);
 145             final String dmiAvcSubscriptionTopic = dmiAvcSubscriptionTopicPrefix + dmiName;
 146             eventsPublisher.publishEvent(dmiAvcSubscriptionTopic, eventKey, eventHeaders, subscriptionEvent);
 147         });
 148     }
 149
 150     private String createEventKey(final SubscriptionEvent subscriptionEvent, final String dmiName) {
 151         return subscriptionEvent.getEvent().getSubscription().getClientID()
 152             + "-"
 153             + subscriptionEvent.getEvent().getSubscription().getName()
 154             + "-"
 155             + dmiName;
 156     }
 157
 158     private void updatesCmHandlesToRejectedAndPersistSubscriptionEvent(
 159             final SubscriptionEvent subscriptionEvent,
 160             final List<String> targetCmHandlesDoesNotExistInDb) {
 161         final YangModelSubscriptionEvent yangModelSubscriptionEvent =
 162                 subscriptionEventMapper.toYangModelSubscriptionEvent(subscriptionEvent);
 163         yangModelSubscriptionEvent.getPredicates()
 164                 .setTargetCmHandles(findRejectedCmHandles(targetCmHandlesDoesNotExistInDb,
 165                         yangModelSubscriptionEvent));
 166         subscriptionPersistence.saveSubscriptionEvent(yangModelSubscriptionEvent);
 167     }
 168
 169     private static List<YangModelSubscriptionEvent.TargetCmHandle> findRejectedCmHandles(
 170             final List<String> targetCmHandlesDoesNotExistInDb,
 171             final YangModelSubscriptionEvent yangModelSubscriptionEvent) {
 172         return yangModelSubscriptionEvent.getPredicates().getTargetCmHandles().stream()
 173                     .filter(targetCmHandle -> targetCmHandlesDoesNotExistInDb.contains(targetCmHandle.getCmHandleId()))
 174                     .map(target -> new YangModelSubscriptionEvent.TargetCmHandle(target.getCmHandleId(),
 175                                     SubscriptionStatus.REJECTED)).collect(Collectors.toList());
 176     }
 177 }