ms/blueprintsprocessor/modules/commons/message-lib/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/message/service/BlueprintMessageConsumerService.kt

   1 /*
   2  *  Copyright © 2019 IBM.
   3  *
   4  *  Licensed under the Apache License, Version 2.0 (the "License");
   5  *  you may not use this file except in compliance with the License.
   6  *  You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  */
  16
  17 package org.onap.ccsdk.cds.blueprintsprocessor.message.service
  18
  19 import kotlinx.coroutines.channels.Channel
  20
  21 interface BlueprintMessageConsumerService {
  22
  23     /** Subscribe to the Kafka channel with [additionalConfig] */
  24     suspend fun subscribe(additionalConfig: Map<String, Any>?): Channel<String>
  25
  26     /** Subscribe to the Kafka channel with [additionalConfig] for dynamic [topics]*/
  27     suspend fun subscribe(topics: List<String>, additionalConfig: Map<String, Any>? = null): Channel<String>
  28
  29     /** close the channel, consumer and other resources */
  30     suspend fun shutDown()
  31
  32 }