gerrit.onap Code Review - ccsdk/cds.git/blob

   1 /*
   2  *  Copyright © 2019 IBM.
   3  *  Modifications Copyright © 2018-2019 AT&T Intellectual Property.
   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
  18 package org.onap.ccsdk.cds.blueprintsprocessor.message.service
  19
  20 import kotlinx.coroutines.channels.Channel
  21 import kotlinx.coroutines.delay
  22 import kotlinx.coroutines.launch
  23 import kotlinx.coroutines.runBlocking
  24 import org.apache.kafka.clients.consumer.Consumer
  25 import org.apache.kafka.clients.consumer.ConsumerRecord
  26 import org.apache.kafka.clients.consumer.KafkaConsumer
  27 import org.onap.ccsdk.cds.blueprintsprocessor.message.KafkaBasicAuthMessageConsumerProperties
  28 import org.onap.ccsdk.cds.controllerblueprints.core.logger
  29 import java.time.Duration
  30 import kotlin.concurrent.thread
  31
  32 open class KafkaMessageConsumerService(
  33     private val messageConsumerProperties: KafkaBasicAuthMessageConsumerProperties
  34 ) :
  35     BlueprintMessageConsumerService {
  36
  37     val log = logger(KafkaMessageConsumerService::class)
  38     val channel = Channel<ConsumerRecord<String, ByteArray>>()
  39     var kafkaConsumer: Consumer<String, ByteArray>? = null
  40
  41     @Volatile
  42     var keepGoing = true
  43
  44     fun kafkaConsumer(additionalConfig: Map<String, Any>? = null): Consumer<String, ByteArray> {
  45         val configProperties = messageConsumerProperties.getConfig()
  46         /** add or override already set properties */
  47         additionalConfig?.let { configProperties.putAll(it) }
  48         /** Create Kafka consumer */
  49         return KafkaConsumer(configProperties)
  50     }
  51
  52     override suspend fun subscribe(additionalConfig: Map<String, Any>?): Channel<ConsumerRecord<String, ByteArray>> {
  53         /** get to topic names */
  54         val consumerTopic = messageConsumerProperties.topic?.split(",")?.map { it.trim() }
  55         check(!consumerTopic.isNullOrEmpty()) { "couldn't get topic information" }
  56         return subscribe(consumerTopic, additionalConfig)
  57     }
  58
  59     override suspend fun subscribe(topics: List<String>, additionalConfig: Map<String, Any>?): Channel<ConsumerRecord<String, ByteArray>> {
  60         /** Create Kafka consumer */
  61         kafkaConsumer = kafkaConsumer(additionalConfig)
  62
  63         checkNotNull(kafkaConsumer) {
  64             "failed to create kafka consumer for " +
  65                 "server(${messageConsumerProperties.bootstrapServers})'s " +
  66                 "topics(${messageConsumerProperties.bootstrapServers})"
  67         }
  68
  69         kafkaConsumer!!.subscribe(topics)
  70         log.info("Successfully consumed topic($topics)")
  71
  72         thread(start = true, name = "KafkaConsumer-${messageConsumerProperties.clientId}") {
  73             keepGoing = true
  74             kafkaConsumer!!.use { kc ->
  75                 while (keepGoing) {
  76                     val consumerRecords = kc.poll(Duration.ofMillis(messageConsumerProperties.pollMillSec))
  77                     log.trace("Consumed Records : ${consumerRecords.count()}")
  78                     runBlocking {
  79                         consumerRecords?.forEach { consumerRecord ->
  80                             launch {
  81                                 /** execute the command block */
  82                                 if (!channel.isClosedForSend) {
  83                                     channel.send(consumerRecord)
  84                                 } else {
  85                                     log.error("Channel is closed to receive message")
  86                                 }
  87                             }
  88                         }
  89                     }
  90                 }
  91                 log.info("message listener shutting down.....")
  92             }
  93         }
  94         return channel
  95     }
  96
  97     override suspend fun consume(additionalConfig: Map<String, Any>?, consumerFunction: ConsumerFunction) {
  98         /** get to topic names */
  99         val consumerTopic = messageConsumerProperties.topic?.split(",")?.map { it.trim() }
 100         check(!consumerTopic.isNullOrEmpty()) { "couldn't get topic information" }
 101         return consume(topics = consumerTopic, additionalConfig = additionalConfig, consumerFunction = consumerFunction)
 102     }
 103
 104     override suspend fun consume(
 105         topics: List<String>,
 106         additionalConfig: Map<String, Any>?,
 107         consumerFunction: ConsumerFunction
 108     ) {
 109
 110         val kafkaConsumerFunction = consumerFunction as KafkaConsumerRecordsFunction
 111
 112         /** Create Kafka consumer */
 113         kafkaConsumer = kafkaConsumer(additionalConfig)
 114
 115         checkNotNull(kafkaConsumer) {
 116             "failed to create kafka consumer for " +
 117                 "server(${messageConsumerProperties.bootstrapServers})'s " +
 118                 "topics(${messageConsumerProperties.bootstrapServers})"
 119         }
 120
 121         kafkaConsumer!!.subscribe(topics)
 122         log.info("Successfully consumed topic($topics)")
 123
 124         thread(start = true, name = "KafkaConsumer-${messageConsumerProperties.clientId}") {
 125             keepGoing = true
 126             kafkaConsumer!!.use { kc ->
 127                 while (keepGoing) {
 128                     val consumerRecords = kc.poll(Duration.ofMillis(messageConsumerProperties.pollMillSec))
 129                     log.trace("Consumed Records : ${consumerRecords.count()}")
 130                     runBlocking {
 131                         /** Execute dynamic consumer Block substitution */
 132                         kafkaConsumerFunction.invoke(messageConsumerProperties, kc, consumerRecords)
 133                     }
 134                 }
 135                 log.info("message listener shutting down.....")
 136             }
 137         }
 138     }
 139
 140     override suspend fun shutDown() {
 141         /** stop the polling loop */
 142         keepGoing = false
 143         /** Close the Channel */
 144         channel.cancel()
 145         /** TO shutdown gracefully, need to wait for the maximum poll time */
 146         delay(messageConsumerProperties.pollMillSec)
 147     }
 148 }