gerrit.onap Code Review - policy/apex-pdp.git/blob

   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             LOGGER.warn("specified producer properties are not applicable to a Kafka producer (" + this.name + ")");
  68             throw new ApexEventException(
  69                     "specified producer properties are not applicable to a Kafka producer (" + this.name + ")");
  70         }
  71         kafkaProducerProperties =
  72                 (KAFKACarrierTechnologyParameters) producerParameters.getCarrierTechnologyParameters();
  73     }
  74
  75     /*
  76      * (non-Javadoc)
  77      *
  78      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getName()
  79      */
  80     @Override
  81     public String getName() {
  82         return name;
  83     }
  84
  85     /*
  86      * (non-Javadoc)
  87      *
  88      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#getPeeredReference(org.onap.policy.apex.service.
  89      * parameters.eventhandler.EventHandlerPeeredMode)
  90      */
  91     @Override
  92     public PeeredReference getPeeredReference(final EventHandlerPeeredMode peeredMode) {
  93         return peerReferenceMap.get(peeredMode);
  94     }
  95
  96     /*
  97      * (non-Javadoc)
  98      *
  99      * @see org.onap.policy.apex.service.engine.event.ApexEventProducer#setPeeredReference(org.onap.policy.apex.service.
 100      * parameters.eventhandler.EventHandlerPeeredMode, org.onap.policy.apex.service.engine.event.PeeredReference)
 101      */
 102     @Override
 103     public void setPeeredReference(final EventHandlerPeeredMode peeredMode, final PeeredReference peeredReference) {
 104         peerReferenceMap.put(peeredMode, peeredReference);
 105     }
 106
 107     /*
 108      * (non-Javadoc)
 109      *
 110      * @see org.onap.policy.apex.apps.uservice.producer.ApexEventProducer#sendEvent(long, java.lang.String,
 111      * java.lang.Object)
 112      */
 113     @Override
 114     public void sendEvent(final long executionId, final String eventName, final Object event) {
 115         // Check if this is a synchronized event, if so we have received a reply
 116         final SynchronousEventCache synchronousEventCache =
 117                 (SynchronousEventCache) peerReferenceMap.get(EventHandlerPeeredMode.SYNCHRONOUS);
 118         if (synchronousEventCache != null) {
 119             synchronousEventCache.removeCachedEventToApexIfExists(executionId);
 120         }
 121
 122         // Kafka producer must be started in the same thread as it is stopped, so we must start it here
 123         if (kafkaProducer == null) {
 124             // Kick off the Kafka producer
 125             kafkaProducer = new KafkaProducer<String, Object>(kafkaProducerProperties.getKafkaProducerProperties());
 126             if (LOGGER.isDebugEnabled()) {
 127                 LOGGER.debug("event producer " + this.name + " is ready to send to topics: "
 128                         + kafkaProducerProperties.getProducerTopic());
 129             }
 130         }
 131
 132         kafkaProducer.send(new ProducerRecord<String, Object>(kafkaProducerProperties.getProducerTopic(), name, event));
 133         if (LOGGER.isTraceEnabled()) {
 134             LOGGER.trace("event sent from engine using {} to topic {} : {} ", this.name,
 135                     kafkaProducerProperties.getProducerTopic(), event);
 136         }
 137     }
 138
 139     /*
 140      * (non-Javadoc)
 141      *
 142      * @see org.onap.policy.apex.apps.uservice.producer.ApexEventProducer#stop()
 143      */
 144     @Override
 145     public void stop() {
 146         if (kafkaProducer != null) {
 147             kafkaProducer.flush();
 148             kafkaProducer.close();
 149         }
 150     }
 151 }