1 files changed, 106 insertions, 0 deletions
diff --git a/ms/blueprintsprocessor/modules/commons/processor-core/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/core/service/BluePrintClusterService.kt b/ms/blueprintsprocessor/modules/commons/processor-core/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/core/service/BluePrintClusterService.kt
new file mode 100644
index 000000000..f7ba6f25f
--- /dev/null
+++ b/ms/blueprintsprocessor/modules/commons/processor-core/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/core/service/BluePrintClusterService.kt
@@ -0,0 +1,106 @@
+/*
+ * 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.service
+
+import org.onap.ccsdk.cds.blueprintsprocessor.core.cluster.BlueprintClusterTopic
+import org.springframework.context.ApplicationEvent
+import java.time.Duration
+import java.util.Properties
+import java.util.UUID
+
+interface BluePrintClusterService {
+
+    /** Start the cluster with [clusterInfo], By default clustering service is disabled.
+     * Application module has to start cluster */
+    suspend fun <T> startCluster(configuration: T)
+
+    fun clusterJoined(): Boolean
+
+    fun isClient(): Boolean
+
+    fun isLiteMember(): Boolean
+
+    /** Returns [partitionGroup] master member */
+    suspend fun masterMember(partitionGroup: String): ClusterMember
+
+    /** Returns all the data cluster members */
+    suspend fun allMembers(): Set<ClusterMember>
+
+    /**
+     * Returns application cluster members for [appName] joined as server or lite member,
+     * Node joined as client won't be visible. Here the assumption is node-id is combination of
+     * application id and replica number, for an example Application cds-cluster then the node ids will be
+     * cds-cluster-1, cds-cluster-2, cds-cluster-3
+     */
+    suspend fun applicationMembers(appName: String): Set<ClusterMember>
+
+    /** Create and get or get the distributed data map store with [name] */
+    suspend fun <T> clusterMapStore(name: String): MutableMap<String, T>
+
+    /** Create and get the distributed lock with [name] */
+    suspend fun clusterLock(name: String): ClusterLock
+
+    /** Shut down the cluster with [duration] */
+    suspend fun shutDown(duration: Duration)
+
+    /** Send [message] to the listener(s) of a [topic] */
+    suspend fun <T> sendMessage(topic: BlueprintClusterTopic, message: T)
+
+    /** Register a [listener] to a [topic] and returns his UUID */
+    fun <T> addBlueprintClusterMessageListener(topic: BlueprintClusterTopic, listener: BlueprintClusterMessageListener<T>): UUID
+
+    /** Unregister a listener from a [topic] using his [uuid] and returns true if it succeeded */
+    fun removeBlueprintClusterMessageListener(topic: BlueprintClusterTopic, uuid: UUID): Boolean
+}
+
+data class ClusterInfo(
+    val id: String,
+    val nodeId: String,
+    var joinAsClient: Boolean = false,
+    var properties: Properties?,
+    var configFile: String
+)
+
+data class ClusterMember(
+    val id: String,
+    val name: String,
+    val memberAddress: String?,
+    val state: String? = null
+)
+
+interface ClusterLock {
+
+    fun name(): String
+    suspend fun lock()
+    suspend fun fenceLock(): String
+    suspend fun tryLock(timeout: Long): Boolean
+    suspend fun tryFenceLock(timeout: Long): String
+    suspend fun unLock()
+    fun isLocked(): Boolean
+    fun isLockedByCurrentThread(): Boolean
+    fun close()
+}
+
+class BluePrintClusterMessage<E>(val topic: BlueprintClusterTopic, val payload: E, publishTime: Long, clusterMember: ClusterMember)
+
+interface BlueprintClusterMessageListener<E> {
+    fun onMessage(message: BluePrintClusterMessage<E>?)
+}
+
+class ClusterJoinedEvent(source: Any) : ApplicationEvent(source)
+
+const val CDS_LOCK_GROUP = "cds-lock"