gerrit.onap Code Review - cps.git/blob

   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.impl.cmnotificationsubscription.cache;
  22
  23 import static org.onap.cps.ncmp.impl.cmnotificationsubscription.models.CmSubscriptionStatus.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 java.util.stream.Collectors;
  33 import lombok.RequiredArgsConstructor;
  34 import org.onap.cps.ncmp.api.data.models.DatastoreType;
  35 import org.onap.cps.ncmp.impl.cmnotificationsubscription.models.CmSubscriptionStatus;
  36 import org.onap.cps.ncmp.impl.cmnotificationsubscription.models.DmiCmSubscriptionDetails;
  37 import org.onap.cps.ncmp.impl.cmnotificationsubscription.models.DmiCmSubscriptionPredicate;
  38 import org.onap.cps.ncmp.impl.cmnotificationsubscription.utils.CmSubscriptionPersistenceService;
  39 import org.onap.cps.ncmp.impl.cmnotificationsubscription_1_0_0.client_to_ncmp.Predicate;
  40 import org.onap.cps.ncmp.impl.inventory.InventoryPersistence;
  41 import org.onap.cps.ncmp.impl.inventory.models.YangModelCmHandle;
  42 import org.springframework.stereotype.Component;
  43
  44 @Component
  45 @RequiredArgsConstructor
  46 public class DmiCacheHandler {
  47
  48     private final CmSubscriptionPersistenceService cmSubscriptionPersistenceService;
  49     private final Map<String, Map<String, DmiCmSubscriptionDetails>> cmNotificationSubscriptionCache;
  50     private final InventoryPersistence inventoryPersistence;
  51
  52     /**
  53      * Adds new subscription to the subscription cache.
  54      *
  55      * @param subscriptionId    subscription id
  56      * @param predicates        subscription request predicates
  57      */
  58     public void add(final String subscriptionId, final List<Predicate> predicates) {
  59         cmNotificationSubscriptionCache.put(subscriptionId, createDmiSubscriptionsPerDmi(predicates));
  60     }
  61
  62     /**
  63      * Get cm notification subscription cache entry via subscription id.
  64      *
  65      * @param subscriptionId    subscription id
  66      * @return map of dmi cm notification subscriptions per dmi
  67      */
  68     public Map<String, DmiCmSubscriptionDetails> get(final String subscriptionId) {
  69         return cmNotificationSubscriptionCache.get(subscriptionId);
  70     }
  71
  72
  73     /**
  74      * Remove cache entries with CmNotificationSubscriptionStatus ACCEPTED/REJECTED via subscription id.
  75      *
  76      * @param subscriptionId subscription id as key in CM notification Subscription cache.
  77      */
  78     public void removeAcceptedAndRejectedDmiSubscriptionEntries(final String subscriptionId) {
  79         final Map<String, DmiCmSubscriptionDetails> dmiSubscriptionsPerDmi =
  80                 cmNotificationSubscriptionCache.get(subscriptionId);
  81         final Map<String, DmiCmSubscriptionDetails> updatedDmiSubscriptionsPerDmi =
  82                 dmiSubscriptionsPerDmi.entrySet().stream()
  83                         .filter(dmiCmNotificationSubscription -> !isAcceptedOrRejected(
  84                                 dmiCmNotificationSubscription.getValue()))
  85                         .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
  86         cmNotificationSubscriptionCache.put(subscriptionId, updatedDmiSubscriptionsPerDmi);
  87     }
  88
  89     /**
  90      *  Creates map of subscription details per DMI.
  91      *
  92      * @param predicates    CM Subscription Create Request Predicates
  93      * @return              Map of DmiCmNotificationSubscription per DMI plugin
  94      */
  95     public Map<String, DmiCmSubscriptionDetails> createDmiSubscriptionsPerDmi(
  96             final List<Predicate> predicates) {
  97         final Map<String, DmiCmSubscriptionDetails> dmiSubscriptionsPerDmi =
  98                 new HashMap<>();
  99         for (final Predicate requestPredicate : predicates) {
 100             final List<String> targetFilter = requestPredicate.getTargetFilter();
 101             final DatastoreType datastoreType = DatastoreType.fromDatastoreName(
 102                     requestPredicate.getScopeFilter().getDatastore().toString());
 103             final Set<String> xpaths = new HashSet<>(requestPredicate.getScopeFilter().getXpathFilter());
 104             final Map<String, Set<String>> targetCmHandlesByDmiMap = groupTargetCmHandleIdsByDmi(targetFilter);
 105             for (final Map.Entry<String, Set<String>> targetCmHandlesByDmi: targetCmHandlesByDmiMap.entrySet()) {
 106                 final DmiCmSubscriptionPredicate dmiCmSubscriptionPredicate =
 107                         new DmiCmSubscriptionPredicate(targetCmHandlesByDmi.getValue(),
 108                                 datastoreType, xpaths);
 109                 updateDmiSubscriptionDetailsPerDmi(targetCmHandlesByDmi.getKey(),
 110                         dmiCmSubscriptionPredicate,
 111                         dmiSubscriptionsPerDmi);
 112             }
 113         }
 114         return dmiSubscriptionsPerDmi;
 115     }
 116
 117     /**
 118      *  Update status in map of subscription details per DMI.
 119      *
 120      * @param subscriptionId    String of subscription Id
 121      * @param dmiServiceName    String of dmiServiceName
 122      * @param status            String of status
 123      *
 124      */
 125     public void updateDmiSubscriptionStatusPerDmi(final String subscriptionId, final String dmiServiceName,
 126             final CmSubscriptionStatus status) {
 127         final Map<String, DmiCmSubscriptionDetails> dmiSubscriptionsPerDmi =
 128                 cmNotificationSubscriptionCache.get(subscriptionId);
 129         dmiSubscriptionsPerDmi.get(dmiServiceName).setCmSubscriptionStatus(status);
 130         cmNotificationSubscriptionCache.put(subscriptionId, dmiSubscriptionsPerDmi);
 131     }
 132
 133     /**
 134      *  Persist map of subscription details per DMI.
 135      *
 136      * @param subscriptionId    String of subscription Id
 137      * @param dmiServiceName    String of dmiServiceName
 138      *
 139      */
 140     public void persistIntoDatabasePerDmi(final String subscriptionId, final String dmiServiceName) {
 141         final List<DmiCmSubscriptionPredicate> dmiCmSubscriptionPredicates =
 142                 cmNotificationSubscriptionCache.get(subscriptionId).get(dmiServiceName)
 143                         .getDmiCmSubscriptionPredicates();
 144         for (final DmiCmSubscriptionPredicate dmiCmSubscriptionPredicate : dmiCmSubscriptionPredicates) {
 145             final DatastoreType datastoreType = dmiCmSubscriptionPredicate.getDatastoreType();
 146             final Set<String> cmHandles = dmiCmSubscriptionPredicate.getTargetCmHandleIds();
 147             final Set<String> xpaths = dmiCmSubscriptionPredicate.getXpaths();
 148
 149             for (final String cmHandle: cmHandles) {
 150                 for (final String xpath: xpaths) {
 151                     cmSubscriptionPersistenceService.addCmSubscription(datastoreType, cmHandle,
 152                             xpath, subscriptionId);
 153                 }
 154             }
 155         }
 156     }
 157
 158     /**
 159      *  Remove subscription from database per DMI service name.
 160      *
 161      * @param subscriptionId    String of subscription id
 162      * @param dmiServiceName    String of dmiServiceName
 163      *
 164      */
 165     public void removeFromDatabasePerDmi(final String subscriptionId, final String dmiServiceName) {
 166         final List<DmiCmSubscriptionPredicate> dmiCmSubscriptionPredicates =
 167                 cmNotificationSubscriptionCache.get(subscriptionId).get(dmiServiceName)
 168                         .getDmiCmSubscriptionPredicates();
 169         for (final DmiCmSubscriptionPredicate dmiCmSubscriptionPredicate : dmiCmSubscriptionPredicates) {
 170             final DatastoreType datastoreType = dmiCmSubscriptionPredicate.getDatastoreType();
 171             final Set<String> cmHandles = dmiCmSubscriptionPredicate.getTargetCmHandleIds();
 172             final Set<String> xpaths = dmiCmSubscriptionPredicate.getXpaths();
 173
 174             for (final String cmHandle: cmHandles) {
 175                 for (final String xpath: xpaths) {
 176                     cmSubscriptionPersistenceService.removeCmSubscription(datastoreType,
 177                             cmHandle, xpath, subscriptionId);
 178                 }
 179             }
 180         }
 181     }
 182
 183     private void updateDmiSubscriptionDetailsPerDmi(
 184             final String dmiServiceName,
 185             final DmiCmSubscriptionPredicate dmiCmSubscriptionPredicate,
 186             final Map<String, DmiCmSubscriptionDetails> dmiSubscriptionsPerDmi) {
 187         if (dmiSubscriptionsPerDmi.containsKey(dmiServiceName)) {
 188             dmiSubscriptionsPerDmi.get(dmiServiceName)
 189                     .getDmiCmSubscriptionPredicates().add(dmiCmSubscriptionPredicate);
 190         } else {
 191             dmiSubscriptionsPerDmi.put(dmiServiceName,
 192                     new DmiCmSubscriptionDetails(
 193                             new ArrayList<>(List.of(dmiCmSubscriptionPredicate)),
 194                             PENDING));
 195         }
 196     }
 197
 198     private Map<String, Set<String>> groupTargetCmHandleIdsByDmi(final List<String> targetCmHandleIds) {
 199         final Map<String, Set<String>> targetCmHandlesByDmiServiceNames = new HashMap<>();
 200         final Collection<YangModelCmHandle> yangModelCmHandles =
 201                 inventoryPersistence.getYangModelCmHandles(targetCmHandleIds);
 202
 203         for (final YangModelCmHandle yangModelCmHandle : yangModelCmHandles) {
 204             final String dmiServiceName = yangModelCmHandle.getDmiServiceName();
 205             targetCmHandlesByDmiServiceNames.putIfAbsent(dmiServiceName, new HashSet<>());
 206             targetCmHandlesByDmiServiceNames.get(dmiServiceName).add(yangModelCmHandle.getId());
 207         }
 208         return targetCmHandlesByDmiServiceNames;
 209     }
 210
 211     private boolean isAcceptedOrRejected(final DmiCmSubscriptionDetails dmiCmSubscription) {
 212         return dmiCmSubscription.getCmSubscriptionStatus().toString().equals("ACCEPTED")
 213                        || dmiCmSubscription.getCmSubscriptionStatus().toString().equals("REJECTED");
 214     }
 215 }