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 java.util.stream.Collectors;
  33 import lombok.RequiredArgsConstructor;
  34 import org.onap.cps.ncmp.api.impl.events.cmsubscription.model.CmNotificationSubscriptionStatus;
  35 import org.onap.cps.ncmp.api.impl.events.cmsubscription.model.DmiCmNotificationSubscriptionDetails;
  36 import org.onap.cps.ncmp.api.impl.events.cmsubscription.model.DmiCmNotificationSubscriptionPredicate;
  37 import org.onap.cps.ncmp.api.impl.events.cmsubscription.service.CmNotificationSubscriptionPersistenceService;
  38 import org.onap.cps.ncmp.api.impl.inventory.InventoryPersistence;
  39 import org.onap.cps.ncmp.api.impl.operations.DatastoreType;
  40 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  41 import org.onap.cps.ncmp.events.cmnotificationsubscription_merge1_0_0.client_to_ncmp.Predicate;
  42 import org.springframework.stereotype.Component;
  43
  44 @Component
  45 @RequiredArgsConstructor
  46 public class DmiCmNotificationSubscriptionCacheHandler {
  47
  48     private final CmNotificationSubscriptionPersistenceService cmNotificationSubscriptionPersistenceService;
  49     private final Map<String, Map<String, DmiCmNotificationSubscriptionDetails>> 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, createDmiCmNotificationSubscriptionsPerDmi(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, DmiCmNotificationSubscriptionDetails> 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 removeAcceptedAndRejectedDmiCmNotificationSubscriptionEntries(final String subscriptionId) {
  79         final Map<String, DmiCmNotificationSubscriptionDetails> dmiCmNotificationSubscriptionsPerDmi =
  80                 cmNotificationSubscriptionCache.get(subscriptionId);
  81         final Map<String, DmiCmNotificationSubscriptionDetails> updatedDmiCmNotificationSubscriptionsPerDmi =
  82                 dmiCmNotificationSubscriptionsPerDmi.entrySet().stream().filter(
  83                                 dmiCmNotificationSubscription ->
  84                                         !isAcceptedOrRejected(dmiCmNotificationSubscription.getValue()))
  85                         .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
  86         cmNotificationSubscriptionCache.put(subscriptionId, updatedDmiCmNotificationSubscriptionsPerDmi);
  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, DmiCmNotificationSubscriptionDetails> createDmiCmNotificationSubscriptionsPerDmi(
  96             final List<Predicate> predicates) {
  97         final Map<String, DmiCmNotificationSubscriptionDetails> dmiCmNotificationSubscriptionDetailsPerDmi =
  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 DmiCmNotificationSubscriptionPredicate dmiCmNotificationSubscriptionPredicate =
 107                         new DmiCmNotificationSubscriptionPredicate(targetCmHandlesByDmi.getValue(),
 108                                 datastoreType, xpaths);
 109                 updateDmiCmNotificationSubscriptionDetailsPerDmi(targetCmHandlesByDmi.getKey(),
 110                         dmiCmNotificationSubscriptionPredicate,
 111                         dmiCmNotificationSubscriptionDetailsPerDmi);
 112             }
 113         }
 114         return dmiCmNotificationSubscriptionDetailsPerDmi;
 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 updateDmiCmNotificationSubscriptionStatusPerDmi(final String subscriptionId,
 126                                                                 final String dmiServiceName,
 127                                                                 final CmNotificationSubscriptionStatus status) {
 128         final Map<String, DmiCmNotificationSubscriptionDetails> dmiCmNotificationSubscriptionDetailsPerDmi =
 129                 cmNotificationSubscriptionCache.get(subscriptionId);
 130         dmiCmNotificationSubscriptionDetailsPerDmi.get(dmiServiceName).setCmNotificationSubscriptionStatus(status);
 131         cmNotificationSubscriptionCache.put(subscriptionId, dmiCmNotificationSubscriptionDetailsPerDmi);
 132     }
 133
 134     /**
 135      *  Persist map of subscription details per DMI.
 136      *
 137      * @param subscriptionId    String of subscription Id
 138      * @param dmiServiceName    String of dmiServiceName
 139      *
 140      */
 141     public void persistIntoDatabasePerDmi(final String subscriptionId, final String dmiServiceName) {
 142         final List<DmiCmNotificationSubscriptionPredicate> dmiCmNotificationSubscriptionPredicateList =
 143                 cmNotificationSubscriptionCache.get(subscriptionId).get(dmiServiceName)
 144                         .getDmiCmNotificationSubscriptionPredicates();
 145         for (final DmiCmNotificationSubscriptionPredicate dmiCmNotificationSubscriptionPredicate:
 146                 dmiCmNotificationSubscriptionPredicateList) {
 147             final DatastoreType datastoreType = dmiCmNotificationSubscriptionPredicate.getDatastoreType();
 148             final Set<String> cmHandles = dmiCmNotificationSubscriptionPredicate.getTargetCmHandleIds();
 149             final Set<String> xpaths = dmiCmNotificationSubscriptionPredicate.getXpaths();
 150
 151             for (final String cmHandle: cmHandles) {
 152                 for (final String xpath: xpaths) {
 153                     cmNotificationSubscriptionPersistenceService.addCmNotificationSubscription(datastoreType, cmHandle,
 154                             xpath, subscriptionId);
 155                 }
 156             }
 157         }
 158     }
 159
 160     /**
 161      *  Remove subscription from database per DMI service name.
 162      *
 163      * @param subscriptionId    String of subscription id
 164      * @param dmiServiceName    String of dmiServiceName
 165      *
 166      */
 167     public void removeFromDatabasePerDmi(final String subscriptionId, final String dmiServiceName) {
 168         final List<DmiCmNotificationSubscriptionPredicate> dmiCmNotificationSubscriptionPredicateList =
 169                 cmNotificationSubscriptionCache.get(subscriptionId).get(dmiServiceName)
 170                         .getDmiCmNotificationSubscriptionPredicates();
 171         for (final DmiCmNotificationSubscriptionPredicate dmiCmNotificationSubscriptionPredicate:
 172                 dmiCmNotificationSubscriptionPredicateList) {
 173             final DatastoreType datastoreType = dmiCmNotificationSubscriptionPredicate.getDatastoreType();
 174             final Set<String> cmHandles = dmiCmNotificationSubscriptionPredicate.getTargetCmHandleIds();
 175             final Set<String> xpaths = dmiCmNotificationSubscriptionPredicate.getXpaths();
 176
 177             for (final String cmHandle: cmHandles) {
 178                 for (final String xpath: xpaths) {
 179                     cmNotificationSubscriptionPersistenceService.removeCmNotificationSubscription(datastoreType,
 180                             cmHandle, xpath, subscriptionId);
 181                 }
 182             }
 183         }
 184     }
 185
 186     private void updateDmiCmNotificationSubscriptionDetailsPerDmi(
 187             final String dmiServiceName,
 188             final DmiCmNotificationSubscriptionPredicate dmiCmNotificationSubscriptionPredicate,
 189             final Map<String, DmiCmNotificationSubscriptionDetails> dmiCmNotificationSubscriptionDetailsPerDmi) {
 190         if (dmiCmNotificationSubscriptionDetailsPerDmi.containsKey(dmiServiceName)) {
 191             dmiCmNotificationSubscriptionDetailsPerDmi.get(dmiServiceName)
 192                     .getDmiCmNotificationSubscriptionPredicates().add(dmiCmNotificationSubscriptionPredicate);
 193         } else {
 194             dmiCmNotificationSubscriptionDetailsPerDmi.put(dmiServiceName,
 195                     new DmiCmNotificationSubscriptionDetails(
 196                             new ArrayList<>(List.of(dmiCmNotificationSubscriptionPredicate)),
 197                             PENDING));
 198         }
 199     }
 200
 201     private Map<String, Set<String>> groupTargetCmHandleIdsByDmi(final List<String> targetCmHandleIds) {
 202         final Map<String, Set<String>> targetCmHandlesByDmiServiceNames = new HashMap<>();
 203         final Collection<YangModelCmHandle> yangModelCmHandles =
 204                 inventoryPersistence.getYangModelCmHandles(targetCmHandleIds);
 205
 206         for (final YangModelCmHandle yangModelCmHandle : yangModelCmHandles) {
 207             final String dmiServiceName = yangModelCmHandle.getDmiServiceName();
 208             targetCmHandlesByDmiServiceNames.putIfAbsent(dmiServiceName, new HashSet<>());
 209             targetCmHandlesByDmiServiceNames.get(dmiServiceName).add(yangModelCmHandle.getId());
 210         }
 211         return targetCmHandlesByDmiServiceNames;
 212     }
 213
 214     private boolean isAcceptedOrRejected(
 215             final DmiCmNotificationSubscriptionDetails dmiCmNotificationSubscription) {
 216         return dmiCmNotificationSubscription.getCmNotificationSubscriptionStatus().toString().equals("ACCEPTED")
 217                 || dmiCmNotificationSubscription.getCmNotificationSubscriptionStatus().toString().equals("REJECTED");
 218     }
 219 }