cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/events/cmsubscription/CmSubscriptionDmiOutEventConsumer.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.cmsubscription;
  22
  23 import static org.onap.cps.ncmp.api.impl.events.mapper.CloudEventMapper.toTargetEvent;
  24
  25 import com.hazelcast.map.IMap;
  26 import io.cloudevents.CloudEvent;
  27 import java.util.Collection;
  28 import java.util.Map;
  29 import java.util.Set;
  30 import java.util.concurrent.TimeUnit;
  31 import lombok.RequiredArgsConstructor;
  32 import lombok.extern.slf4j.Slf4j;
  33 import org.apache.kafka.clients.consumer.ConsumerRecord;
  34 import org.onap.cps.ncmp.api.impl.config.embeddedcache.ForwardedSubscriptionEventCacheConfig;
  35 import org.onap.cps.ncmp.api.impl.subscriptions.SubscriptionPersistence;
  36 import org.onap.cps.ncmp.api.impl.subscriptions.SubscriptionStatus;
  37 import org.onap.cps.ncmp.api.impl.utils.DataNodeHelper;
  38 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelSubscriptionEvent;
  39 import org.onap.cps.ncmp.api.models.CmSubscriptionEvent;
  40 import org.onap.cps.ncmp.events.cmsubscription1_0_0.dmi_to_ncmp.CmSubscriptionDmiOutEvent;
  41 import org.onap.cps.spi.model.DataNode;
  42 import org.springframework.beans.factory.annotation.Value;
  43 import org.springframework.kafka.annotation.KafkaListener;
  44 import org.springframework.stereotype.Component;
  45
  46 @Component
  47 @Slf4j
  48 @RequiredArgsConstructor
  49 public class CmSubscriptionDmiOutEventConsumer {
  50
  51     private final IMap<String, Set<String>> forwardedSubscriptionEventCache;
  52     private final SubscriptionPersistence subscriptionPersistence;
  53     private final CmSubscriptionDmiOutEventToYangModelSubscriptionEventMapper
  54             cmSubscriptionDmiOutEventToYangModelSubscriptionEventMapper;
  55     private final CmSubscriptionNcmpOutEventPublisher cmSubscriptionNcmpOutEventPublisher;
  56
  57     @Value("${notification.enabled:true}")
  58     private boolean notificationFeatureEnabled;
  59
  60     @Value("${ncmp.model-loader.subscription:false}")
  61     private boolean subscriptionModelLoaderEnabled;
  62
  63     /**
  64      * Consume subscription response event.
  65      *
  66      * @param cmSubscriptionDmiOutConsumerRecord the event to be consumed
  67      */
  68     @KafkaListener(topics = "${app.ncmp.avc.subscription-response-topic}",
  69             containerFactory = "cloudEventConcurrentKafkaListenerContainerFactory")
  70     public void consumeDmiOutEvent(
  71             final ConsumerRecord<String, CloudEvent> cmSubscriptionDmiOutConsumerRecord) {
  72         final CloudEvent cloudEvent = cmSubscriptionDmiOutConsumerRecord.value();
  73         final String eventType = cmSubscriptionDmiOutConsumerRecord.value().getType();
  74         final CmSubscriptionDmiOutEvent cmSubscriptionDmiOutEvent =
  75                 toTargetEvent(cloudEvent, CmSubscriptionDmiOutEvent.class);
  76         final String clientId = cmSubscriptionDmiOutEvent.getData().getClientId();
  77         log.info("subscription event response of clientId: {} is received.", clientId);
  78         final String subscriptionName = cmSubscriptionDmiOutEvent.getData().getSubscriptionName();
  79         final String subscriptionEventId = clientId + subscriptionName;
  80         boolean createOutcomeResponse = false;
  81         if (forwardedSubscriptionEventCache.containsKey(subscriptionEventId)) {
  82             final Set<String> dmiNames = forwardedSubscriptionEventCache.get(subscriptionEventId);
  83             dmiNames.remove(cmSubscriptionDmiOutEvent.getData().getDmiName());
  84             forwardedSubscriptionEventCache.put(subscriptionEventId, dmiNames,
  85                     ForwardedSubscriptionEventCacheConfig.SUBSCRIPTION_FORWARD_STARTED_TTL_SECS, TimeUnit.SECONDS);
  86             createOutcomeResponse = forwardedSubscriptionEventCache.get(subscriptionEventId).isEmpty();
  87         }
  88         if (subscriptionModelLoaderEnabled) {
  89             updateSubscriptionEvent(cmSubscriptionDmiOutEvent);
  90         }
  91         if (createOutcomeResponse
  92                 && notificationFeatureEnabled
  93                 && hasNoPendingCmHandles(clientId, subscriptionName)) {
  94
  95             final CmSubscriptionEvent cmSubscriptionEvent = new CmSubscriptionEvent();
  96             cmSubscriptionEvent.setClientId(cmSubscriptionDmiOutEvent.getData().getClientId());
  97             cmSubscriptionEvent.setSubscriptionName(cmSubscriptionDmiOutEvent.getData().getSubscriptionName());
  98
  99             cmSubscriptionNcmpOutEventPublisher.sendResponse(cmSubscriptionEvent, eventType);
 100             forwardedSubscriptionEventCache.remove(subscriptionEventId);
 101         }
 102     }
 103
 104     private boolean hasNoPendingCmHandles(final String clientId, final String subscriptionName) {
 105         final Collection<DataNode> dataNodeSubscription = subscriptionPersistence.getCmHandlesForSubscriptionEvent(
 106                 clientId, subscriptionName);
 107         final Map<String, Map<String, String>> cmHandleIdToStatusAndDetailsAsMapOriginal =
 108                 DataNodeHelper.cmHandleIdToStatusAndDetailsAsMapFromDataNode(dataNodeSubscription);
 109         for (final Map<String, String> statusAndDetailsMap : cmHandleIdToStatusAndDetailsAsMapOriginal.values()) {
 110             final String status = statusAndDetailsMap.get("status");
 111             if (SubscriptionStatus.PENDING.toString().equals(status)) {
 112                 return false;
 113             }
 114         }
 115         return true;
 116     }
 117
 118     private void updateSubscriptionEvent(final CmSubscriptionDmiOutEvent cmSubscriptionDmiOutEvent) {
 119         final YangModelSubscriptionEvent yangModelSubscriptionEvent =
 120                 cmSubscriptionDmiOutEventToYangModelSubscriptionEventMapper
 121                         .toYangModelSubscriptionEvent(cmSubscriptionDmiOutEvent);
 122         subscriptionPersistence.saveSubscriptionEvent(yangModelSubscriptionEvent);
 123     }
 124 }