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.Config;
  24 import com.hazelcast.config.MapConfig;
  25 import com.hazelcast.config.NamedConfig;
  26 import com.hazelcast.config.QueueConfig;
  27 import com.hazelcast.core.Hazelcast;
  28 import com.hazelcast.core.HazelcastInstance;
  29 import com.hazelcast.map.IMap;
  30 import java.util.concurrent.BlockingQueue;
  31 import org.onap.cps.spi.model.DataNode;
  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 @Configuration
  39 public class SynchronizationCacheConfig {
  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();
  45     private static final MapConfig moduleSyncStartedConfig = createMapConfig("moduleSyncStartedConfig");
  46     private static final MapConfig dataSyncSemaphoresConfig = createMapConfig("dataSyncSemaphoresConfig");
  47
  48     /**
  49      * Module Sync Distributed Queue Instance.
  50      *
  51      * @return queue of cm handles (data nodes) that need module sync
  52      */
  53     @Bean
  54     public BlockingQueue<DataNode> moduleSyncWorkQueue() {
  55         return createHazelcastInstance("moduleSyncWorkQueue", commonQueueConfig)
  56             .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 createHazelcastInstance("moduleSyncStartedOnCmHandles", moduleSyncStartedConfig)
  67             .getMap("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 createHazelcastInstance("dataSyncSemaphores", dataSyncSemaphoresConfig)
  78             .getMap("dataSyncSemaphores");
  79     }
  80
  81     private HazelcastInstance createHazelcastInstance(
  82         final String hazelcastInstanceName, final NamedConfig namedConfig) {
  83         return Hazelcast.newHazelcastInstance(initializeConfig(hazelcastInstanceName, namedConfig));
  84     }
  85
  86     private Config initializeConfig(final String instanceName, final NamedConfig namedConfig) {
  87         final Config config = new Config(instanceName);
  88         if (namedConfig instanceof MapConfig) {
  89             config.addMapConfig((MapConfig) namedConfig);
  90         }
  91         if (namedConfig instanceof QueueConfig) {
  92             config.addQueueConfig((QueueConfig) namedConfig);
  93         }
  94         config.setClusterName("synchronization-caches");
  95         return config;
  96     }
  97
  98     private static QueueConfig createQueueConfig() {
  99         final QueueConfig commonQueueConfig = new QueueConfig("defaultQueueConfig");
 100         commonQueueConfig.setBackupCount(3);
 101         commonQueueConfig.setAsyncBackupCount(3);
 102         return commonQueueConfig;
 103     }
 104
 105     private static MapConfig createMapConfig(final String configName) {
 106         final MapConfig mapConfig = new MapConfig(configName);
 107         mapConfig.setBackupCount(3);
 108         mapConfig.setAsyncBackupCount(3);
 109         return mapConfig;
 110     }
 111
 112 }