Include correlationId in group lock.
[ccsdk/cds.git] / ms / blueprintsprocessor / functions / message-prioritizaion / src / main / kotlin / org / onap / ccsdk / cds / blueprintsprocessor / functions / message / prioritization / utils / MessageProcessorUtils.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.utils
18
19 import org.apache.kafka.streams.processor.ProcessorSupplier
20 import org.onap.ccsdk.cds.blueprintsprocessor.core.service.BluePrintClusterService
21 import org.onap.ccsdk.cds.blueprintsprocessor.core.service.ClusterLock
22 import org.onap.ccsdk.cds.blueprintsprocessor.functions.message.prioritization.AbstractMessagePrioritizeProcessor
23 import org.onap.ccsdk.cds.blueprintsprocessor.functions.message.prioritization.PrioritizationConfiguration
24 import org.onap.ccsdk.cds.blueprintsprocessor.functions.message.prioritization.db.MessagePrioritization
25 import org.onap.ccsdk.cds.blueprintsprocessor.functions.message.prioritization.toFormatedCorrelation
26 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
27 import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintDependencyService
28
29 object MessageProcessorUtils {
30
31     /** Utility to create the cluster lock for message [messagePrioritization] */
32     suspend fun prioritizationGrouplock(
33         clusterService: BluePrintClusterService?,
34         messagePrioritization: MessagePrioritization
35     ): ClusterLock? {
36         return if (clusterService != null && clusterService.clusterJoined() &&
37             !messagePrioritization.correlationId.isNullOrBlank()
38         ) {
39             // Get the correlation key in ascending order, even it it is misplaced
40             val correlationId = messagePrioritization.toFormatedCorrelation()
41             val lockName = "prioritization-${messagePrioritization.group}-$correlationId"
42             val clusterLock = clusterService.clusterLock(lockName)
43             clusterLock.lock()
44             if (!clusterLock.isLocked()) throw BluePrintProcessorException("failed to lock($lockName)")
45             clusterLock
46         } else null
47     }
48
49     /** Utility used to cluster unlock for message [messagePrioritization] */
50     suspend fun prioritizationGroupUnLock(clusterService: BluePrintClusterService?, clusterLock: ClusterLock?) {
51         if (clusterService != null && clusterService.clusterJoined() && clusterLock != null) {
52             clusterLock.unLock()
53             clusterLock.close()
54         }
55     }
56
57     fun <K, V> bluePrintProcessorSupplier(name: String, prioritizationConfiguration: PrioritizationConfiguration):
58         ProcessorSupplier<K, V> {
59         return ProcessorSupplier<K, V> {
60             // Dynamically resolve the Prioritization Processor
61             val processorInstance = BluePrintDependencyService.instance<AbstractMessagePrioritizeProcessor<K, V>>(name)
62             processorInstance.prioritizationConfiguration = prioritizationConfiguration
63             processorInstance
64         }
65     }
66 }