aboutsummaryrefslogtreecommitdiffstats
path: root/ms/blueprintsprocessor/modules/commons/processor-core/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/core/cluster/BluePrintClusterExtensions.kt
blob: edb5bbfe6abc8461d7e112a5af738f6b7df0670a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
/*
 * Copyright © 2018-2019 AT&T Intellectual Property.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.onap.ccsdk.cds.blueprintsprocessor.core.cluster

import com.hazelcast.cluster.Member
import kotlinx.coroutines.GlobalScope
import kotlinx.coroutines.newSingleThreadContext
import kotlinx.coroutines.withContext
import org.onap.ccsdk.cds.blueprintsprocessor.core.service.BluePrintClusterService
import org.onap.ccsdk.cds.blueprintsprocessor.core.service.ClusterLock
import org.onap.ccsdk.cds.blueprintsprocessor.core.service.ClusterMember
import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants
import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintException
import org.onap.ccsdk.cds.controllerblueprints.core.MDCContext
import org.onap.ccsdk.cds.controllerblueprints.core.service.BluePrintDependencyService

/**
 * Exposed Dependency Service by this Hazelcast Lib Module
 */
fun BluePrintDependencyService.clusterService(): BluePrintClusterService =
    instance(HazelcastClusterService::class)

/** Optional Cluster Service, returns only if Cluster is enabled */
fun BluePrintDependencyService.optionalClusterService(): BluePrintClusterService? {
    return if (BluePrintConstants.CLUSTER_ENABLED) {
        BluePrintDependencyService.clusterService()
    } else null
}

/** Extension to convert Hazelcast Member to Blueprints Cluster Member */
fun Member.toClusterMember(): ClusterMember {
    val memberName: String = this.getAttribute(BluePrintConstants.PROPERTY_CLUSTER_NODE_ID) ?: this.uuid.toString()
    return ClusterMember(
        id = this.uuid.toString(),
        name = memberName,
        memberAddress = this.address.toString()
    )
}

/**
 * This function will try to acquire the lock and then execute the provided block.
 * If the lock cannot be acquired within timeout, a BluePrintException will be thrown.
 *
 * Since a lock can only be unlocked by the the thread which acquired the lock,
 * this function will confine coroutines within the block to a dedicated thread.
 */
suspend fun <R> ClusterLock.executeWithLock(acquireLockTimeout: Long, block: suspend () -> R): R {
    val lock = this
    return newSingleThreadContext(lock.name()).use {
        withContext(GlobalScope.coroutineContext[MDCContext]?.plus(it) ?: it) {
            if (lock.tryLock(acquireLockTimeout)) {
                try {
                    block()
                } finally {
                    lock.unLock()
                }
            } else
                throw BluePrintException("Failed to acquire lock within timeout")
        }
    }
}