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.atomix.optionalClusterService
  21 import org.onap.ccsdk.cds.blueprintsprocessor.core.service.ClusterLock
  22 import org.onap.ccsdk.cds.blueprintsprocessor.functions.message.prioritization.PrioritizationConfiguration
  23 import org.onap.ccsdk.cds.blueprintsprocessor.functions.message.prioritization.db.MessagePrioritization
  24 import org.onap.ccsdk.cds.blueprintsprocessor.functions.message.prioritization.kafka.AbstractMessagePrioritizeProcessor
  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] prioritization procssing.*/
  32     suspend fun prioritizationGrouplock(messagePrioritization: MessagePrioritization): ClusterLock? {
  33         val clusterService = BluePrintDependencyService.optionalClusterService()
  34
  35         return if (clusterService != null && clusterService.clusterJoined() &&
  36             !messagePrioritization.correlationId.isNullOrBlank()
  37         ) {
  38             // Get the correlation key in ascending order, even it it is misplaced
  39             val correlationId = messagePrioritization.toFormatedCorrelation()
  40             val lockName = "prioritize::${messagePrioritization.group}::$correlationId"
  41             val clusterLock = clusterService.clusterLock(lockName)
  42             clusterLock.lock()
  43             if (!clusterLock.isLocked()) throw BluePrintProcessorException("failed to lock($lockName)")
  44             clusterLock
  45         } else null
  46     }
  47
  48     /** Utility to create the cluster lock for expiry scheduler*/
  49     suspend fun prioritizationExpiryLock(): ClusterLock? {
  50         val clusterService = BluePrintDependencyService.optionalClusterService()
  51         return if (clusterService != null && clusterService.clusterJoined()) {
  52             val lockName = "prioritize-expiry"
  53             val clusterLock = clusterService.clusterLock(lockName)
  54             clusterLock.lock()
  55             if (!clusterLock.isLocked()) throw BluePrintProcessorException("failed to lock($lockName)")
  56             clusterLock
  57         } else null
  58     }
  59
  60     /** Utility to create the cluster lock for expiry scheduler*/
  61     suspend fun prioritizationCleanLock(): ClusterLock? {
  62         val clusterService = BluePrintDependencyService.optionalClusterService()
  63         return if (clusterService != null && clusterService.clusterJoined()) {
  64             val lockName = "prioritize-clean"
  65             val clusterLock = clusterService.clusterLock(lockName)
  66             clusterLock.lock()
  67             if (!clusterLock.isLocked()) throw BluePrintProcessorException("failed to lock($lockName)")
  68             clusterLock
  69         } else null
  70     }
  71
  72     /** Utility used to cluster unlock for message [clusterLock] */
  73     suspend fun prioritizationUnLock(clusterLock: ClusterLock?) {
  74         if (clusterLock != null) {
  75             clusterLock.unLock()
  76             clusterLock.close()
  77         }
  78     }
  79
  80     /** Get the Kafka Supplier for processor lookup [name] and [prioritizationConfiguration] **/
  81     fun <K, V> bluePrintProcessorSupplier(name: String, prioritizationConfiguration: PrioritizationConfiguration):
  82         ProcessorSupplier<K, V> {
  83         return ProcessorSupplier<K, V> {
  84             // Dynamically resolve the Prioritization Processor
  85             val processorInstance = BluePrintDependencyService.instance<AbstractMessagePrioritizeProcessor<K, V>>(name)
  86             processorInstance.prioritizationConfiguration = prioritizationConfiguration
  87             processorInstance
  88         }
  89     }
  90 }