Prioritization expiry and clean scheduler service
[ccsdk/cds.git] / ms / blueprintsprocessor / functions / message-prioritizaion / src / main / kotlin / org / onap / ccsdk / cds / blueprintsprocessor / functions / message / prioritization / MessagePrioritizationService.kt
1 /*
2  * Copyright © 2018-2019 AT&T Intellectual Property.
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.functions.message.prioritization
18
19 import org.apache.kafka.streams.processor.ProcessorContext
20 import org.onap.ccsdk.cds.blueprintsprocessor.functions.message.prioritization.db.MessagePrioritization
21
22 interface MessagePrioritizationService {
23
24     fun setKafkaProcessorContext(processorContext: ProcessorContext?)
25
26     suspend fun prioritize(messagePrioritization: MessagePrioritization)
27
28     /** Used to produce the prioritized or sequenced or aggregated message in Kafka topic or in database */
29     suspend fun output(messages: List<MessagePrioritization>)
30
31     /** Scheduler service will use this method for updating the expired messages based on the [expiryConfiguration] */
32     suspend fun updateExpiredMessages(expiryConfiguration: ExpiryConfiguration)
33
34     /** Scheduler service will use this method for clean the expired messages based on the [cleanConfiguration] */
35     suspend fun cleanExpiredMessage(cleanConfiguration: CleanConfiguration)
36 }