gerrit.onap Code Review - cps.git/blob

   1 /*
   2  * ============LICENSE_START========================================================
   3  *  Copyright (C) 2022-2023 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  *
  17  *  SPDX-License-Identifier: Apache-2.0
  18  *  ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.cps.ncmp.impl.inventory.sync;
  22
  23 import com.hazelcast.config.MapConfig;
  24 import com.hazelcast.config.QueueConfig;
  25 import com.hazelcast.map.IMap;
  26 import java.util.concurrent.BlockingQueue;
  27 import java.util.concurrent.locks.Lock;
  28 import lombok.extern.slf4j.Slf4j;
  29 import org.onap.cps.ncmp.impl.cache.HazelcastCacheConfig;
  30 import org.onap.cps.spi.model.DataNode;
  31 import org.springframework.context.annotation.Bean;
  32 import org.springframework.context.annotation.Configuration;
  33
  34 /**
  35  * Core infrastructure of the hazelcast distributed caches for Module Sync and Data Sync use cases.
  36  */
  37 @Slf4j
  38 @Configuration
  39 public class SynchronizationCacheConfig extends HazelcastCacheConfig {
  40
  41     public static final int MODULE_SYNC_STARTED_TTL_SECS = 600;
  42     public static final int DATA_SYNC_SEMAPHORE_TTL_SECS = 1800;
  43
  44     private static final QueueConfig commonQueueConfig = createQueueConfig("defaultQueueConfig");
  45     private static final MapConfig moduleSyncStartedConfig = createMapConfig("moduleSyncStartedConfig");
  46     private static final MapConfig dataSyncSemaphoresConfig = createMapConfig("dataSyncSemaphoresConfig");
  47     private static final String LOCK_NAME_FOR_WORK_QUEUE = "workQueueLock";
  48
  49     /**
  50      * Module Sync Distributed Queue Instance.
  51      *
  52      * @return queue of cm handles (data nodes) that need module sync
  53      */
  54     @Bean
  55     public BlockingQueue<DataNode> moduleSyncWorkQueue() {
  56         return getOrCreateHazelcastInstance(commonQueueConfig).getQueue("moduleSyncWorkQueue");
  57     }
  58
  59     /**
  60      * Module Sync started (and maybe finished) on cm handles (ids).
  61      *
  62      * @return Map of cm handles (ids) and objects (not used really) for which module sync has started or been completed
  63      */
  64     @Bean
  65     public IMap<String, Object> moduleSyncStartedOnCmHandles() {
  66         return getOrCreateHazelcastInstance(moduleSyncStartedConfig).getMap(
  67                 "moduleSyncStartedOnCmHandles");
  68     }
  69
  70     /**
  71      * Data Sync Distributed Map Instance.
  72      *
  73      * @return configured map of data sync semaphores
  74      */
  75     @Bean
  76     public IMap<String, Boolean> dataSyncSemaphores() {
  77         return getOrCreateHazelcastInstance(dataSyncSemaphoresConfig).getMap("dataSyncSemaphores");
  78     }
  79
  80     /**
  81      * Retrieves a distributed lock used to control access to the work queue for module synchronization.
  82      * This lock ensures that the population and modification of the work queue are thread-safe and
  83      * protected from concurrent access across different nodes in the distributed system.
  84      * The lock guarantees that only one instance of the application can populate or modify the
  85      * module sync work queue at a time, preventing race conditions and potential data inconsistencies.
  86      * The lock is obtained using the Hazelcast CP Subsystem's {@link Lock}, which provides
  87      * strong consistency guarantees for distributed operations.
  88      *
  89      * @return a {@link Lock} instance used for synchronizing access to the work queue.
  90      */
  91     @Bean
  92     public Lock workQueueLock() {
  93         // TODO Method below does not use commonQueueConfig for creating lock (Refactor later)
  94         return getOrCreateHazelcastInstance(commonQueueConfig).getCPSubsystem().getLock(LOCK_NAME_FOR_WORK_QUEUE);
  95     }
  96 }