cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/events/avcsubscription/SubscriptionEventResponseOutcome.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2023 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.avcsubscription;
  22
  23 import java.io.Serializable;
  24 import java.util.Collection;
  25 import java.util.List;
  26 import java.util.Map;
  27 import lombok.RequiredArgsConstructor;
  28 import lombok.extern.slf4j.Slf4j;
  29 import org.apache.kafka.common.header.Headers;
  30 import org.apache.kafka.common.header.internals.RecordHeaders;
  31 import org.onap.cps.ncmp.api.impl.events.EventsPublisher;
  32 import org.onap.cps.ncmp.api.impl.subscriptions.SubscriptionPersistence;
  33 import org.onap.cps.ncmp.api.impl.subscriptions.SubscriptionStatus;
  34 import org.onap.cps.ncmp.api.impl.utils.DataNodeHelper;
  35 import org.onap.cps.ncmp.api.models.SubscriptionEventResponse;
  36 import org.onap.cps.ncmp.events.avc.subscription.v1.SubscriptionEventOutcome;
  37 import org.onap.cps.spi.model.DataNode;
  38 import org.springframework.beans.factory.annotation.Value;
  39 import org.springframework.stereotype.Component;
  40
  41 @Component
  42 @Slf4j
  43 @RequiredArgsConstructor
  44 public class SubscriptionEventResponseOutcome {
  45
  46     private final SubscriptionPersistence subscriptionPersistence;
  47
  48     private final EventsPublisher<SubscriptionEventOutcome> outcomeEventsPublisher;
  49
  50     private final SubscriptionOutcomeMapper subscriptionOutcomeMapper;
  51
  52     @Value("${app.ncmp.avc.subscription-outcome-topic:cm-avc-subscription-response}")
  53     private String subscriptionOutcomeEventTopic;
  54
  55     /**
  56      * This is for construction of outcome message to be published for client apps.
  57      *
  58      * @param subscriptionClientId client id of the subscription.
  59      * @param subscriptionName name of the subscription.
  60      */
  61     public void sendResponse(final String subscriptionClientId, final String subscriptionName) {
  62         final SubscriptionEventOutcome subscriptionEventOutcome = generateResponse(
  63                 subscriptionClientId, subscriptionName);
  64         final Headers headers = new RecordHeaders();
  65         final String subscriptionEventId = subscriptionClientId + subscriptionName;
  66         outcomeEventsPublisher.publishEvent(subscriptionOutcomeEventTopic,
  67                 subscriptionEventId, headers, subscriptionEventOutcome);
  68     }
  69
  70     private SubscriptionEventOutcome generateResponse(final String subscriptionClientId,
  71                                                       final String subscriptionName) {
  72         final Collection<DataNode> dataNodes =
  73                 subscriptionPersistence.getCmHandlesForSubscriptionEvent(subscriptionClientId, subscriptionName);
  74         final List<Map<String, Serializable>> dataNodeLeaves = DataNodeHelper.getDataNodeLeaves(dataNodes);
  75         final List<Collection<Serializable>> cmHandleIdToStatus =
  76                 DataNodeHelper.getCmHandleIdToStatus(dataNodeLeaves);
  77         final Map<String, SubscriptionStatus> cmHandleIdToStatusMap =
  78                 DataNodeHelper.getCmHandleIdToStatusMap(cmHandleIdToStatus);
  79         return formSubscriptionOutcomeMessage(cmHandleIdToStatus, subscriptionClientId, subscriptionName,
  80                 isFullOutcomeResponse(cmHandleIdToStatusMap));
  81     }
  82
  83     private boolean isFullOutcomeResponse(final Map<String, SubscriptionStatus> cmHandleIdToStatusMap) {
  84         return !cmHandleIdToStatusMap.values().contains(SubscriptionStatus.PENDING);
  85     }
  86
  87     private SubscriptionEventOutcome formSubscriptionOutcomeMessage(
  88             final List<Collection<Serializable>> cmHandleIdToStatus, final String subscriptionClientId,
  89             final String subscriptionName, final boolean isFullOutcomeResponse) {
  90
  91         final SubscriptionEventResponse subscriptionEventResponse = toSubscriptionEventResponse(
  92                 cmHandleIdToStatus, subscriptionClientId, subscriptionName);
  93
  94         final SubscriptionEventOutcome subscriptionEventOutcome =
  95                 subscriptionOutcomeMapper.toSubscriptionEventOutcome(subscriptionEventResponse);
  96
  97         if (isFullOutcomeResponse) {
  98             subscriptionEventOutcome.setEventType(SubscriptionEventOutcome.EventType.COMPLETE_OUTCOME);
  99         } else {
 100             subscriptionEventOutcome.setEventType(SubscriptionEventOutcome.EventType.PARTIAL_OUTCOME);
 101         }
 102
 103         return subscriptionEventOutcome;
 104     }
 105
 106     private SubscriptionEventResponse toSubscriptionEventResponse(
 107             final List<Collection<Serializable>> cmHandleIdToStatus, final String subscriptionClientId,
 108             final String subscriptionName) {
 109         final Map<String, SubscriptionStatus> cmHandleIdToStatusMap =
 110                 DataNodeHelper.getCmHandleIdToStatusMap(cmHandleIdToStatus);
 111
 112         final SubscriptionEventResponse subscriptionEventResponse = new SubscriptionEventResponse();
 113         subscriptionEventResponse.setClientId(subscriptionClientId);
 114         subscriptionEventResponse.setSubscriptionName(subscriptionName);
 115         subscriptionEventResponse.setCmHandleIdToStatus(cmHandleIdToStatusMap);
 116
 117         return subscriptionEventResponse;
 118     }
 119 }