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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.cps.ncmp.api.impl.events.avcsubscription;
23 import com.hazelcast.map.IMap;
24 import io.cloudevents.CloudEvent;
25 import java.util.ArrayList;
26 import java.util.Collection;
27 import java.util.HashSet;
28 import java.util.List;
31 import java.util.concurrent.Executors;
32 import java.util.concurrent.ScheduledExecutorService;
33 import java.util.concurrent.TimeUnit;
34 import java.util.stream.Collectors;
35 import lombok.RequiredArgsConstructor;
36 import lombok.extern.slf4j.Slf4j;
37 import org.onap.cps.ncmp.api.impl.config.embeddedcache.ForwardedSubscriptionEventCacheConfig;
38 import org.onap.cps.ncmp.api.impl.events.EventsPublisher;
39 import org.onap.cps.ncmp.api.impl.subscriptions.SubscriptionPersistence;
40 import org.onap.cps.ncmp.api.impl.subscriptions.SubscriptionStatus;
41 import org.onap.cps.ncmp.api.impl.utils.DmiServiceNameOrganizer;
42 import org.onap.cps.ncmp.api.impl.utils.SubscriptionEventCloudMapper;
43 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
44 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelSubscriptionEvent;
45 import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
46 import org.onap.cps.ncmp.events.avcsubscription1_0_0.client_to_ncmp.SubscriptionEvent;
47 import org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.Data;
48 import org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.SubscriptionEventResponse;
49 import org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.CmHandle;
50 import org.onap.cps.spi.exceptions.OperationNotYetSupportedException;
51 import org.springframework.beans.factory.annotation.Value;
52 import org.springframework.stereotype.Component;
57 @RequiredArgsConstructor
58 public class SubscriptionEventForwarder {
60 private final InventoryPersistence inventoryPersistence;
61 private final EventsPublisher<CloudEvent> eventsPublisher;
62 private final IMap<String, Set<String>> forwardedSubscriptionEventCache;
63 private final SubscriptionEventResponseOutcome subscriptionEventResponseOutcome;
64 private final SubscriptionEventMapper subscriptionEventMapper;
65 private final ClientSubscriptionEventMapper clientSubscriptionEventMapper;
66 private final SubscriptionPersistence subscriptionPersistence;
67 private final ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor();
68 @Value("${app.ncmp.avc.subscription-forward-topic-prefix}")
69 private String dmiAvcSubscriptionTopicPrefix;
71 @Value("${ncmp.timers.subscription-forwarding.dmi-response-timeout-ms:30000}")
72 private int dmiResponseTimeoutInMs;
75 * Forward subscription event.
77 * @param subscriptionEvent the event to be forwarded
79 public void forwardCreateSubscriptionEvent(final SubscriptionEvent subscriptionEvent, final String eventType) {
80 final List<String> cmHandleTargets = subscriptionEvent.getData().getPredicates().getTargets();
81 if (cmHandleTargets == null || cmHandleTargets.isEmpty()
82 || cmHandleTargets.stream().anyMatch(id -> (id).contains("*"))) {
83 throw new OperationNotYetSupportedException(
84 "CMHandle targets are required. \"Wildcard\" operations are not yet supported");
86 final Collection<YangModelCmHandle> yangModelCmHandles =
87 inventoryPersistence.getYangModelCmHandles(cmHandleTargets);
88 final Map<String, Map<String, Map<String, String>>> dmiPropertiesPerCmHandleIdPerServiceName
89 = DmiServiceNameOrganizer.getDmiPropertiesPerCmHandleIdPerServiceName(yangModelCmHandles);
90 findDmisAndRespond(subscriptionEvent, eventType, cmHandleTargets, dmiPropertiesPerCmHandleIdPerServiceName);
93 private void findDmisAndRespond(final SubscriptionEvent subscriptionEvent, final String eventType,
94 final List<String> cmHandleTargetsAsStrings,
95 final Map<String, Map<String, Map<String, String>>>
96 dmiPropertiesPerCmHandleIdPerServiceName) {
97 final SubscriptionEventResponse emptySubscriptionEventResponse =
98 new SubscriptionEventResponse().withData(new Data());
99 emptySubscriptionEventResponse.getData().setSubscriptionName(
100 subscriptionEvent.getData().getSubscription().getName());
101 emptySubscriptionEventResponse.getData().setClientId(
102 subscriptionEvent.getData().getSubscription().getClientID());
103 final List<String> cmHandlesThatExistsInDb = dmiPropertiesPerCmHandleIdPerServiceName.entrySet().stream()
104 .map(Map.Entry::getValue).map(Map::keySet).flatMap(Set::stream).collect(Collectors.toList());
106 final List<String> targetCmHandlesDoesNotExistInDb = new ArrayList<>(cmHandleTargetsAsStrings);
107 targetCmHandlesDoesNotExistInDb.removeAll(cmHandlesThatExistsInDb);
109 final Set<String> dmisToRespond = new HashSet<>(dmiPropertiesPerCmHandleIdPerServiceName.keySet());
111 if (dmisToRespond.isEmpty() || !targetCmHandlesDoesNotExistInDb.isEmpty()) {
112 updatesCmHandlesToRejectedAndPersistSubscriptionEvent(subscriptionEvent, targetCmHandlesDoesNotExistInDb);
114 if (dmisToRespond.isEmpty()) {
115 subscriptionEventResponseOutcome.sendResponse(emptySubscriptionEventResponse,
116 "subscriptionCreatedStatus");
118 startResponseTimeout(emptySubscriptionEventResponse, dmisToRespond);
119 final org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.SubscriptionEvent ncmpSubscriptionEvent =
120 clientSubscriptionEventMapper.toNcmpSubscriptionEvent(subscriptionEvent);
121 forwardEventToDmis(dmiPropertiesPerCmHandleIdPerServiceName, ncmpSubscriptionEvent, eventType);
125 private void startResponseTimeout(final SubscriptionEventResponse emptySubscriptionEventResponse,
126 final Set<String> dmisToRespond) {
127 final String subscriptionClientId = emptySubscriptionEventResponse.getData().getClientId();
128 final String subscriptionName = emptySubscriptionEventResponse.getData().getSubscriptionName();
129 final String subscriptionEventId = subscriptionClientId + subscriptionName;
131 forwardedSubscriptionEventCache.put(subscriptionEventId, dmisToRespond,
132 ForwardedSubscriptionEventCacheConfig.SUBSCRIPTION_FORWARD_STARTED_TTL_SECS, TimeUnit.SECONDS);
133 final ResponseTimeoutTask responseTimeoutTask =
134 new ResponseTimeoutTask(forwardedSubscriptionEventCache, subscriptionEventResponseOutcome,
135 emptySubscriptionEventResponse);
137 executorService.schedule(responseTimeoutTask, dmiResponseTimeoutInMs, TimeUnit.MILLISECONDS);
138 } catch (final RuntimeException ex) {
139 log.info("Caught exception in ScheduledExecutorService for ResponseTimeoutTask. StackTrace: {}",
144 private void forwardEventToDmis(final Map<String, Map<String, Map<String, String>>> dmiNameCmHandleMap,
145 final org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.SubscriptionEvent
146 ncmpSubscriptionEvent, final String eventType) {
147 dmiNameCmHandleMap.forEach((dmiName, cmHandlePropertiesMap) -> {
148 final List<CmHandle> cmHandleTargets = cmHandlePropertiesMap.entrySet().stream().map(
149 cmHandleAndProperties -> {
150 final CmHandle cmHandle = new CmHandle();
151 cmHandle.setId(cmHandleAndProperties.getKey());
152 cmHandle.setAdditionalProperties(cmHandleAndProperties.getValue());
154 }).collect(Collectors.toList());
156 ncmpSubscriptionEvent.getData().getPredicates().setTargets(cmHandleTargets);
157 final String eventKey = createEventKey(ncmpSubscriptionEvent, dmiName);
158 final String dmiAvcSubscriptionTopic = dmiAvcSubscriptionTopicPrefix + dmiName;
160 final CloudEvent ncmpSubscriptionCloudEvent =
161 SubscriptionEventCloudMapper.toCloudEvent(ncmpSubscriptionEvent, eventKey, eventType);
162 eventsPublisher.publishCloudEvent(dmiAvcSubscriptionTopic, eventKey, ncmpSubscriptionCloudEvent);
166 private String createEventKey(
167 final org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.SubscriptionEvent subscriptionEvent,
168 final String dmiName) {
169 return subscriptionEvent.getData().getSubscription().getClientID()
171 + subscriptionEvent.getData().getSubscription().getName()
176 private void updatesCmHandlesToRejectedAndPersistSubscriptionEvent(
177 final SubscriptionEvent subscriptionEvent,
178 final List<String> targetCmHandlesDoesNotExistInDb) {
179 final YangModelSubscriptionEvent yangModelSubscriptionEvent =
180 subscriptionEventMapper.toYangModelSubscriptionEvent(subscriptionEvent);
181 yangModelSubscriptionEvent.getPredicates()
182 .setTargetCmHandles(findRejectedCmHandles(targetCmHandlesDoesNotExistInDb,
183 yangModelSubscriptionEvent));
184 subscriptionPersistence.saveSubscriptionEvent(yangModelSubscriptionEvent);
187 private static List<YangModelSubscriptionEvent.TargetCmHandle> findRejectedCmHandles(
188 final List<String> targetCmHandlesDoesNotExistInDb,
189 final YangModelSubscriptionEvent yangModelSubscriptionEvent) {
190 return yangModelSubscriptionEvent.getPredicates().getTargetCmHandles().stream()
191 .filter(targetCmHandle -> targetCmHandlesDoesNotExistInDb.contains(targetCmHandle.getCmHandleId()))
192 .map(target -> new YangModelSubscriptionEvent.TargetCmHandle(target.getCmHandleId(),
193 SubscriptionStatus.REJECTED, "Targets not found"))
194 .collect(Collectors.toList());