2 * Copyright © 2019 IBM.
3 * Modifications Copyright © 2018-2019 AT&T Intellectual Property.
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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 package org.onap.ccsdk.cds.blueprintsprocessor.message.service
20 import kotlinx.coroutines.channels.Channel
21 import org.apache.kafka.clients.consumer.Consumer
22 import org.apache.kafka.clients.consumer.ConsumerRecords
23 import org.onap.ccsdk.cds.blueprintsprocessor.message.MessageConsumerProperties
24 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
26 /** Consumer Function Interfaces */
27 interface ConsumerFunction
29 interface BlueprintMessageConsumerService {
31 suspend fun subscribe(): Channel<String> {
32 return subscribe(null)
35 /** Subscribe to the Kafka channel with [additionalConfig] */
36 suspend fun subscribe(additionalConfig: Map<String, Any>?): Channel<String>
38 /** Subscribe to the Kafka channel with [additionalConfig] for dynamic [topics]*/
39 suspend fun subscribe(topics: List<String>, additionalConfig: Map<String, Any>? = null): Channel<String>
41 /** Consume and execute dynamic function [consumerFunction] */
42 suspend fun consume(consumerFunction: ConsumerFunction) {
43 consume(null, consumerFunction)
46 /** Consume with [additionalConfig], so that we can execute dynamic function [consumerFunction] */
47 suspend fun consume(additionalConfig: Map<String, Any>?, consumerFunction: ConsumerFunction) {
48 throw BluePrintProcessorException("Not Implemented")
51 /** Consume the [topics] with [additionalConfig], so that we can execute dynamic function [consumerFunction] */
52 suspend fun consume(topics: List<String>, additionalConfig: Map<String, Any>?,
53 consumerFunction: ConsumerFunction) {
54 throw BluePrintProcessorException("Not Implemented")
57 /** close the channel, consumer and other resources */
58 suspend fun shutDown()
60 /** Consumer dynamic implementation interface */
61 interface KafkaConsumerRecordsFunction : ConsumerFunction {
62 suspend fun invoke(messageConsumerProperties: MessageConsumerProperties, consumer: Consumer<*, *>,
63 consumerRecords: ConsumerRecords<*, *>)