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.ConsumerRecord
23 import org.apache.kafka.clients.consumer.ConsumerRecords
24 import org.apache.kafka.streams.Topology
25 import org.onap.ccsdk.cds.blueprintsprocessor.message.MessageConsumerProperties
26 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
28 /** Consumer Function Interfaces */
29 interface ConsumerFunction
31 interface BlueprintMessageConsumerService {
33 suspend fun subscribe(): Channel<ConsumerRecord<String, ByteArray>> {
34 return subscribe(null)
37 /** Subscribe to the Kafka channel with [additionalConfig] */
38 suspend fun subscribe(additionalConfig: Map<String, Any>?): Channel<ConsumerRecord<String, ByteArray>>
40 /** Subscribe to the Kafka channel with [additionalConfig] for dynamic [topics]*/
41 suspend fun subscribe(topics: List<String>, additionalConfig: Map<String, Any>? = null): Channel<ConsumerRecord<String, ByteArray>>
43 /** Consume and execute dynamic function [consumerFunction] */
44 suspend fun consume(consumerFunction: ConsumerFunction) {
45 consume(null, consumerFunction)
48 /** Consume with [additionalConfig], so that we can execute dynamic function [consumerFunction] */
49 suspend fun consume(additionalConfig: Map<String, Any>?, consumerFunction: ConsumerFunction) {
50 throw BluePrintProcessorException("Not Implemented")
53 /** Consume the [topics] with [additionalConfig], so that we can execute dynamic function [consumerFunction] */
56 additionalConfig: Map<String, Any>?,
57 consumerFunction: ConsumerFunction
59 throw BluePrintProcessorException("Not Implemented")
62 /** close the channel, consumer and other resources */
63 suspend fun shutDown()
66 /** Consumer dynamic implementation interface */
67 interface KafkaConsumerRecordsFunction : ConsumerFunction {
70 messageConsumerProperties: MessageConsumerProperties,
71 consumer: Consumer<*, *>,
72 consumerRecords: ConsumerRecords<*, *>
76 interface KafkaStreamConsumerFunction : ConsumerFunction {
77 suspend fun createTopology(
78 messageConsumerProperties: MessageConsumerProperties,
79 additionalConfig: Map<String, Any>?