cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/events/cmsubscription/DmiCmNotificationSubscriptionCacheHandler.java

   1 /*
   2  *  ============LICENSE_START=======================================================
   3  *  Copyright (C) 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.api.impl.events.cmsubscription;
  22
  23 import static org.onap.cps.ncmp.api.impl.events.cmsubscription.model.CmNotificationSubscriptionStatus.PENDING;
  24
  25 import java.util.ArrayList;
  26 import java.util.Collection;
  27 import java.util.HashMap;
  28 import java.util.HashSet;
  29 import java.util.List;
  30 import java.util.Map;
  31 import java.util.Set;
  32 import lombok.RequiredArgsConstructor;
  33 import org.onap.cps.ncmp.api.impl.events.cmsubscription.model.CmNotificationSubscriptionStatus;
  34 import org.onap.cps.ncmp.api.impl.events.cmsubscription.model.DmiCmNotificationSubscriptionDetails;
  35 import org.onap.cps.ncmp.api.impl.events.cmsubscription.model.DmiCmNotificationSubscriptionPredicate;
  36 import org.onap.cps.ncmp.api.impl.events.cmsubscription.service.CmNotificationSubscriptionPersistenceService;
  37 import org.onap.cps.ncmp.api.impl.inventory.InventoryPersistence;
  38 import org.onap.cps.ncmp.api.impl.operations.DatastoreType;
  39 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  40 import org.onap.cps.ncmp.events.cmnotificationsubscription_merge1_0_0.client_to_ncmp.Predicate;
  41 import org.springframework.stereotype.Component;
  42
  43 @Component
  44 @RequiredArgsConstructor
  45 public class DmiCmNotificationSubscriptionCacheHandler {
  46
  47     private final CmNotificationSubscriptionPersistenceService cmNotificationSubscriptionPersistenceService;
  48     private final Map<String, Map<String, DmiCmNotificationSubscriptionDetails>> cmNotificationSubscriptionCache;
  49     private final InventoryPersistence inventoryPersistence;
  50
  51     /**
  52      * Adds new subscription to the subscription cache.
  53      *
  54      * @param subscriptionId    subscription Id
  55      * @param predicates        subscription request predicates
  56      */
  57     public void add(final String subscriptionId, final List<Predicate> predicates) {
  58         cmNotificationSubscriptionCache.put(subscriptionId, createDmiCmNotificationSubscriptionsPerDmi(predicates));
  59     }
  60
  61     /**
  62      *  Creates map of subscription details per DMI.
  63      *
  64      * @param predicates    CM Subscription Create Request Predicates
  65      * @return              Map of DmiCmNotificationSubscription per DMI plugin
  66      */
  67     public Map<String, DmiCmNotificationSubscriptionDetails> createDmiCmNotificationSubscriptionsPerDmi(
  68             final List<Predicate> predicates) {
  69         final Map<String, DmiCmNotificationSubscriptionDetails> dmiCmNotificationSubscriptionDetailsPerDmi =
  70                 new HashMap<>();
  71         for (final Predicate requestPredicate : predicates) {
  72             final List<String> targetFilter = requestPredicate.getTargetFilter();
  73             final DatastoreType datastoreType = DatastoreType.fromDatastoreName(
  74                     requestPredicate.getScopeFilter().getDatastore().toString());
  75             final Set<String> xpaths = new HashSet<>(requestPredicate.getScopeFilter().getXpathFilter());
  76             final Map<String, Set<String>> targetCmHandlesByDmiMap = groupTargetCmHandleIdsByDmi(targetFilter);
  77             for (final Map.Entry<String, Set<String>> targetCmHandlesByDmi: targetCmHandlesByDmiMap.entrySet()) {
  78                 final DmiCmNotificationSubscriptionPredicate dmiCmNotificationSubscriptionPredicate =
  79                         new DmiCmNotificationSubscriptionPredicate(targetCmHandlesByDmi.getValue(),
  80                                 datastoreType, xpaths);
  81                 updateDmiCmNotificationSubscriptionDetailsPerDmi(targetCmHandlesByDmi.getKey(),
  82                         dmiCmNotificationSubscriptionPredicate,
  83                         dmiCmNotificationSubscriptionDetailsPerDmi);
  84             }
  85         }
  86         return dmiCmNotificationSubscriptionDetailsPerDmi;
  87     }
  88
  89     /**
  90      *  Update status in map of subscription details per DMI.
  91      *
  92      * @param subscriptionId    String of subscription Id
  93      * @param dmiServiceName    String of dmiServiceName
  94      * @param status            String of status
  95      *
  96      */
  97     public void updateDmiCmNotificationSubscriptionStatusPerDmi(
  98         final String subscriptionId, final String dmiServiceName, final CmNotificationSubscriptionStatus status) {
  99         cmNotificationSubscriptionCache.get(subscriptionId).get(dmiServiceName)
 100             .setCmNotificationSubscriptionStatus(status);
 101     }
 102
 103     /**
 104      *  Persist map of subscription details per DMI.
 105      *
 106      * @param subscriptionId    String of subscription Id
 107      * @param dmiServiceName    String of dmiServiceName
 108      *
 109      */
 110     public void persistIntoDatabasePerDmi(final String subscriptionId, final String dmiServiceName) {
 111         final List<DmiCmNotificationSubscriptionPredicate> dmiCmNotificationSubscriptionPredicateList =
 112             cmNotificationSubscriptionCache.get(subscriptionId).get(dmiServiceName)
 113             .getDmiCmNotificationSubscriptionPredicates();
 114         for (final DmiCmNotificationSubscriptionPredicate dmiCmNotificationSubscriptionPredicate:
 115             dmiCmNotificationSubscriptionPredicateList) {
 116             final DatastoreType datastoreType = dmiCmNotificationSubscriptionPredicate.getDatastoreType();
 117             final Set<String> cmHandles = dmiCmNotificationSubscriptionPredicate.getTargetCmHandleIds();
 118             final Set<String> xpaths = dmiCmNotificationSubscriptionPredicate.getXpaths();
 119
 120             for (final String cmHandle: cmHandles) {
 121                 for (final String xpath: xpaths) {
 122                     cmNotificationSubscriptionPersistenceService.addOrUpdateCmNotificationSubscription(datastoreType,
 123                         cmHandle, xpath, subscriptionId);
 124                 }
 125             }
 126         }
 127     }
 128
 129     private void updateDmiCmNotificationSubscriptionDetailsPerDmi(
 130             final String dmiServiceName,
 131             final DmiCmNotificationSubscriptionPredicate dmiCmNotificationSubscriptionPredicate,
 132             final Map<String, DmiCmNotificationSubscriptionDetails> dmiCmNotificationSubscriptionDetailsPerDmi) {
 133         if (dmiCmNotificationSubscriptionDetailsPerDmi.containsKey(dmiServiceName)) {
 134             dmiCmNotificationSubscriptionDetailsPerDmi.get(dmiServiceName)
 135                     .getDmiCmNotificationSubscriptionPredicates().add(dmiCmNotificationSubscriptionPredicate);
 136         } else {
 137             dmiCmNotificationSubscriptionDetailsPerDmi.put(dmiServiceName,
 138                     new DmiCmNotificationSubscriptionDetails(
 139                             new ArrayList<>(List.of(dmiCmNotificationSubscriptionPredicate)),
 140                             PENDING));
 141         }
 142     }
 143
 144     private Map<String, Set<String>> groupTargetCmHandleIdsByDmi(final List<String> targetCmHandleIds) {
 145         final Map<String, Set<String>> targetCmHandlesByDmiServiceNames = new HashMap<>();
 146         final Collection<YangModelCmHandle> yangModelCmHandles =
 147                 inventoryPersistence.getYangModelCmHandles(targetCmHandleIds);
 148
 149         for (final YangModelCmHandle yangModelCmHandle : yangModelCmHandles) {
 150             final String dmiServiceName = yangModelCmHandle.getDmiServiceName();
 151             targetCmHandlesByDmiServiceNames.putIfAbsent(dmiServiceName, new HashSet<>());
 152             targetCmHandlesByDmiServiceNames.get(dmiServiceName).add(yangModelCmHandle.getId());
 153         }
 154         return targetCmHandlesByDmiServiceNames;
 155     }
 156 }