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

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * Copyright (C) 2022-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.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      * KafkaTemplate for legacy (non-cloud) events.
  47      * Note: Cloud events should be used. This will be addressed as part of  https://jira.onap.org/browse/CPS-1717.
  48      */
  49     private final KafkaTemplate<String, T> legacyKafkaEventTemplate;
  50
  51     private final KafkaTemplate<String, CloudEvent> cloudEventKafkaTemplate;
  52
  53     /**
  54      * Generic CloudEvent publisher.
  55      *
  56      * @param topicName valid topic name
  57      * @param eventKey  message key
  58      * @param event     message payload
  59      */
  60     public void publishCloudEvent(final String topicName, final String eventKey, final CloudEvent event) {
  61         final CompletableFuture<SendResult<String, CloudEvent>> eventFuture =
  62                 cloudEventKafkaTemplate.send(topicName, eventKey, event);
  63         eventFuture.whenComplete((result, e) -> {
  64             if (e == null) {
  65                 log.debug("Successfully published event to topic : {} , Event : {}", result.getRecordMetadata().topic(),
  66                         result.getProducerRecord().value());
  67
  68             } else {
  69                 log.error("Unable to publish event to topic : {} due to {}", topicName, e.getMessage());
  70             }
  71         });
  72     }
  73
  74     /**
  75      * Generic Event publisher.
  76      * Note: Cloud events should be used. This will be addressed as part of  https://jira.onap.org/browse/CPS-1717.
  77      *
  78      * @param topicName valid topic name
  79      * @param eventKey  message key
  80      * @param event     message payload
  81      */
  82     public void publishEvent(final String topicName, final String eventKey, final T event) {
  83         final CompletableFuture<SendResult<String, T>> eventFuture =
  84                 legacyKafkaEventTemplate.send(topicName, eventKey, event);
  85         handleLegacyEventCallback(topicName, eventFuture);
  86     }
  87
  88     /**
  89      * Generic Event Publisher with headers.
  90      *
  91      * @param topicName    valid topic name
  92      * @param eventKey     message key
  93      * @param eventHeaders event headers
  94      * @param event        message payload
  95      */
  96     public void publishEvent(final String topicName, final String eventKey, final Headers eventHeaders, final T event) {
  97
  98         final ProducerRecord<String, T> producerRecord =
  99                 new ProducerRecord<>(topicName, null, eventKey, event, eventHeaders);
 100         final CompletableFuture<SendResult<String, T>> eventFuture = legacyKafkaEventTemplate.send(producerRecord);
 101         handleLegacyEventCallback(topicName, eventFuture);
 102     }
 103
 104     /**
 105      * Generic Event Publisher with headers.
 106      *
 107      * @param topicName    valid topic name
 108      * @param eventKey     message key
 109      * @param eventHeaders map of event headers
 110      * @param event        message payload
 111      */
 112     public void publishEvent(final String topicName, final String eventKey, final Map<String, Object> eventHeaders,
 113             final T event) {
 114
 115         publishEvent(topicName, eventKey, convertToKafkaHeaders(eventHeaders), event);
 116     }
 117
 118     private void handleLegacyEventCallback(final String topicName,
 119             final CompletableFuture<SendResult<String, T>> eventFuture) {
 120         eventFuture.whenComplete((result, e) -> {
 121             if (e == null) {
 122                 log.debug("Successfully published event to topic : {} , Event : {}", result.getRecordMetadata().topic(),
 123                         result.getProducerRecord().value());
 124             } else {
 125                 log.error("Unable to publish event to topic : {} due to {}", topicName, e.getMessage());
 126             }
 127         });
 128     }
 129
 130     private Headers convertToKafkaHeaders(final Map<String, Object> eventMessageHeaders) {
 131         final Headers eventHeaders = new RecordHeaders();
 132         eventMessageHeaders.forEach((key, value) -> eventHeaders.add(key, SerializationUtils.serialize(value)));
 133         return eventHeaders;
 134     }
 135
 136 }