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