gerrit.onap Code Review - cps.git/blob

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