gerrit.onap Code Review - cps.git/blob

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2024 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.impl.cmnotificationsubscription.ncmp;
  22
  23 import io.cloudevents.CloudEvent;
  24 import io.cloudevents.core.builder.CloudEventBuilder;
  25 import java.net.URI;
  26 import java.util.Map;
  27 import java.util.UUID;
  28 import java.util.concurrent.ConcurrentHashMap;
  29 import java.util.concurrent.Executors;
  30 import java.util.concurrent.ScheduledExecutorService;
  31 import java.util.concurrent.ScheduledFuture;
  32 import java.util.concurrent.TimeUnit;
  33 import lombok.RequiredArgsConstructor;
  34 import lombok.extern.slf4j.Slf4j;
  35 import org.onap.cps.events.EventsPublisher;
  36 import org.onap.cps.ncmp.impl.cmnotificationsubscription.MappersFacade;
  37 import org.onap.cps.ncmp.impl.cmnotificationsubscription.cache.DmiCacheHandler;
  38 import org.onap.cps.ncmp.impl.cmnotificationsubscription_1_0_0.ncmp_to_client.NcmpOutEvent;
  39 import org.onap.cps.utils.JsonObjectMapper;
  40 import org.springframework.beans.factory.annotation.Value;
  41 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
  42 import org.springframework.stereotype.Component;
  43
  44 @Component
  45 @Slf4j
  46 @RequiredArgsConstructor
  47 @ConditionalOnProperty(name = "notification.enabled", havingValue = "true", matchIfMissing = true)
  48 public class NcmpOutEventProducer {
  49
  50     @Value("${app.ncmp.avc.cm-subscription-ncmp-out}")
  51     private String ncmpOutEventTopic;
  52
  53     @Value("${ncmp.timers.subscription-forwarding.dmi-response-timeout-ms}")
  54     private Integer dmiOutEventTimeoutInMs;
  55
  56     private final EventsPublisher<CloudEvent> eventsPublisher;
  57     private final JsonObjectMapper jsonObjectMapper;
  58     private final MappersFacade mappersFacade;
  59     private final DmiCacheHandler dmiCacheHandler;
  60     private final ScheduledExecutorService scheduledExecutorService = Executors.newSingleThreadScheduledExecutor();
  61     private static final Map<String, ScheduledFuture<?>> scheduledTasksPerSubscriptionId = new ConcurrentHashMap<>();
  62
  63     /**
  64      * Publish the event to the client who requested the subscription with key as subscription id and event is Cloud
  65      * Event compliant.
  66      *
  67      * @param subscriptionId   Cm Subscription Id
  68      * @param eventType        Type of event
  69      * @param ncmpOutEvent     Cm Notification Subscription Event for the
  70      *                         client
  71      * @param isScheduledEvent Determines if the event is to be scheduled
  72      *                         or published now
  73      */
  74     public void publishNcmpOutEvent(final String subscriptionId, final String eventType,
  75             final NcmpOutEvent ncmpOutEvent, final boolean isScheduledEvent) {
  76
  77         if (isScheduledEvent && !scheduledTasksPerSubscriptionId.containsKey(subscriptionId)) {
  78             final ScheduledFuture<?> scheduledFuture = scheduleAndPublishNcmpOutEvent(subscriptionId, eventType);
  79             scheduledTasksPerSubscriptionId.putIfAbsent(subscriptionId, scheduledFuture);
  80             log.debug("Scheduled the CmNotificationSubscriptionEvent for subscriptionId : {}", subscriptionId);
  81         } else {
  82             cancelScheduledTaskForSubscriptionId(subscriptionId);
  83             publishNcmpOutEventNow(subscriptionId, eventType, ncmpOutEvent);
  84             log.info("Published CmNotificationSubscriptionEvent on demand for subscriptionId : {}", subscriptionId);
  85         }
  86     }
  87
  88     private ScheduledFuture<?> scheduleAndPublishNcmpOutEvent(final String subscriptionId, final String eventType) {
  89         final NcmpOutEventPublishingTask ncmpOutEventPublishingTask =
  90                 new NcmpOutEventPublishingTask(ncmpOutEventTopic, subscriptionId, eventType, eventsPublisher,
  91                         jsonObjectMapper, mappersFacade, dmiCacheHandler);
  92         return scheduledExecutorService.schedule(ncmpOutEventPublishingTask, dmiOutEventTimeoutInMs,
  93                 TimeUnit.MILLISECONDS);
  94     }
  95
  96     private void cancelScheduledTaskForSubscriptionId(final String subscriptionId) {
  97
  98         final ScheduledFuture<?> scheduledFuture = scheduledTasksPerSubscriptionId.get(subscriptionId);
  99         if (scheduledFuture != null) {
 100             scheduledFuture.cancel(true);
 101             scheduledTasksPerSubscriptionId.remove(subscriptionId);
 102         }
 103
 104     }
 105
 106
 107     private void publishNcmpOutEventNow(final String subscriptionId, final String eventType,
 108             final NcmpOutEvent ncmpOutEvent) {
 109         final CloudEvent ncmpOutEventAsCloudEvent =
 110                 buildAndGetNcmpOutEventAsCloudEvent(jsonObjectMapper, subscriptionId, eventType,
 111                         ncmpOutEvent);
 112         eventsPublisher.publishCloudEvent(ncmpOutEventTopic, subscriptionId,
 113                 ncmpOutEventAsCloudEvent);
 114         dmiCacheHandler.removeAcceptedAndRejectedDmiSubscriptionEntries(subscriptionId);
 115     }
 116
 117     /**
 118      * Get an NCMP out event as cloud event.
 119      *
 120      * @param jsonObjectMapper JSON object mapper
 121      * @param subscriptionId   subscription id
 122      * @param eventType        event type
 123      * @param ncmpOutEvent     cm notification subscription NCMP out event
 124      * @return cm notification subscription NCMP out event as cloud event
 125      */
 126     public static CloudEvent buildAndGetNcmpOutEventAsCloudEvent(final JsonObjectMapper jsonObjectMapper,
 127             final String subscriptionId, final String eventType, final NcmpOutEvent ncmpOutEvent) {
 128
 129         return CloudEventBuilder.v1().withId(UUID.randomUUID().toString()).withType(eventType)
 130                        .withSource(URI.create("NCMP")).withDataSchema(URI.create("org.onap.ncmp.cm.subscription:1.0.0"))
 131                        .withExtension("correlationid", subscriptionId)
 132                        .withData(jsonObjectMapper.asJsonBytes(ncmpOutEvent)).build();
 133     }
 134
 135 }