ORAN CMNotify Karaf Feature Development

CMNotify Karaf feature development as part of SDNR
meta-feature. This feature relates to receiving
VES message for nbrListChangeNotification via
DMAAP and making updates to RuntimeDB/ConfigDB

Issue-ID: CCSDK-2130
Signed-off-by: SandeepLinux <Sandeep.Shah@ibm.com>
Change-Id: Iad5f0bfe855986a202a264b50e1a0591c7015fce

4 files changed, 376 insertions, 0 deletions

diff --git a/sdnr/northbound/CMNotify/provider/src/main/java/org/onap/ccsdk/features/sdnr/northbound/CMNotify/CMNotifyClient.java b/sdnr/northbound/CMNotify/provider/src/main/java/org/onap/ccsdk/features/sdnr/northbound/CMNotify/CMNotifyClient.java
new file mode 100644
index 000000000..a098904fc
--- /dev/null
+++ b/sdnr/northbound/CMNotify/provider/src/main/java/org/onap/ccsdk/features/sdnr/northbound/CMNotify/CMNotifyClient.java
@@ -0,0 +1,100 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * openECOMP : SDN-C
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. All rights
+ * 			reserved.
+ * Modifications Copyright (C) 2020 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.ccsdk.features.sdnr.northbound.CMNotify;
+
+import java.util.Properties;
+import org.onap.ccsdk.sli.core.sli.SvcLogicException;
+import org.onap.ccsdk.sli.core.sli.provider.MdsalHelper;
+import org.onap.ccsdk.sli.core.sli.provider.SvcLogicService;
+
+import org.opendaylight.yang.gen.v1.org.onap.ccsdk.rev200224.NbrlistChangeNotificationOutputBuilder;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class CMNotifyClient {
+
+    private static final Logger LOG = LoggerFactory.getLogger(CMNotifyClient.class);
+
+    private SvcLogicService svcLogicService = null;
+
+    public CMNotifyClient(final SvcLogicService svcLogicService) {
+        this.svcLogicService = svcLogicService;
+    }
+
+    public boolean hasGraph(String module, String rpc, String version, String mode) throws SvcLogicException {
+        return svcLogicService.hasGraph(module, rpc, version, mode);
+    }
+
+      // Client for NbrlistChangeNotification
+
+    public Properties execute(String module, String rpc, String version, String mode,
+            NbrlistChangeNotificationOutputBuilder serviceData) throws SvcLogicException {
+
+        Properties parms = new Properties();
+
+        return execute(module, rpc, version, mode, serviceData, parms);
+    }
+
+    public Properties execute(String module, String rpc, String version, String mode,
+            NbrlistChangeNotificationOutputBuilder serviceData, Properties parms) throws SvcLogicException {
+        Properties localProp;
+        localProp = MdsalHelper.toProperties(parms, serviceData);
+
+        if (LOG.isDebugEnabled()) {
+            LOG.debug("Parameters passed to SLI");
+
+            for (Object key : localProp.keySet()) {
+                String parmName = (String) key;
+                String parmValue = localProp.getProperty(parmName);
+
+                LOG.debug(parmName + " = " + parmValue);
+
+            }
+        }
+
+        Properties respProps = svcLogicService.execute(module, rpc, version, mode, localProp);
+
+        if (LOG.isDebugEnabled()) {
+            LOG.debug("Parameters returned by SLI");
+
+            for (Object key : respProps.keySet()) {
+                String parmName = (String) key;
+                String parmValue = respProps.getProperty(parmName);
+
+                LOG.debug(parmName + " = " + parmValue);
+
+            }
+        }
+        if ("failure".equalsIgnoreCase(respProps.getProperty("SvcLogic.status"))) {
+            return respProps;
+        }
+
+        MdsalHelper.toBuilder(respProps, serviceData);
+
+        return respProps;
+    }
+
+
+
+}
diff --git a/sdnr/northbound/CMNotify/provider/src/main/java/org/onap/ccsdk/features/sdnr/northbound/CMNotify/CMNotifyProvider.java b/sdnr/northbound/CMNotify/provider/src/main/java/org/onap/ccsdk/features/sdnr/northbound/CMNotify/CMNotifyProvider.java
new file mode 100644
index 000000000..083b82ee4
--- /dev/null
+++ b/sdnr/northbound/CMNotify/provider/src/main/java/org/onap/ccsdk/features/sdnr/northbound/CMNotify/CMNotifyProvider.java
@@ -0,0 +1,176 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * openECOMP : SDN-C
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. All rights
+ * 			reserved.
+ * Modifications Copyright (C) 2020 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.ccsdk.features.sdnr.northbound.CMNotify;
+
+import com.google.common.util.concurrent.Futures;
+import com.google.common.util.concurrent.ListenableFuture;
+import java.util.Properties;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import org.onap.ccsdk.sli.core.sli.provider.MdsalHelper;
+import org.opendaylight.controller.md.sal.binding.api.DataBroker;
+import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
+import org.opendaylight.controller.sal.binding.api.BindingAwareBroker;
+import org.opendaylight.controller.sal.binding.api.RpcProviderRegistry;
+import org.opendaylight.yang.gen.v1.org.onap.ccsdk.rev200224.CMNOTIFYAPIService;
+import org.opendaylight.yang.gen.v1.org.onap.ccsdk.rev200224.NbrlistChangeNotificationInput;
+import org.opendaylight.yang.gen.v1.org.onap.ccsdk.rev200224.NbrlistChangeNotificationInputBuilder;
+import org.opendaylight.yang.gen.v1.org.onap.ccsdk.rev200224.NbrlistChangeNotificationOutput;
+import org.opendaylight.yang.gen.v1.org.onap.ccsdk.rev200224.NbrlistChangeNotificationOutputBuilder;
+
+import org.opendaylight.yangtools.concepts.Builder;
+import org.opendaylight.yangtools.yang.common.RpcResult;
+import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Defines a base implementation for your provider. This class extends from a helper class which
+ * provides storage for the most commonly used components of the MD-SAL. Additionally the base class
+ * provides some basic logging and initialization / clean up methods.
+ *
+ */
+public class CMNotifyProvider implements AutoCloseable, CMNOTIFYAPIService {
+
+    private static final Logger LOG = LoggerFactory.getLogger(CMNotifyProvider.class);
+
+    private static final String APPLICATION_NAME = "CMNotify-api";
+    private static final String NBRLIST_CHANGE_NOTIFICATION = "nbrlist-change-notification";
+
+
+    private final ExecutorService executor;
+    protected DataBroker dataBroker;
+    protected NotificationPublishService notificationService;
+    protected RpcProviderRegistry rpcRegistry;
+    protected BindingAwareBroker.RpcRegistration<CMNOTIFYAPIService> rpcRegistration;
+    private final CMNotifyClient CMNotifyClient;
+
+    public CMNotifyProvider(final DataBroker dataBroker, final NotificationPublishService notificationPublishService,
+            final RpcProviderRegistry rpcProviderRegistry, final CMNotifyClient CMNotifyClient) {
+
+        LOG.info("Creating provider for {}", APPLICATION_NAME);
+        executor = Executors.newFixedThreadPool(1);
+        this.dataBroker = dataBroker;
+        this.notificationService = notificationPublishService;
+        this.rpcRegistry = rpcProviderRegistry;
+        this.CMNotifyClient = CMNotifyClient;
+        initialize();
+    }
+
+    public void initialize() {
+        LOG.info("Initializing provider for {}", APPLICATION_NAME);
+        rpcRegistration = rpcRegistry.addRpcImplementation(CMNOTIFYAPIService.class, this);
+        LOG.info("Initialization complete for {}", APPLICATION_NAME);
+    }
+
+    protected void initializeChild() {
+        // Override if you have custom initialization intelligence
+    }
+
+    @Override
+    public void close() throws Exception {
+        LOG.info("Closing provider for {}", APPLICATION_NAME);
+        executor.shutdown();
+        rpcRegistration.close();
+        LOG.info("Successfully closed provider for {}", APPLICATION_NAME);
+    }
+
+      // RPC nbrlist-change-notification
+
+    @Override
+    public ListenableFuture<RpcResult<NbrlistChangeNotificationOutput>> nbrlistChangeNotification(NbrlistChangeNotificationInput input) {
+        final String svcOperation = "nbrlist-change-notification";
+
+        Properties parms = new Properties();
+        NbrlistChangeNotificationOutputBuilder serviceDataBuilder = (NbrlistChangeNotificationOutputBuilder) getServiceData(NBRLIST_CHANGE_NOTIFICATION);
+
+        LOG.info("Reached RPC nbrlist-change-notification");
+
+        LOG.info(svcOperation + " called.");
+
+        if (input == null) {
+            LOG.debug("exiting " + svcOperation + " because of invalid input");
+            serviceDataBuilder.setResponseCode("Input is null");
+            RpcResult<NbrlistChangeNotificationOutput> rpcResult =
+                    RpcResultBuilder.<NbrlistChangeNotificationOutput>status(true).withResult(serviceDataBuilder.build()).build();
+            return Futures.immediateFuture(rpcResult);
+        }
+
+        // add input to parms
+        LOG.info("Adding INPUT data for " + svcOperation + " input: " + input);
+        NbrlistChangeNotificationInputBuilder inputBuilder = new NbrlistChangeNotificationInputBuilder(input);
+        MdsalHelper.toProperties(parms, inputBuilder.build());
+
+        LOG.info("Printing SLI parameters to be passed");
+
+        // iterate properties file to get key-value pairs
+        for (String key : parms.stringPropertyNames()) {
+            String value = parms.getProperty(key);
+            LOG.info("The SLI parameter in " + key + " is: " + value);
+        }
+
+        // Call SLI sync method
+        try {
+            if (CMNotifyClient.hasGraph("CM-NOTIFY-API", svcOperation, null, "sync")) {
+                LOG.info("CMNotifyClient has a Directed Graph for '" + svcOperation + "'");
+                try {
+                    CMNotifyClient.execute("CM-NOTIFY-API", svcOperation, null, "sync", serviceDataBuilder, parms);
+                } catch (Exception e) {
+                    LOG.error("Caught exception executing service logic for " + svcOperation, e);
+                    serviceDataBuilder.setResponseCode("500");
+                }
+            } else {
+                LOG.error("No service logic active for CMNotify: '" + svcOperation + "'");
+                serviceDataBuilder.setResponseCode("503");
+            }
+        } catch (Exception e) {
+            LOG.error("Caught exception looking for service logic", e);
+            serviceDataBuilder.setResponseCode("500");
+        }
+
+        String errorCode = serviceDataBuilder.getResponseCode();
+
+        if (!("0".equals(errorCode) || "200".equals(errorCode))) {
+            LOG.error("Returned FAILED for " + svcOperation + " error code: '" + errorCode + "'");
+        } else {
+            LOG.info("Returned SUCCESS for " + svcOperation + " ");
+            serviceDataBuilder.setResponseMessage("CM Notification Executed and RuntimeDB Updated. ");
+        }
+
+        RpcResult<NbrlistChangeNotificationOutput> rpcResult =
+                RpcResultBuilder.<NbrlistChangeNotificationOutput>status(true).withResult(serviceDataBuilder.build()).build();
+
+        LOG.info("Successful exit from nbrlist-change-notification ");
+
+        return Futures.immediateFuture(rpcResult);
+    }
+
+
+    protected Builder<?> getServiceData(String svcOperation) {
+        switch (svcOperation) {
+            case NBRLIST_CHANGE_NOTIFICATION:
+                return new NbrlistChangeNotificationOutputBuilder();
+        }
+        return null;
+    }
+}
diff --git a/sdnr/northbound/CMNotify/provider/src/main/resources/OSGI-INF/blueprint/impl-blueprint.xml b/sdnr/northbound/CMNotify/provider/src/main/resources/OSGI-INF/blueprint/impl-blueprint.xml
new file mode 100644
index 000000000..2edb6a766
--- /dev/null
+++ b/sdnr/northbound/CMNotify/provider/src/main/resources/OSGI-INF/blueprint/impl-blueprint.xml
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ ============LICENSE_START=======================================================
+  ~ ONAP : ccsdk features
+  ~ ================================================================================
+  ~ Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+  ~ ================================================================================
+  ~ 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.
+  ~ ============LICENSE_END=======================================================
+  ~
+  -->
+
+<blueprint xmlns:odl="http://opendaylight.org/xmlns/blueprint/v1.0.0"
+           xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0" odl:use-default-for-reference-types="true">
+
+    <reference id="svcLogicService"
+               interface="org.onap.ccsdk.sli.core.sli.provider.SvcLogicService"/>
+
+    <bean id="client" class="org.onap.ccsdk.features.sdnr.northbound.CMNotify.CMNotifyClient">
+        <argument ref="svcLogicService"/>
+    </bean>
+
+    <reference id="dataBroker" interface="org.opendaylight.controller.md.sal.binding.api.DataBroker"
+               odl:type="default"/>
+
+    <reference id="notificationService"
+               interface="org.opendaylight.controller.md.sal.binding.api.NotificationPublishService"
+               odl:type="default"/>
+
+    <reference id="rpcRegistry" interface="org.opendaylight.controller.sal.binding.api.RpcProviderRegistry"
+               odl:type="default"/>
+
+    <bean id="provider" class="org.onap.ccsdk.features.sdnr.northbound.CMNotify.CMNotifyProvider">
+        <argument ref="dataBroker"/>
+        <argument ref="rpcRegistry"/>
+        <argument ref="notificationService"/>
+        <argument ref="client"/>
+    </bean>
+
+</blueprint>
diff --git a/sdnr/northbound/CMNotify/provider/src/main/resources/org/opendaylight/blueprint/impl-blueprint.xml b/sdnr/northbound/CMNotify/provider/src/main/resources/org/opendaylight/blueprint/impl-blueprint.xml
new file mode 100644
index 000000000..2edb6a766
--- /dev/null
+++ b/sdnr/northbound/CMNotify/provider/src/main/resources/org/opendaylight/blueprint/impl-blueprint.xml
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ ============LICENSE_START=======================================================
+  ~ ONAP : ccsdk features
+  ~ ================================================================================
+  ~ Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+  ~ ================================================================================
+  ~ 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.
+  ~ ============LICENSE_END=======================================================
+  ~
+  -->
+
+<blueprint xmlns:odl="http://opendaylight.org/xmlns/blueprint/v1.0.0"
+           xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0" odl:use-default-for-reference-types="true">
+
+    <reference id="svcLogicService"
+               interface="org.onap.ccsdk.sli.core.sli.provider.SvcLogicService"/>
+
+    <bean id="client" class="org.onap.ccsdk.features.sdnr.northbound.CMNotify.CMNotifyClient">
+        <argument ref="svcLogicService"/>
+    </bean>
+
+    <reference id="dataBroker" interface="org.opendaylight.controller.md.sal.binding.api.DataBroker"
+               odl:type="default"/>
+
+    <reference id="notificationService"
+               interface="org.opendaylight.controller.md.sal.binding.api.NotificationPublishService"
+               odl:type="default"/>
+
+    <reference id="rpcRegistry" interface="org.opendaylight.controller.sal.binding.api.RpcProviderRegistry"
+               odl:type="default"/>
+
+    <bean id="provider" class="org.onap.ccsdk.features.sdnr.northbound.CMNotify.CMNotifyProvider">
+        <argument ref="dataBroker"/>
+        <argument ref="rpcRegistry"/>
+        <argument ref="notificationService"/>
+        <argument ref="client"/>
+    </bean>
+
+</blueprint>