1 files changed, 194 insertions, 0 deletions
diff --git a/nokiav2/driver/src/main/java/org/onap/vfc/nfvo/driver/vnfm/svnfm/nokia/onap/core/SelfRegistrationManager.java b/nokiav2/driver/src/main/java/org/onap/vfc/nfvo/driver/vnfm/svnfm/nokia/onap/core/SelfRegistrationManager.java
new file mode 100644
index 00000000..3b2f1d34
--- /dev/null
+++ b/nokiav2/driver/src/main/java/org/onap/vfc/nfvo/driver/vnfm/svnfm/nokia/onap/core/SelfRegistrationManager.java
@@ -0,0 +1,194 @@
+/*
+ * Copyright 2016-2017, Nokia Corporation
+ *
+ * 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.
+ */
+
+package org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.onap.core;
+
+import com.nokia.cbam.lcn.v32.ApiException;
+import com.nokia.cbam.lcn.v32.api.SubscriptionsApi;
+import com.nokia.cbam.lcn.v32.model.*;
+import org.onap.msb.sdk.discovery.common.RouteException;
+import org.onap.msb.sdk.discovery.entity.MicroServiceFullInfo;
+import org.onap.msb.sdk.discovery.entity.MicroServiceInfo;
+import org.onap.msb.sdk.discovery.entity.Node;
+import org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.util.SystemFunctions;
+import org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.vnfm.CbamRestApiProvider;
+import org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.vnfm.DriverProperties;
+import org.slf4j.Logger;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Component;
+
+import java.util.ArrayList;
+import java.util.HashSet;
+
+import static com.nokia.cbam.lcn.v32.model.SubscriptionAuthentication.TypeEnum.NONE;
+import static org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.vnfm.CbamRestApiProvider.NOKIA_LCN_API_VERSION;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Responsible for registering the driver in the core systems.
+ */
+@Component
+public class SelfRegistrationManager {
+    public static final String DRIVER_VERSION = "v1";
+    public static final String SERVICE_NAME = "NokiaSVNFM";
+    // 1 means internal 0 means core :)
+    public static final String INTERNAL_SERVICE = "1";
+    public static final String SWAGGER_API_DEFINITION = "self.swagger.json";
+    private static Logger logger = getLogger(SelfRegistrationManager.class);
+    private final DriverProperties driverProperties;
+    private final MsbApiProvider msbApiProvider;
+    private final CbamRestApiProvider cbamRestApiProvider;
+
+    @Value("${driverMsbExternalIp}")
+    private String driverMsbExternalIp;
+    @Value("${driverVnfmExternalIp}")
+    private String driverVnfmExternalIp;
+    @Value("${server.port}")
+    private String driverPort;
+    private volatile boolean ready = false;
+
+    @Autowired
+    SelfRegistrationManager(DriverProperties driverProperties, MsbApiProvider msbApiProvider, CbamRestApiProvider cbamRestApiProvider) {
+        this.cbamRestApiProvider = cbamRestApiProvider;
+        this.msbApiProvider = msbApiProvider;
+        this.driverProperties = driverProperties;
+    }
+
+    /**
+     * Register the driver in micro-service bus and subscribe to LCNs from CBAM
+     */
+    public void register() {
+        //the order is important (only publish it's existence after the subscription has been created)
+        subscribeToLcn(driverProperties.getVnfmId());
+        try {
+            registerMicroService();
+        } catch (RuntimeException e) {
+            deleteSubscription(driverProperties.getVnfmId());
+            throw e;
+        }
+        ready = true;
+    }
+
+    /**
+     * De-register the VNFM driver from the micro-service bus
+     */
+    public void deRegister() {
+        try {
+            logger.info("Cancelling micro service registration");
+            msbApiProvider.getMsbClient().cancelMicroServiceInfo(SERVICE_NAME, DRIVER_VERSION);
+        } catch (RouteException e) {
+            //ONAP throws 500 internal server error, but deletes the micro service
+            try {
+                MicroServiceFullInfo microServiceFullInfo = msbApiProvider.getMsbClient().queryMicroServiceInfo(SERVICE_NAME, DRIVER_VERSION);
+                logger.error("Unable to deRegister Nokia VNFM driver", e);
+                //the micro service still exists
+                throw new RuntimeException(e);
+            } catch (RouteException e1) {
+                // the micro service was deleted (even though 500 HTTP code was reported)
+            }
+        }
+        deleteSubscription(driverProperties.getVnfmId());
+    }
+
+    /**
+     * @return the swagger API definition
+     */
+    public byte[] getSwaggerApiDefinition() {
+        return SystemFunctions.systemFunctions().loadFile(SWAGGER_API_DEFINITION);
+    }
+
+    private String getDriverVnfmUrl() {
+        return "http://" + driverVnfmExternalIp + ":" + driverPort + DriverProperties.BASE_URL;
+    }
+
+    private void deleteSubscription(String vnfmId) {
+        logger.info("Deleting CBAM LCN subscription");
+        SubscriptionsApi lcnApi = cbamRestApiProvider.getCbamLcnApi(vnfmId);
+        try {
+            String callbackUrl = getDriverVnfmUrl() + DriverProperties.LCN_PATH;
+            for (Subscription subscription : lcnApi.subscriptionsGet(NOKIA_LCN_API_VERSION)) {
+                if (subscription.getCallbackUrl().equals(callbackUrl)) {
+                    lcnApi.subscriptionsSubscriptionIdDelete(subscription.getId(), NOKIA_LCN_API_VERSION);
+                }
+            }
+        } catch (ApiException e) {
+            logger.error("Unable to delete CBAM LCN subscription");
+            throw new RuntimeException(e);
+        }
+    }
+
+    private MicroServiceFullInfo registerMicroService() {
+        logger.info("Registering micro service");
+        MicroServiceInfo microServiceInfo = new MicroServiceInfo();
+        microServiceInfo.setUrl(DriverProperties.BASE_URL);
+        //the PATH should not be set
+        microServiceInfo.setProtocol("REST");
+        microServiceInfo.setVisualRange(INTERNAL_SERVICE);
+        microServiceInfo.setServiceName(SERVICE_NAME);
+        microServiceInfo.setVersion(DRIVER_VERSION);
+        //FIXME set enable_ssl to false after the field has been added to MSB SDK
+        //currently defaults to false, which is good
+        Node node = new Node();
+        microServiceInfo.setNodes(new HashSet<>());
+        microServiceInfo.getNodes().add(node);
+        node.setIp(driverMsbExternalIp);
+        node.setPort(driverPort);
+        node.setTtl("0");
+        try {
+            return msbApiProvider.getMsbClient().registerMicroServiceInfo(microServiceInfo);
+        } catch (RouteException e) {
+            logger.error("Unable to register Nokia VNFM driver", e);
+            throw new RuntimeException(e);
+        }
+    }
+
+    private void subscribeToLcn(String vnfmId) {
+        String callbackUrl = getDriverVnfmUrl() + DriverProperties.LCN_PATH;
+        logger.info("Subscribing to CBAM LCN " + driverProperties.getCbamLcnUrl() + " with callback to " + callbackUrl);
+        SubscriptionsApi lcnApi = cbamRestApiProvider.getCbamLcnApi(vnfmId);
+        try {
+            for (Subscription subscription : lcnApi.subscriptionsGet(NOKIA_LCN_API_VERSION)) {
+                if (subscription.getCallbackUrl().equals(callbackUrl)) {
+                    return;
+                }
+            }
+            CreateSubscriptionRequest request = new CreateSubscriptionRequest();
+            request.setFilter(new SubscriptionFilter());
+            request.getFilter().setNotificationTypes(new ArrayList<>());
+            request.getFilter().getNotificationTypes().add(VnfNotificationType.VNFLIFECYCLECHANGENOTIFICATION);
+            request.setCallbackUrl(callbackUrl);
+            request.getFilter().addOperationTypesItem(OperationType.HEAL);
+            request.getFilter().addOperationTypesItem(OperationType.INSTANTIATE);
+            request.getFilter().addOperationTypesItem(OperationType.SCALE);
+            request.getFilter().addOperationTypesItem(OperationType.TERMINATE);
+            SubscriptionAuthentication subscriptionAuthentication = new SubscriptionAuthentication();
+            subscriptionAuthentication.setType(NONE);//FIXME improve authentication
+            request.setAuthentication(subscriptionAuthentication);
+            lcnApi.subscriptionsPost(request, NOKIA_LCN_API_VERSION);
+        } catch (ApiException e) {
+            logger.error("Unable to subscribe to CBAM LCN", e);
+            throw new RuntimeException(e);
+        }
+    }
+
+    /**
+     * @return is the component ready to serve requests
+     */
+    public boolean isReady() {
+        return ready;
+    }
+}