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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  *  Modifications Copyright (C) 2019-2020 Nordix Foundation.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.apex.plugins.event.carrier.kafka;
  23
  24 import java.util.Properties;
  25
  26 import org.apache.kafka.clients.consumer.ConsumerRecord;
  27 import org.apache.kafka.clients.consumer.ConsumerRecords;
  28 import org.apache.kafka.clients.consumer.KafkaConsumer;
  29 import org.onap.policy.apex.core.infrastructure.threading.ThreadUtilities;
  30 import org.onap.policy.apex.service.engine.event.ApexEventException;
  31 import org.onap.policy.apex.service.engine.event.ApexEventReceiver;
  32 import org.onap.policy.apex.service.engine.event.ApexPluginsEventConsumer;
  33 import org.onap.policy.apex.service.parameters.eventhandler.EventHandlerParameters;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 /**
  38  * This class implements an Apex event consumer that receives events using Kafka.
  39  *
  40  * @author Liam Fallon (liam.fallon@ericsson.com)
  41  */
  42 public class ApexKafkaConsumer extends ApexPluginsEventConsumer {
  43     // Get a reference to the logger
  44     private static final Logger LOGGER = LoggerFactory.getLogger(ApexKafkaConsumer.class);
  45
  46     // The Kafka parameters read from the parameter service
  47     private KafkaCarrierTechnologyParameters kafkaConsumerProperties;
  48
  49     // The event receiver that will receive events from this consumer
  50     private ApexEventReceiver eventReceiver;
  51
  52     // The Kafka consumer used to receive events using Kafka
  53     private KafkaConsumer<String, String> kafkaConsumer;
  54
  55     /**
  56      * {@inheritDoc}.
  57      */
  58     @Override
  59     public void init(final String consumerName, final EventHandlerParameters consumerParameters,
  60                     final ApexEventReceiver incomingEventReceiver) throws ApexEventException {
  61         this.eventReceiver = incomingEventReceiver;
  62         this.name = consumerName;
  63
  64         // Check and get the Kafka Properties
  65         if (!(consumerParameters.getCarrierTechnologyParameters() instanceof KafkaCarrierTechnologyParameters)) {
  66             LOGGER.warn("specified consumer properties of type \""
  67                             + consumerParameters.getCarrierTechnologyParameters().getClass().getName()
  68                             + "\" are not applicable to a Kafka consumer");
  69             throw new ApexEventException("specified consumer properties of type \""
  70                             + consumerParameters.getCarrierTechnologyParameters().getClass().getName()
  71                             + "\" are not applicable to a Kafka consumer");
  72         }
  73         kafkaConsumerProperties = (KafkaCarrierTechnologyParameters) consumerParameters
  74                         .getCarrierTechnologyParameters();
  75
  76         // Kick off the Kafka consumer
  77         kafkaConsumer = new KafkaConsumer<>(kafkaConsumerProperties.getKafkaConsumerProperties());
  78         kafkaConsumer.subscribe(kafkaConsumerProperties.getConsumerTopicListAsCollection());
  79         if (LOGGER.isDebugEnabled()) {
  80             LOGGER.debug("event receiver for " + this.getClass().getName() + ":" + this.name + " subscribed to topics: "
  81                             + kafkaConsumerProperties.getConsumerTopicList());
  82         }
  83     }
  84
  85
  86     /**
  87      * {@inheritDoc}.
  88      */
  89     @Override
  90     public void run() {
  91         // Kick off the Kafka consumer
  92         kafkaConsumer = new KafkaConsumer<>(kafkaConsumerProperties.getKafkaConsumerProperties());
  93         kafkaConsumer.subscribe(kafkaConsumerProperties.getConsumerTopicListAsCollection());
  94         if (LOGGER.isDebugEnabled()) {
  95             LOGGER.debug("event receiver for " + this.getClass().getName() + ":" + this.name + " subscribed to topics: "
  96                             + kafkaConsumerProperties.getConsumerTopicList());
  97         }
  98
  99         // The endless loop that receives events over Kafka
 100         while (consumerThread.isAlive() && !stopOrderedFlag) {
 101             try {
 102                 final ConsumerRecords<String, String> records = kafkaConsumer
 103                                 .poll(kafkaConsumerProperties.getConsumerPollDuration());
 104                 for (final ConsumerRecord<String, String> record : records) {
 105                     traceIfTraceEnabled(record);
 106                     eventReceiver.receiveEvent(new Properties(), record.value());
 107                 }
 108             } catch (final Exception e) {
 109                 LOGGER.warn("error receiving events on thread {}", consumerThread.getName(), e);
 110             }
 111         }
 112
 113         if (!consumerThread.isInterrupted()) {
 114             kafkaConsumer.close();
 115         }
 116     }
 117
 118     /**
 119      * Trace a record if trace is enabled.
 120      *
 121      * @param record the record to trace
 122      */
 123     private void traceIfTraceEnabled(final ConsumerRecord<String, String> record) {
 124         if (LOGGER.isTraceEnabled()) {
 125             LOGGER.trace("event received for {} for forwarding to Apex engine : {} {}",
 126                             this.getClass().getName() + ":" + this.name, record.key(), record.value());
 127         }
 128     }
 129
 130     /**
 131      * {@inheritDoc}.
 132      */
 133     @Override
 134     public void stop() {
 135         stopOrderedFlag = true;
 136
 137         while (consumerThread.isAlive()) {
 138             ThreadUtilities.sleep(kafkaConsumerProperties.getConsumerPollTime());
 139         }
 140     }
 141 }