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 java.util.Map;
  24 import lombok.RequiredArgsConstructor;
  25 import lombok.extern.slf4j.Slf4j;
  26 import org.apache.kafka.clients.producer.ProducerRecord;
  27 import org.apache.kafka.common.header.Headers;
  28 import org.apache.kafka.common.header.internals.RecordHeaders;
  29 import org.springframework.kafka.core.KafkaTemplate;
  30 import org.springframework.kafka.support.SendResult;
  31 import org.springframework.stereotype.Service;
  32 import org.springframework.util.SerializationUtils;
  33 import org.springframework.util.concurrent.ListenableFuture;
  34 import org.springframework.util.concurrent.ListenableFutureCallback;
  35
  36 /**
  37  * EventsPublisher to publish events.
  38  */
  39
  40 @Slf4j
  41 @Service
  42 @RequiredArgsConstructor
  43 public class EventsPublisher<T> {
  44
  45     private final KafkaTemplate<String, T> eventKafkaTemplate;
  46
  47     /**
  48      * Generic Event publisher.
  49      *
  50      * @param topicName valid topic name
  51      * @param eventKey  message key
  52      * @param event     message payload
  53      * @deprecated This method is not needed anymore since the use of headers will be in place.
  54      */
  55     @Deprecated
  56     public void publishEvent(final String topicName, final String eventKey, final T event) {
  57         final ListenableFuture<SendResult<String, T>> eventFuture = eventKafkaTemplate.send(topicName, eventKey, event);
  58         eventFuture.addCallback(handleCallback(topicName));
  59     }
  60
  61     /**
  62      * Generic Event Publisher with headers.
  63      *
  64      * @param topicName    valid topic name
  65      * @param eventKey     message key
  66      * @param eventHeaders event headers
  67      * @param event        message payload
  68      */
  69     public void publishEvent(final String topicName, final String eventKey, final Headers eventHeaders, final T event) {
  70
  71         final ProducerRecord<String, T> producerRecord =
  72                 new ProducerRecord<>(topicName, null, eventKey, event, eventHeaders);
  73         final ListenableFuture<SendResult<String, T>> eventFuture = eventKafkaTemplate.send(producerRecord);
  74         eventFuture.addCallback(handleCallback(topicName));
  75     }
  76
  77     /**
  78      * Generic Event Publisher with headers.
  79      *
  80      * @param topicName    valid topic name
  81      * @param eventKey     message key
  82      * @param eventHeaders map of event headers
  83      * @param event        message payload
  84      */
  85     public void publishEvent(final String topicName, final String eventKey, final Map<String, Object> eventHeaders,
  86             final T event) {
  87
  88         publishEvent(topicName, eventKey, convertToKafkaHeaders(eventHeaders), event);
  89     }
  90
  91     private ListenableFutureCallback<SendResult<String, T>> handleCallback(final String topicName) {
  92         return new ListenableFutureCallback<>() {
  93             @Override
  94             public void onFailure(final Throwable throwable) {
  95                 log.error("Unable to publish event to topic : {} due to {}", topicName, throwable.getMessage());
  96             }
  97
  98             @Override
  99             public void onSuccess(final SendResult<String, T> sendResult) {
 100                 log.debug("Successfully published event to topic : {} , Event : {}",
 101                         sendResult.getRecordMetadata().topic(), sendResult.getProducerRecord().value());
 102             }
 103         };
 104     }
 105
 106     private Headers convertToKafkaHeaders(final Map<String, Object> eventMessageHeaders) {
 107         final Headers eventHeaders = new RecordHeaders();
 108         eventMessageHeaders.forEach((key, value) -> eventHeaders.add(key, SerializationUtils.serialize(value)));
 109         return eventHeaders;
 110     }
 111
 112 }