DMI Plugins respond back to NCMP Events Schema

- Introduced Cloud Events for Subscription Response
- Created SubscriptionEventResponseMapper
- Created CloudEventContructionException for DMI
- Modified Folder Structure for Subscriptions

Issue-ID: CPS-1738
Signed-off-by: seanbeirne <sean.beirne@est.tech>
Change-Id: I242926fb3e6ceb8e6a6ca23bfbd794feacdeaf20

6 files changed, 245 insertions, 150 deletions

diff --git a/src/main/java/org/onap/cps/ncmp/dmi/config/kafka/KafkaConfig.java b/src/main/java/org/onap/cps/ncmp/dmi/config/kafka/KafkaConfig.java
index cb617f9e..25ee92ae 100644
--- a/src/main/java/org/onap/cps/ncmp/dmi/config/kafka/KafkaConfig.java
+++ b/src/main/java/org/onap/cps/ncmp/dmi/config/kafka/KafkaConfig.java
@@ -29,6 +29,7 @@ import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Primary;
 import org.springframework.kafka.annotation.EnableKafka;
+import org.springframework.kafka.config.ConcurrentKafkaListenerContainerFactory;
 import org.springframework.kafka.core.ConsumerFactory;
 import org.springframework.kafka.core.DefaultKafkaConsumerFactory;
 import org.springframework.kafka.core.DefaultKafkaProducerFactory;
@@ -124,4 +125,18 @@ public class KafkaConfig<T> {
         return kafkaTemplate;
     }
 
+    /**
+     * A cloud Kafka event template for executing high-level operations. The cloud producer factory ensure this.
+     *
+     * @return an instance of cloud Kafka template.
+     */
+    @Bean
+    public ConcurrentKafkaListenerContainerFactory<String, CloudEvent>
+        cloudEventConcurrentKafkaListenerContainerFactory() {
+        final ConcurrentKafkaListenerContainerFactory<String, CloudEvent> containerFactory =
+            new ConcurrentKafkaListenerContainerFactory<>();
+        containerFactory.setConsumerFactory(cloudEventConsumerFactory());
+        return containerFactory;
+    }
+
 }
diff --git a/src/main/java/org/onap/cps/ncmp/dmi/service/model/SubscriptionEventResponse.java b/src/main/java/org/onap/cps/ncmp/dmi/exception/CloudEventConstructionException.java
index 7666e540..0069aabc 100644
--- a/src/main/java/org/onap/cps/ncmp/dmi/service/model/SubscriptionEventResponse.java
+++ b/src/main/java/org/onap/cps/ncmp/dmi/exception/CloudEventConstructionException.java
@@ -18,19 +18,20 @@
  *  ============LICENSE_END=========================================================
  */
 
-package org.onap.cps.ncmp.dmi.service.model;
+package org.onap.cps.ncmp.dmi.exception;
 
