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