98ff6112185f83590e5189ed5c82d6bb506e29c5
[policy/apex-pdp.git] /
1 /*-
2  * ============LICENSE_START=======================================================
3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
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.policy.apex.plugins.event.carrier.kafka;
22
23 import java.util.EnumMap;
24 import java.util.Map;
25 import java.util.Properties;
26
27 import org.apache.kafka.clients.producer.KafkaProducer;
28 import org.apache.kafka.clients.producer.Producer;
29 import org.apache.kafka.clients.producer.ProducerRecord;
30 import org.onap.policy.apex.service.engine.event.ApexEventException;
31 import org.onap.policy.apex.service.engine.event.ApexEventProducer;
32 import org.onap.policy.apex.service.engine.event.PeeredReference;
33 import org.onap.policy.apex.service.engine.event.SynchronousEventCache;
34 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
35 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerPeeredMode;
36 import org.slf4j.Logger;
37 import org.slf4j.LoggerFactory;
38
39 /**
40  * Concrete implementation of an Apex event producer that sends events using Kafka.
41  *
42  * @author Liam Fallon (liam.fallon@ericsson.com)
43  */
44 public class ApexKafkaProducer implements ApexEventProducer {
45
46     // Get a reference to the logger
47     private static final Logger LOGGER = LoggerFactory.getLogger(ApexKafkaProducer.class);
48
49     // The Kafka parameters read from the parameter service
50     private KafkaCarrierTechnologyParameters kafkaProducerProperties;
51
52     // The Kafka Producer used to send events using Kafka
53     private Producer<String, Object> kafkaProducer;
54
55     // The name for this producer
56     private String name = null;
57
58     // The peer references for this event handler
59     private Map<EventHandlerPeeredMode, PeeredReference> peerReferenceMap = new EnumMap<>(EventHandlerPeeredMode.class);
60
61     @Override
62     public void init(final String producerName, final EventHandlerParameters producerParameters)
63             throws ApexEventException {
64         this.name = producerName;
65
66         // Check and get the Kafka Properties
67         if (!(producerParameters.getCarrierTechnologyParameters() instanceof KafkaCarrierTechnologyParameters)) {
68             String message = "specified producer properties are not applicable to a Kafka producer (" + this.name + ")";
69             LOGGER.warn(message);
70             throw new ApexEventException(message);
71         }
72         kafkaProducerProperties =
73                 (KafkaCarrierTechnologyParameters) producerParameters.getCarrierTechnologyParameters();
74     }
75
76     /**
77      * {@inheritDoc}.
78      */
79     @Override
80     public String getName() {
81         return name;
82     }
83
84     /**
85      * {@inheritDoc}.
86      */
87     @Override
88     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
89         return peerReferenceMap.get(peeredMode);
90     }
91
92     /**
93      * {@inheritDoc}.
94      */
95     @Override
96     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
97         peerReferenceMap.put(peeredMode, peeredReference);
98     }
99
100     /**
101      * {@inheritDoc}.
102      */
103     @Override
104     public void sendEvent(final long executionId, final Properties executionProperties, final String eventName,
105             final Object event) {
106         // Check if this is a synchronized event, if so we have received a reply
107         final SynchronousEventCache synchronousEventCache =
108                 (SynchronousEventCache) peerReferenceMap.get(EventHandlerPeeredMode.SYNCHRONOUS);
109         if (synchronousEventCache != null) {
110             synchronousEventCache.removeCachedEventToApexIfExists(executionId);
111         }
112
113         // Kafka producer must be started in the same thread as it is stopped, so we must start it here
114         if (kafkaProducer == null) {
115             // Kick off the Kafka producer
116             kafkaProducer = new KafkaProducer<>(kafkaProducerProperties.getKafkaProducerProperties());
117             if (LOGGER.isDebugEnabled()) {
118                 LOGGER.debug("event producer " + this.name + " is ready to send to topics: "
119                         + kafkaProducerProperties.getProducerTopic());
120             }
121         }
122
123         kafkaProducer.send(new ProducerRecord<String, Object>(kafkaProducerProperties.getProducerTopic(), name, event));
124         if (LOGGER.isTraceEnabled()) {
125             LOGGER.trace("event sent from engine using {} to topic {} : {} ", this.name,
126                     kafkaProducerProperties.getProducerTopic(), event);
127         }
128     }
129
130     /**
131      * {@inheritDoc}.
132      */
133     @Override
134     public void stop() {
135         if (kafkaProducer != null) {
136             kafkaProducer.flush();
137             kafkaProducer.close();
138         }
139     }
140 }