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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.cps.ncmp.api.impl.events;
23 import io.cloudevents.CloudEvent;
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;
38 * EventsPublisher to publish events.
43 @RequiredArgsConstructor
44 public class EventsPublisher<T> {
46 /** Once all cps events will be modified to cloud compliant, will remove legacyKafkaEventTemplate with
47 it's java configuration file KafkaTemplateConfig. **/
48 @Deprecated(forRemoval = true)
49 private final KafkaTemplate<String, T> legacyKafkaEventTemplate;
51 private final KafkaTemplate<String, CloudEvent> cloudEventKafkaTemplate;
54 * Generic Event publisher.
56 * @param topicName valid topic name
57 * @param eventKey message key
58 * @param event message payload
59 * @deprecated This method is not needed anymore since the use of headers will be in place.
62 public void publishEvent(final String topicName, final String eventKey, final T event) {
63 final ListenableFuture<SendResult<String, T>> eventFuture
64 = legacyKafkaEventTemplate.send(topicName, eventKey, event);
65 eventFuture.addCallback(handleCallback(topicName));
69 * Generic Event Publisher with headers.
71 * @param topicName valid topic name
72 * @param eventKey message key
73 * @param eventHeaders event headers
74 * @param event message payload
76 public void publishEvent(final String topicName, final String eventKey, final Headers eventHeaders, final T event) {
78 final ProducerRecord<String, T> producerRecord =
79 new ProducerRecord<>(topicName, null, eventKey, event, eventHeaders);
80 final ListenableFuture<SendResult<String, T>> eventFuture = legacyKafkaEventTemplate.send(producerRecord);
81 eventFuture.addCallback(handleCallback(topicName));
85 * Generic Event Publisher with headers.
87 * @param topicName valid topic name
88 * @param eventKey message key
89 * @param eventHeaders map of event headers
90 * @param event message payload
92 public void publishEvent(final String topicName, final String eventKey, final Map<String, Object> eventHeaders,
95 publishEvent(topicName, eventKey, convertToKafkaHeaders(eventHeaders), event);
98 private ListenableFutureCallback<SendResult<String, T>> handleCallback(final String topicName) {
99 return new ListenableFutureCallback<>() {
101 public void onFailure(final Throwable throwable) {
102 log.error("Unable to publish event to topic : {} due to {}", topicName, throwable.getMessage());
106 public void onSuccess(final SendResult<String, T> sendResult) {
107 log.debug("Successfully published event to topic : {} , Event : {}",
108 sendResult.getRecordMetadata().topic(), sendResult.getProducerRecord().value());
113 private Headers convertToKafkaHeaders(final Map<String, Object> eventMessageHeaders) {
114 final Headers eventHeaders = new RecordHeaders();
115 eventMessageHeaders.forEach((key, value) -> eventHeaders.add(key, SerializationUtils.serialize(value)));