gerrit.onap Code Review - cps.git/blob

   1 /*
   2  * ============LICENSE_START========================================================
   3  *  Copyright (C) 2022-2024 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.collection.ISet;
  24 import com.hazelcast.config.MapConfig;
  25 import com.hazelcast.config.QueueConfig;
  26 import com.hazelcast.config.SetConfig;
  27 import com.hazelcast.map.IMap;
  28 import java.util.concurrent.BlockingQueue;
  29 import java.util.concurrent.locks.Lock;
  30 import lombok.extern.slf4j.Slf4j;
  31 import org.onap.cps.ncmp.impl.cache.HazelcastCacheConfig;
  32 import org.springframework.context.annotation.Bean;
  33 import org.springframework.context.annotation.Configuration;
  34
  35 /**
  36  * Core infrastructure of the hazelcast distributed caches for Module Sync and Data Sync use cases.
  37  */
  38 @Slf4j
  39 @Configuration
  40 public class SynchronizationCacheConfig extends HazelcastCacheConfig {
  41
  42     public static final int MODULE_SYNC_STARTED_TTL_SECS = 600;
  43     public static final int DATA_SYNC_SEMAPHORE_TTL_SECS = 1800;
  44
  45     private static final QueueConfig commonQueueConfig = createQueueConfig("defaultQueueConfig");
  46     private static final MapConfig moduleSyncStartedConfig =
  47             createMapConfigWithTimeToLiveInSeconds("moduleSyncStartedConfig", MODULE_SYNC_STARTED_TTL_SECS);
  48     private static final MapConfig dataSyncSemaphoresConfig = createMapConfig("dataSyncSemaphoresConfig");
  49     private static final SetConfig moduleSetTagsBeingProcessedConfig
  50         = createSetConfig("moduleSetTagsBeingProcessedConfig");
  51     private static final String LOCK_NAME_FOR_WORK_QUEUE = "workQueueLock";
  52
  53     /**
  54      * Module Sync Distributed Queue Instance.
  55      *
  56      * @return queue of cm handle ids that need module sync
  57      */
  58     @Bean
  59     public BlockingQueue<String> moduleSyncWorkQueue() {
  60         return getOrCreateHazelcastInstance(commonQueueConfig).getQueue("moduleSyncWorkQueue");
  61     }
  62
  63     /**
  64      * Module Sync started (and maybe finished) on cm handles (ids).
  65      *
  66      * @return Map of cm handles (ids) and objects (not used really) for which module sync has started or been completed
  67      */
  68     @Bean
  69     public IMap<String, Object> moduleSyncStartedOnCmHandles() {
  70         return getOrCreateHazelcastInstance(moduleSyncStartedConfig).getMap("moduleSyncStartedOnCmHandles");
  71     }
  72
  73     /**
  74      * Data Sync Distributed Map Instance.
  75      *
  76      * @return configured map of data sync semaphores
  77      */
  78     @Bean
  79     public IMap<String, Boolean> dataSyncSemaphores() {
  80         return getOrCreateHazelcastInstance(dataSyncSemaphoresConfig).getMap("dataSyncSemaphores");
  81     }
  82
  83     /**
  84      * Collection of (new) module set tags being processed.
  85      * To prevent processing on multiple threads of same tag
  86      *
  87      * @return set of module set tags being processed
  88      */
  89     @Bean
  90     public ISet<String> moduleSetTagsBeingProcessed() {
  91         return getOrCreateHazelcastInstance(moduleSetTagsBeingProcessedConfig).getSet("moduleSetTagsBeingProcessed");
  92     }
  93
  94     /**
  95      * Retrieves a distributed lock used to control access to the work queue for module synchronization.
  96      * This lock ensures that the population and modification of the work queue are thread-safe and
  97      * protected from concurrent access across different nodes in the distributed system.
  98      * The lock guarantees that only one instance of the application can populate or modify the
  99      * module sync work queue at a time, preventing race conditions and potential data inconsistencies.
 100      * The lock is obtained using the Hazelcast CP Subsystem's {@link Lock}, which provides
 101      * strong consistency guarantees for distributed operations.
 102      *
 103      * @return a {@link Lock} instance used for synchronizing access to the work queue.
 104      */
 105     @Bean
 106     public Lock workQueueLock() {
 107         // TODO Method below does not use commonQueueConfig for creating lock (Refactor later)
 108         return getOrCreateHazelcastInstance(commonQueueConfig).getCPSubsystem().getLock(LOCK_NAME_FOR_WORK_QUEUE);
 109     }
 110 }