gerrit.onap Code Review - cps.git/blob

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2024-2025 OpenInfra Foundation Europe. All rights reserved.
   4  *  Modifications Copyright (C) 2024 TechMahindra Ltd.
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.ncmp.impl.datajobs.subscription.utils;
  23
  24 import static org.onap.cps.api.parameters.FetchDescendantsOption.OMIT_DESCENDANTS;
  25 import static org.onap.cps.ncmp.impl.datajobs.subscription.models.CmSubscriptionStatus.UNKNOWN;
  26
  27 import java.io.Serializable;
  28 import java.time.OffsetDateTime;
  29 import java.util.ArrayList;
  30 import java.util.Collection;
  31 import java.util.Collections;
  32 import java.util.List;
  33 import java.util.Map;
  34 import lombok.RequiredArgsConstructor;
  35 import lombok.extern.slf4j.Slf4j;
  36 import org.onap.cps.api.CpsDataService;
  37 import org.onap.cps.api.CpsQueryService;
  38 import org.onap.cps.api.model.DataNode;
  39 import org.onap.cps.ncmp.impl.datajobs.subscription.models.CmSubscriptionStatus;
  40 import org.onap.cps.utils.ContentType;
  41 import org.onap.cps.utils.JsonObjectMapper;
  42 import org.springframework.stereotype.Service;
  43
  44 @Slf4j
  45 @Service
  46 @RequiredArgsConstructor
  47 public class CmDataJobSubscriptionPersistenceService {
  48
  49     private static final String DATASPACE = "NCMP-Admin";
  50     private static final String ANCHOR = "cm-data-job-subscriptions";
  51
  52     private static final String PARENT_NODE_XPATH = "/dataJob";
  53     private static final String CPS_PATH_FOR_SUBSCRIPTION_NODE = "//subscription";
  54     private static final String CPS_PATH_TEMPLATE_FOR_SUBSCRIPTIONS_WITH_DATA_NODE_SELECTOR =
  55             CPS_PATH_FOR_SUBSCRIPTION_NODE + "[@dataNodeSelector='%s']";
  56     private static final String CPS_PATH_TEMPLATE_FOR_SUBSCRIPTION_WITH_DATA_JOB_ID =
  57         CPS_PATH_FOR_SUBSCRIPTION_NODE + "/dataJobId[text()='%s']";
  58     private static final String CPS_PATH_TEMPLATE_FOR_INACTIVE_SUBSCRIPTIONS =
  59             CPS_PATH_FOR_SUBSCRIPTION_NODE + "[@status='UNKNOWN' or @status='REJECTED']/dataJobId[text()='%s']";
  60
  61     private final JsonObjectMapper jsonObjectMapper;
  62     private final CpsQueryService cpsQueryService;
  63     private final CpsDataService cpsDataService;
  64
  65     /**
  66      * Check if we have a cm data job subscription for the given data node selector.
  67      *
  68      * @param dataNodeSelector the target of the data job subscription
  69      * @return true if the subscription details has at least one subscriber , otherwise false
  70      */
  71     public boolean hasAtLeastOneSubscription(final String dataNodeSelector) {
  72         return !getSubscriptionIds(dataNodeSelector).isEmpty();
  73     }
  74
  75     /**
  76      * Check if the input is a new subscription ID against ongoing subscriptions.
  77      *
  78      * @param subscriptionId subscription ID
  79      * @return true if subscriptionId is not used in active subscriptions, otherwise false
  80      */
  81     public boolean isNewSubscriptionId(final String subscriptionId) {
  82         final String query = CPS_PATH_TEMPLATE_FOR_SUBSCRIPTION_WITH_DATA_JOB_ID.formatted(subscriptionId);
  83         return cpsQueryService.queryDataNodes(DATASPACE, ANCHOR,
  84             query, OMIT_DESCENDANTS).isEmpty();
  85     }
  86
  87     /**
  88      * Get the ids for the subscriptions for the given data node selector.
  89      *
  90      * @param dataNodeSelector the target of the data job subscription
  91      * @return collection of subscription ids of ongoing cm notification subscription
  92      */
  93     @SuppressWarnings("unchecked")
  94     public Collection<String> getSubscriptionIds(final String dataNodeSelector) {
  95         final String query = CPS_PATH_TEMPLATE_FOR_SUBSCRIPTIONS_WITH_DATA_NODE_SELECTOR.formatted(dataNodeSelector);
  96         final Collection<DataNode> existingNodes =
  97             cpsQueryService.queryDataNodes(DATASPACE, ANCHOR,
  98                 query, OMIT_DESCENDANTS);
  99         if (existingNodes.isEmpty()) {
 100             return Collections.emptyList();
 101         }
 102         return (Collection<String>) existingNodes.iterator().next().getLeaves().get("dataJobId");
 103     }
 104
 105     /**
 106      * Get data node selectors for subscriptions with status UNKNOWN or REJECTED.
 107      *
 108      * @param subscriptionId    subscription ID
 109      * @return                  a list of data node selectors
 110      */
 111     public List<String> getInactiveDataNodeSelectors(final String subscriptionId) {
 112         final String query = CPS_PATH_TEMPLATE_FOR_INACTIVE_SUBSCRIPTIONS.formatted(subscriptionId);
 113         final Collection<DataNode> dataNodes = cpsQueryService.queryDataNodes(DATASPACE, ANCHOR, query,
 114                 OMIT_DESCENDANTS);
 115         final List<String> dataNodeSelectors = new ArrayList<>(dataNodes.size());
 116         for (final DataNode dataNode : dataNodes) {
 117             final String dataNodeSelector = dataNode.getLeaves().get("dataNodeSelector").toString();
 118             dataNodeSelectors.add(dataNodeSelector);
 119         }
 120         return dataNodeSelectors;
 121     }
 122
 123     /**
 124      * Add cm notification data job subscription.
 125      *
 126      * @param subscriptionId   data job subscription id to be added
 127      * @param dataNodeSelector the target of the data job subscription
 128      */
 129     public void add(final String subscriptionId, final String dataNodeSelector) {
 130         final String query = CPS_PATH_TEMPLATE_FOR_SUBSCRIPTIONS_WITH_DATA_NODE_SELECTOR.formatted(dataNodeSelector);
 131         final Collection<DataNode> dataNodes = cpsQueryService.queryDataNodes(DATASPACE, ANCHOR, query,
 132                 OMIT_DESCENDANTS);
 133         if (dataNodes.isEmpty()) {
 134             addNewSubscriptionDetails(subscriptionId, dataNodeSelector);
 135         } else {
 136             final Collection<String> subscriptionIds = getSubscriptionIds(dataNodeSelector);
 137             final String cmSubscriptionStatusName = dataNodes.iterator().next().getLeaves().get("status").toString();
 138             subscriptionIds.add(subscriptionId);
 139             updateSubscriptionDetails(dataNodeSelector, subscriptionIds, cmSubscriptionStatusName);
 140         }
 141     }
 142
 143     /**
 144      * Update status of a subscription.
 145      *
 146      * @param dataNodeSelector     data node selector
 147      * @param cmSubscriptionStatus cm subscription status
 148      */
 149     public void updateCmSubscriptionStatus(final String dataNodeSelector,
 150                                            final CmSubscriptionStatus cmSubscriptionStatus) {
 151         final Collection<String> subscriptionIds = getSubscriptionIds(dataNodeSelector);
 152         updateSubscriptionDetails(dataNodeSelector, subscriptionIds, cmSubscriptionStatus.name());
 153     }
 154
 155     private void addNewSubscriptionDetails(final String subscriptionId,
 156                                            final String dataNodeSelector) {
 157         final Collection<String> newSubscriptionList = Collections.singletonList(subscriptionId);
 158         final String cmSubscriptionStatus = UNKNOWN.name();
 159         final String subscriptionDetailsAsJson = createSubscriptionDetailsAsJson(dataNodeSelector,
 160                 newSubscriptionList, cmSubscriptionStatus);
 161         cpsDataService.saveData(DATASPACE, ANCHOR, subscriptionDetailsAsJson,
 162             OffsetDateTime.now(), ContentType.JSON);
 163     }
 164
 165     private void updateSubscriptionDetails(final String dataNodeSelector, final Collection<String> subscriptionIds,
 166                                            final String cmSubscriptionStatusName) {
 167         final String subscriptionDetailsAsJson = createSubscriptionDetailsAsJson(dataNodeSelector,
 168                 subscriptionIds, cmSubscriptionStatusName);
 169         cpsDataService.updateNodeLeaves(DATASPACE, ANCHOR,
 170                 PARENT_NODE_XPATH, subscriptionDetailsAsJson, OffsetDateTime.now(),
 171             ContentType.JSON);
 172     }
 173
 174     private String createSubscriptionDetailsAsJson(final String dataNodeSelector,
 175                                                    final Collection<String> subscriptionIds,
 176                                                    final String cmSubscriptionStatusName) {
 177         final Map<String, Serializable> subscriptionDetailsAsMap =
 178             Map.of("dataNodeSelector", dataNodeSelector,
 179                 "dataJobId", (Serializable) subscriptionIds,
 180                 "status", cmSubscriptionStatusName);
 181         return "{\"subscription\":[" + jsonObjectMapper.asJsonString(subscriptionDetailsAsMap) + "]}";
 182     }
 183 }
 184