-import com.fasterxml.jackson.annotation.JsonInclude;
-import java.util.Map;
-import lombok.Getter;
-import lombok.Setter;
+public class CloudEventConstructionException extends DmiException {
 
-@JsonInclude(JsonInclude.Include.NON_NULL)
-@Getter
-@Setter
-public class SubscriptionEventResponse {
-    private String clientId;
-    private String subscriptionName;
-    private String dmiName;
-    private Map<String, SubscriptionEventResponseStatus> cmHandleIdToStatus;
+    private static final long serialVersionUID = 7747941311132087621L;
+
+    /**
+     * Constructor.
+     *
+     * @param message the error message
+     * @param details the error details
+     * @param cause   the error cause
+     */
+    public CloudEventConstructionException(final String message, final String details, final Throwable cause) {
+        super(message, details, cause);
+    }
 }
diff --git a/src/main/java/org/onap/cps/ncmp/dmi/notifications/avc/SubscriptionEventConsumer.java b/src/main/java/org/onap/cps/ncmp/dmi/notifications/avc/SubscriptionEventConsumer.java
deleted file mode 100644
index 20949797..00000000
--- a/src/main/java/org/onap/cps/ncmp/dmi/notifications/avc/SubscriptionEventConsumer.java
+++ /dev/null
@@ -1,110 +0,0 @@
-/*
- * ============LICENSE_START=======================================================
- *  Copyright (C) 2023 Nordix Foundation
- *  ================================================================================
- *  Licensed under the Apache License, Version 2.0 (the "License");
- *  you may not use this file except in compliance with the License.
- *  You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the License is distributed on an "AS IS" BASIS,
- *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  See the License for the specific language governing permissions and
- *  limitations under the License.
- *
- *  SPDX-License-Identifier: Apache-2.0
- *  ============LICENSE_END=========================================================
- */
-
-package org.onap.cps.ncmp.dmi.notifications.avc;
-
-import java.util.Date;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import lombok.RequiredArgsConstructor;
-import lombok.extern.slf4j.Slf4j;
-import org.onap.cps.ncmp.dmi.service.model.SubscriptionEventResponse;
-import org.onap.cps.ncmp.dmi.service.model.SubscriptionEventResponseStatus;
-import org.onap.cps.ncmp.event.model.SubscriptionEvent;
-import org.springframework.beans.factory.annotation.Value;
-import org.springframework.kafka.annotation.KafkaListener;
-import org.springframework.kafka.core.KafkaTemplate;
-import org.springframework.kafka.support.KafkaHeaders;
-import org.springframework.messaging.handler.annotation.Header;
-import org.springframework.messaging.handler.annotation.Payload;
-import org.springframework.stereotype.Component;
-
-@Component
-@Slf4j
-@RequiredArgsConstructor
-public class SubscriptionEventConsumer {
-
-    @Value("${app.dmi.avc.subscription-response-topic}")
-    private String cmAvcSubscriptionResponseTopic;
-    @Value("${dmi.service.name}")
-    private String dmiName;
-    private final KafkaTemplate<String, SubscriptionEventResponse> kafkaTemplate;
-
-    /**
-     * Consume the specified event.
-     *
-     * @param subscriptionEvent the event to be consumed
-     */
-    @KafkaListener(topics = "${app.dmi.avc.subscription-topic}",
-            properties = {"spring.json.value.default.type=org.onap.cps.ncmp.event.model.SubscriptionEvent"})
-    public void consumeSubscriptionEvent(@Payload final SubscriptionEvent subscriptionEvent,
-                                         @Header(KafkaHeaders.RECEIVED_MESSAGE_KEY) final String eventKey,
-                                         @Header(KafkaHeaders.RECEIVED_TIMESTAMP) final String timeStampReceived) {
-        final Date dateAndTimeReceived = new Date(Long.parseLong(timeStampReceived));
-        final String subscriptionName = subscriptionEvent.getEvent().getSubscription().getName();
-        log.info("Subscription for SubscriptionName {} is received at {} by dmi plugin.", subscriptionName,
-                dateAndTimeReceived);
-        sendSubscriptionResponseMessage(eventKey, formSubscriptionEventResponse(subscriptionEvent));
-    }
-
-    /**
-     * Sends message to the configured topic.
-     *
-     * @param eventKey is the kafka message key
-     * @param subscriptionEventResponse is the payload of the kafka message
-     */
-    public void sendSubscriptionResponseMessage(final String eventKey,
-                                                final SubscriptionEventResponse subscriptionEventResponse) {
-        kafkaTemplate.send(cmAvcSubscriptionResponseTopic, eventKey, subscriptionEventResponse);
-    }
-
-    private SubscriptionEventResponse formSubscriptionEventResponse(final SubscriptionEvent subscriptionEvent) {
-        final SubscriptionEventResponse subscriptionEventResponse = new SubscriptionEventResponse();
-        subscriptionEventResponse.setClientId(subscriptionEvent.getEvent().getSubscription().getClientID());
-        subscriptionEventResponse.setSubscriptionName(subscriptionEvent.getEvent().getSubscription().getName());
-        subscriptionEventResponse.setDmiName(dmiName);
-        final List<Object> cmHandleIdToCmHandlePropertyMap = subscriptionEvent.getEvent()
-                .getPredicates()
-                .getTargets();
-        subscriptionEventResponse
-                .setCmHandleIdToStatus(populateCmHandleIdToStatus(extractCmHandleIds(cmHandleIdToCmHandlePropertyMap)));
-        return subscriptionEventResponse;
-    }
-
-    private Set<String> extractCmHandleIds(final List<Object> cmHandleIdTocmHandlePropertyMap) {
-        final Set<String> cmHandleIds = new HashSet<>();
-        for (final Object obj: cmHandleIdTocmHandlePropertyMap) {
-            final Map<String, Object> cmHandleIdToPropertiesMap = (Map<String, Object>) obj;
-            cmHandleIds.addAll(cmHandleIdToPropertiesMap.keySet());
-        }
-        return cmHandleIds;
-    }
-
-    private Map<String, SubscriptionEventResponseStatus> populateCmHandleIdToStatus(final Set<String> cmHandleIds) {
-        final Map<String, SubscriptionEventResponseStatus> result = new HashMap<>();
-        for (final String cmHandleId : cmHandleIds) {
-            result.put(cmHandleId, SubscriptionEventResponseStatus.ACCEPTED);
-        }
-        return result;
-    }
-}
diff --git a/src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventConsumer.java b/src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventConsumer.java
new file mode 100644
index 00000000..d7622fae
--- /dev/null
+++ b/src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventConsumer.java
@@ -0,0 +1,123 @@
+/*
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2023 Nordix Foundation
+ *  ================================================================================
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *  ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.ncmp.dmi.notifications.avcsubscription;
+
+import io.cloudevents.CloudEvent;
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.kafka.clients.consumer.ConsumerRecord;
+import org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.Data;
+import org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.SubscriptionEventResponse;
+import org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.SubscriptionStatus;
+import org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.CmHandle;
+import org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.SubscriptionEvent;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.kafka.annotation.KafkaListener;
+import org.springframework.kafka.core.KafkaTemplate;
+import org.springframework.stereotype.Component;
+
+@Component
+@Slf4j
+@RequiredArgsConstructor
+public class SubscriptionEventConsumer {
+
+    @Value("${app.dmi.avc.subscription-response-topic}")
+    private String cmAvcSubscriptionResponseTopic;
+    @Value("${dmi.service.name}")
+    private String dmiName;
+    private final KafkaTemplate<String, CloudEvent> cloudEventKafkaTemplate;
+
+    /**
+     * Consume the specified event.
+     *
+     * @param subscriptionCloudEvent the event to be consumed
+     */
+    @KafkaListener(topics = "${app.dmi.avc.subscription-topic}",
+        containerFactory = "cloudEventConcurrentKafkaListenerContainerFactory")
+    public void consumeSubscriptionEvent(final ConsumerRecord<String, CloudEvent> subscriptionCloudEvent) {
+        final SubscriptionEvent subscriptionEvent =
+            SubscriptionEventResponseMapper.toSubscriptionEvent(subscriptionCloudEvent.value());
+        if (subscriptionEvent != null) {
+            final String eventKey = subscriptionCloudEvent.value().getId();
+            final String subscriptionType = subscriptionCloudEvent.value().getType();
+            if ("subscriptionCreated".equals(subscriptionType)) {
+                sendSubscriptionResponseMessage(eventKey, "subscriptionCreatedStatus",
+                    formSubscriptionEventResponse(subscriptionEvent));
+            }
+        }
+    }
+
+    /**
+     * Sends message to the configured topic.
+     *
+     * @param eventKey is the kafka message key
+     * @param subscriptionType is the type of subscription action
+     * @param subscriptionEventResponse is the payload of the kafka message
+     */
+    public void sendSubscriptionResponseMessage(final String eventKey,
+                                                final String subscriptionType,
+                                                final SubscriptionEventResponse subscriptionEventResponse) {
+        cloudEventKafkaTemplate.send(cmAvcSubscriptionResponseTopic, eventKey,
+            SubscriptionEventResponseMapper.toCloudEvent(subscriptionEventResponse, subscriptionType, dmiName));
+    }
+
+    private SubscriptionEventResponse formSubscriptionEventResponse(final SubscriptionEvent subscriptionEvent) {
+        final SubscriptionEventResponse subscriptionEventResponse = new SubscriptionEventResponse();
+        final Data subscriptionResponseData = new Data();
+        subscriptionResponseData.setClientId(subscriptionEvent.getData().getSubscription().getClientID());
+        subscriptionResponseData.setSubscriptionName(subscriptionEvent.getData().getSubscription().getName());
+        subscriptionResponseData.setDmiName(dmiName);
+
+        final List<CmHandle> cmHandles = subscriptionEvent.getData()
+            .getPredicates().getTargets();
+        subscriptionResponseData
+                .setSubscriptionStatus(
+                    populateSubscriptionStatus(
+                        extractCmHandleIds(cmHandles)));
+        subscriptionEventResponse.setData(subscriptionResponseData);
+        return subscriptionEventResponse;
+    }
+
+    private Set<String> extractCmHandleIds(final List<CmHandle> cmHandles) {
+        final Set<String> cmHandleIds = new HashSet<>();
+
+        for (final CmHandle cmHandle : cmHandles) {
+            cmHandleIds.add(cmHandle.getId());
+        }
+        return cmHandleIds;
+    }
+
+    private List<SubscriptionStatus> populateSubscriptionStatus(final Set<String> cmHandleIds) {
+        final List<SubscriptionStatus> subscriptionStatuses = new ArrayList<>();
+        for (final String cmHandleId : cmHandleIds) {
+            final SubscriptionStatus status = new SubscriptionStatus();
+            status.setId(cmHandleId);
+            status.setStatus(SubscriptionStatus.Status.ACCEPTED);
+            subscriptionStatuses.add(status);
+        }
+        return subscriptionStatuses;
+    }
+
+}
diff --git a/src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventResponseMapper.java b/src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventResponseMapper.java
new file mode 100644
index 00000000..d7609932
--- /dev/null
+++ b/src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventResponseMapper.java
@@ -0,0 +1,93 @@
+/*
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2023 Nordix Foundation
+ *  ================================================================================
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *  SPDX-License-Identifier: Apache-2.0
+ *  ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.ncmp.dmi.notifications.avcsubscription;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.cloudevents.CloudEvent;
+import io.cloudevents.core.CloudEventUtils;
+import io.cloudevents.core.builder.CloudEventBuilder;
+import io.cloudevents.core.data.PojoCloudEventData;
+import io.cloudevents.jackson.PojoCloudEventDataMapper;
+import java.net.URI;
+import java.util.UUID;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.onap.cps.ncmp.dmi.exception.CloudEventConstructionException;
+import org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.SubscriptionEventResponse;
+import org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.SubscriptionEvent;
+
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+@Slf4j
+public class SubscriptionEventResponseMapper {
+
+    private static final ObjectMapper objectMapper = new ObjectMapper();
+
+    /**
+     * Maps CloudEvent object to SubscriptionEvent object.
+     *
+     * @param cloudEvent object
+     * @return SubscriptionEvent deserialized
+     */
+    public static SubscriptionEvent toSubscriptionEvent(final CloudEvent cloudEvent) {
+        final PojoCloudEventData<SubscriptionEvent> deserializedCloudEvent =
+            CloudEventUtils.mapData(cloudEvent,
+                PojoCloudEventDataMapper.from(objectMapper, SubscriptionEvent.class));
+        if (deserializedCloudEvent == null) {
+            log.debug("No data found in the consumed subscription response event");
+            return null;
+        } else {
+            final SubscriptionEvent subscriptionEvent = deserializedCloudEvent.getValue();
+            log.debug("Consuming subscription response event {}", subscriptionEvent);
+            return subscriptionEvent;
+        }
+    }
+
+    /**
+     * Maps SubscriptionEventResponse to a CloudEvent.
+     *
+     * @param subscriptionEventResponse object.
+     * @param subscriptionType String of subscription type.
+     * @param dmiName String of dmiName.
+     * @return CloudEvent built.
+     */
+    public static CloudEvent toCloudEvent(
+        final org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.SubscriptionEventResponse
+            subscriptionEventResponse,
+        final String subscriptionType,
+        final String dmiName) {
+        try {
+            return CloudEventBuilder.v1().withId(UUID.randomUUID().toString())
+                .withSource(URI.create(dmiName))
+                .withType(subscriptionType)
+                .withDataSchema(URI.create("urn:cps:" + SubscriptionEventResponse.class.getName() + ":1.0.0"))
+                .withExtension("correlationid", subscriptionEventResponse.getData().getClientId() + ":"
+                    + subscriptionEventResponse.getData().getSubscriptionName())
+                .withData(objectMapper.writeValueAsBytes(subscriptionEventResponse))
+                .build();
+        } catch (final Exception ex) {
+            throw new CloudEventConstructionException("The Cloud Event could not be constructed", "Invalid object to "
+                + "serialize or required headers is missing", ex);
+        }
+    }
+
+
+}
diff --git a/src/main/java/org/onap/cps/ncmp/dmi/service/model/SubscriptionEventResponseStatus.java b/src/main/java/org/onap/cps/ncmp/dmi/service/model/SubscriptionEventResponseStatus.java
deleted file mode 100644
index 8987ddae..00000000
--- a/src/main/java/org/onap/cps/ncmp/dmi/service/model/SubscriptionEventResponseStatus.java
+++ /dev/null
@@ -1,27 +0,0 @@
-/*
- * ============LICENSE_START=======================================================
- * Copyright (C) 2023 Nordix Foundation
- * ================================================================================
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *       http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.cps.ncmp.dmi.service.model;
-
-public enum SubscriptionEventResponseStatus {
-    ACCEPTED,
-    REJECTED,
-    PENDING
-}