cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/config/embeddedcache/SynchronizationCacheConfig.java

   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.api.impl.config.embeddedcache;
  22
  23 import com.hazelcast.config.MapConfig;
  24 import com.hazelcast.config.QueueConfig;
  25 import com.hazelcast.map.IMap;
  26 import java.util.Set;
  27 import java.util.concurrent.BlockingQueue;
  28 import lombok.extern.slf4j.Slf4j;
  29 import org.onap.cps.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
  48     private static final MapConfig moduleSetTagCacheMapConfig = createMapConfig("moduleSetTagCacheMapConfig");
  49
  50     /**
  51      * Module Sync Distributed Queue Instance.
  52      *
  53      * @return queue of cm handles (data nodes) that need module sync
  54      */
  55     @Bean
  56     public BlockingQueue<DataNode> moduleSyncWorkQueue() {
  57         return createHazelcastInstance("moduleSyncWorkQueue", commonQueueConfig).getQueue("moduleSyncWorkQueue");
  58     }
  59
  60     /**
  61      * Module Sync started (and maybe finished) on cm handles (ids).
  62      *
  63      * @return Map of cm handles (ids) and objects (not used really) for which module sync has started or been completed
  64      */
  65     @Bean
  66     public IMap<String, Object> moduleSyncStartedOnCmHandles() {
  67         return createHazelcastInstance("moduleSyncStartedOnCmHandles", moduleSyncStartedConfig).getMap(
  68                 "moduleSyncStartedOnCmHandles");
  69     }
  70
  71     /**
  72      * Data Sync Distributed Map Instance.
  73      *
  74      * @return configured map of data sync semaphores
  75      */
  76     @Bean
  77     public IMap<String, Boolean> dataSyncSemaphores() {
  78         return createHazelcastInstance("dataSyncSemaphores", dataSyncSemaphoresConfig).getMap("dataSyncSemaphores");
  79     }
  80
  81     /**
  82      * IMap instance for cached ModulesSetTags.
  83      *
  84      * @return configured map of ModuleSetTags
  85      */
  86     @Bean
  87     public IMap<String, Set<String>> moduleSetTagCache() {
  88         return createHazelcastInstance("moduleSetTags", moduleSetTagCacheMapConfig)
  89                 .getMap("moduleSetTagCache");
  90     }
  91 }