cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/events/EventsPublisher.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2022-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;
  22
  23 import io.cloudevents.CloudEvent;
  24 import java.util.Map;
  25 import java.util.concurrent.CompletableFuture;
  26 import lombok.RequiredArgsConstructor;
  27 import lombok.extern.slf4j.Slf4j;
  28 import org.apache.kafka.clients.producer.ProducerRecord;
  29 import org.apache.kafka.common.header.Headers;
  30 import org.apache.kafka.common.header.internals.RecordHeaders;
  31 import org.springframework.kafka.core.KafkaTemplate;
  32 import org.springframework.kafka.support.SendResult;
  33 import org.springframework.stereotype.Service;
  34 import org.springframework.util.SerializationUtils;
  35
  36 /**
  37  * EventsPublisher to publish events.
  38  */
  39
  40 @Slf4j
  41 @Service
  42 @RequiredArgsConstructor
  43 public class EventsPublisher<T> {
  44
  45     /**
  46      * KafaTemplate for legacy (non-cloud) events.
  47      *
  48      * @deprecated Cloud events should be used. Will address soon as part of  https://jira.onap.org/browse/CPS-1717
  49      */
  50     @Deprecated(forRemoval = true)
  51     private final KafkaTemplate<String, T> legacyKafkaEventTemplate;
  52
  53     private final KafkaTemplate<String, CloudEvent> cloudEventKafkaTemplate;
  54
  55     /**
  56      * Generic CloudEvent publisher.
  57      *
  58      * @param topicName valid topic name
  59      * @param eventKey  message key
  60      * @param event     message payload
  61      */
  62     public void publishCloudEvent(final String topicName, final String eventKey, final CloudEvent event) {
  63         final CompletableFuture<SendResult<String, CloudEvent>> eventFuture =
  64                 cloudEventKafkaTemplate.send(topicName, eventKey, event);
  65         eventFuture.whenComplete((result, e) -> {
  66             if (e == null) {
  67                 log.debug("Successfully published event to topic : {} , Event : {}", result.getRecordMetadata().topic(),
  68                         result.getProducerRecord().value());
  69
  70             } else {
  71                 log.error("Unable to publish event to topic : {} due to {}", topicName, e.getMessage());
  72             }
  73         });
  74     }
  75
  76     /**
  77      * Generic Event publisher.
  78      *
  79      * @param topicName valid topic name
  80      * @param eventKey  message key
  81      * @param event     message payload
  82      * @deprecated Cloud events should be used. Will address soon as part of  https://jira.onap.org/browse/CPS-1717
  83      */
  84     @Deprecated(forRemoval = true)
  85     public void publishEvent(final String topicName, final String eventKey, final T event) {
  86         final CompletableFuture<SendResult<String, T>> eventFuture =
  87                 legacyKafkaEventTemplate.send(topicName, eventKey, event);
  88         handleLegacyEventCallback(topicName, eventFuture);
  89     }
  90
  91     /**
  92      * Generic Event Publisher with headers.
  93      *
  94      * @param topicName    valid topic name
  95      * @param eventKey     message key
  96      * @param eventHeaders event headers
  97      * @param event        message payload
  98      */
  99     public void publishEvent(final String topicName, final String eventKey, final Headers eventHeaders, final T event) {
 100
 101         final ProducerRecord<String, T> producerRecord =
 102                 new ProducerRecord<>(topicName, null, eventKey, event, eventHeaders);
 103         final CompletableFuture<SendResult<String, T>> eventFuture = legacyKafkaEventTemplate.send(producerRecord);
 104         handleLegacyEventCallback(topicName, eventFuture);
 105     }
 106
 107     /**
 108      * Generic Event Publisher with headers.
 109      *
 110      * @param topicName    valid topic name
 111      * @param eventKey     message key
 112      * @param eventHeaders map of event headers
 113      * @param event        message payload
 114      */
 115     public void publishEvent(final String topicName, final String eventKey, final Map<String, Object> eventHeaders,
 116             final T event) {
 117
 118         publishEvent(topicName, eventKey, convertToKafkaHeaders(eventHeaders), event);
 119     }
 120
 121     private void handleLegacyEventCallback(final String topicName,
 122             final CompletableFuture<SendResult<String, T>> eventFuture) {
 123         eventFuture.whenComplete((result, e) -> {
 124             if (e != null) {
 125                 log.error("Unable to publish event to topic : {} due to {}", topicName, e.getMessage());
 126             } else {
 127                 log.debug("Successfully published event to topic : {} , Event : {}", result.getRecordMetadata().topic(),
 128                         result.getProducerRecord().value());
 129             }
 130         });
 131     }
 132
 133     private Headers convertToKafkaHeaders(final Map<String, Object> eventMessageHeaders) {
 134         final Headers eventHeaders = new RecordHeaders();
 135         eventMessageHeaders.forEach((key, value) -> eventHeaders.add(key, SerializationUtils.serialize(value)));
 136         return eventHeaders;
 137     }
 138
 139 }