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.Collection;
  25 import java.util.Collections;
  26 import java.util.HashSet;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.Objects;
  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.apache.kafka.common.header.Headers;
  38 import org.onap.cps.ncmp.api.impl.config.embeddedcache.ForwardedSubscriptionEventCacheConfig;
  39 import org.onap.cps.ncmp.api.impl.events.EventsPublisher;
  40 import org.onap.cps.ncmp.api.impl.utils.DmiServiceNameOrganizer;
  41 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  42 import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
  43 import org.onap.cps.ncmp.event.model.SubscriptionEvent;
  44 import org.onap.cps.spi.exceptions.OperationNotYetSupportedException;
  45 import org.springframework.beans.factory.annotation.Value;
  46 import org.springframework.stereotype.Component;
  47
  48
  49 @Component
  50 @Slf4j
  51 @RequiredArgsConstructor
  52 public class SubscriptionEventForwarder {
  53
  54     private final InventoryPersistence inventoryPersistence;
  55     private final EventsPublisher<SubscriptionEvent> eventsPublisher;
  56     private final IMap<String, Set<String>> forwardedSubscriptionEventCache;
  57     private final SubscriptionEventResponseOutcome subscriptionEventResponseOutcome;
  58     private final ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor();
  59     @Value("${app.ncmp.avc.subscription-forward-topic-prefix}")
  60     private String dmiAvcSubscriptionTopicPrefix;
  61
  62     @Value("${ncmp.timers.subscription-forwarding.dmi-response-timeout-ms:30000}")
  63     private int dmiResponseTimeoutInMs;
  64
  65     /**
  66      * Forward subscription event.
  67      *
  68      * @param subscriptionEvent the event to be forwarded
  69      */
  70     public void forwardCreateSubscriptionEvent(final SubscriptionEvent subscriptionEvent,
  71                                                final Headers eventHeaders) {
  72         final List<Object> cmHandleTargets = subscriptionEvent.getEvent().getPredicates().getTargets();
  73         if (cmHandleTargets == null || cmHandleTargets.isEmpty()
  74                 || cmHandleTargets.stream().anyMatch(id -> ((String) id).contains("*"))) {
  75             throw new OperationNotYetSupportedException(
  76                     "CMHandle targets are required. \"Wildcard\" operations are not yet supported");
  77         }
  78         final List<String> cmHandleTargetsAsStrings = cmHandleTargets.stream().map(
  79                 Objects::toString).collect(Collectors.toList());
  80         final Collection<YangModelCmHandle> yangModelCmHandles =
  81                 inventoryPersistence.getYangModelCmHandles(cmHandleTargetsAsStrings);
  82
  83         final Map<String, Map<String, Map<String, String>>> dmiPropertiesPerCmHandleIdPerServiceName
  84                 = DmiServiceNameOrganizer.getDmiPropertiesPerCmHandleIdPerServiceName(yangModelCmHandles);
  85
  86         final Set<String> dmisToRespond = new HashSet<>(dmiPropertiesPerCmHandleIdPerServiceName.keySet());
  87         if (dmisToRespond.isEmpty()) {
  88             final String clientID = subscriptionEvent.getEvent().getSubscription().getClientID();
  89             final String subscriptionName = subscriptionEvent.getEvent().getSubscription().getName();
  90             subscriptionEventResponseOutcome.sendResponse(clientID, subscriptionName, true);
  91         } else {
  92             startResponseTimeout(subscriptionEvent, dmisToRespond);
  93             forwardEventToDmis(dmiPropertiesPerCmHandleIdPerServiceName, subscriptionEvent, eventHeaders);
  94         }
  95     }
  96
  97     private void startResponseTimeout(final SubscriptionEvent subscriptionEvent, final Set<String> dmisToRespond) {
  98         final String subscriptionClientId = subscriptionEvent.getEvent().getSubscription().getClientID();
  99         final String subscriptionName = subscriptionEvent.getEvent().getSubscription().getName();
 100         final String subscriptionEventId = subscriptionClientId + subscriptionName;
 101
 102         forwardedSubscriptionEventCache.put(subscriptionEventId, dmisToRespond,
 103                 ForwardedSubscriptionEventCacheConfig.SUBSCRIPTION_FORWARD_STARTED_TTL_SECS, TimeUnit.SECONDS);
 104         final ResponseTimeoutTask responseTimeoutTask =
 105             new ResponseTimeoutTask(forwardedSubscriptionEventCache, subscriptionEventResponseOutcome,
 106                     subscriptionClientId, subscriptionName);
 107         try {
 108             executorService.schedule(responseTimeoutTask, dmiResponseTimeoutInMs, TimeUnit.MILLISECONDS);
 109         } catch (final RuntimeException ex) {
 110             log.info("Caught exception in ScheduledExecutorService for ResponseTimeoutTask. StackTrace: {}",
 111                     ex.toString());
 112         }
 113     }
 114
 115     private void forwardEventToDmis(final Map<String, Map<String, Map<String, String>>> dmiNameCmHandleMap,
 116                                     final SubscriptionEvent subscriptionEvent,
 117                                     final Headers eventHeaders) {
 118         dmiNameCmHandleMap.forEach((dmiName, cmHandlePropertiesMap) -> {
 119             subscriptionEvent.getEvent().getPredicates().setTargets(Collections.singletonList(cmHandlePropertiesMap));
 120             final String eventKey = createEventKey(subscriptionEvent, dmiName);
 121             final String dmiAvcSubscriptionTopic = dmiAvcSubscriptionTopicPrefix + dmiName;
 122             eventsPublisher.publishEvent(dmiAvcSubscriptionTopic, eventKey, eventHeaders, subscriptionEvent);
 123         });
 124     }
 125
 126     private String createEventKey(final SubscriptionEvent subscriptionEvent, final String dmiName) {
 127         return subscriptionEvent.getEvent().getSubscription().getClientID()
 128             + "-"
 129             + subscriptionEvent.getEvent().getSubscription().getName()
 130             + "-"
 131             + dmiName;
 132     }
 133 }