nokiav2/driver/src/main/java/org/onap/vfc/nfvo/driver/vnfm/svnfm/nokia/onap/core/SelfRegistrationManager.java

   1 /*
   2  * Copyright 2016-2017, Nokia Corporation
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.onap.core;
  18
  19 import com.nokia.cbam.lcn.v32.ApiException;
  20 import com.nokia.cbam.lcn.v32.api.SubscriptionsApi;
  21 import com.nokia.cbam.lcn.v32.model.*;
  22 import org.onap.msb.sdk.discovery.common.RouteException;
  23 import org.onap.msb.sdk.discovery.entity.MicroServiceFullInfo;
  24 import org.onap.msb.sdk.discovery.entity.MicroServiceInfo;
  25 import org.onap.msb.sdk.discovery.entity.Node;
  26 import org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.util.SystemFunctions;
  27 import org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.vnfm.CbamRestApiProvider;
  28 import org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.vnfm.DriverProperties;
  29 import org.slf4j.Logger;
  30 import org.springframework.beans.factory.annotation.Autowired;
  31 import org.springframework.beans.factory.annotation.Value;
  32 import org.springframework.stereotype.Component;
  33
  34 import java.util.ArrayList;
  35 import java.util.HashSet;
  36
  37 import static com.nokia.cbam.lcn.v32.model.SubscriptionAuthentication.TypeEnum.NONE;
  38 import static org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.util.CbamUtils.fatalFailure;
  39 import static org.onap.vfc.nfvo.driver.vnfm.svnfm.nokia.vnfm.CbamRestApiProvider.NOKIA_LCN_API_VERSION;
  40 import static org.slf4j.LoggerFactory.getLogger;
  41
  42 /**
  43  * Responsible for registering the driver in the core systems.
  44  */
  45 @Component
  46 public class SelfRegistrationManager {
  47     public static final String DRIVER_VERSION = "v1";
  48     public static final String SERVICE_NAME = "NokiaSVNFM";
  49     // 1 means internal 0 means core :)
  50     public static final String INTERNAL_SERVICE = "1";
  51     public static final String SWAGGER_API_DEFINITION = "self.swagger.json";
  52     private static Logger logger = getLogger(SelfRegistrationManager.class);
  53     private final DriverProperties driverProperties;
  54     private final MsbApiProvider msbApiProvider;
  55     private final CbamRestApiProvider cbamRestApiProvider;
  56
  57     @Value("${driverMsbExternalIp}")
  58     private String driverMsbExternalIp;
  59     @Value("${driverVnfmExternalIp}")
  60     private String driverVnfmExternalIp;
  61     @Value("${server.port}")
  62     private String driverPort;
  63     private volatile boolean ready = false;
  64
  65     @Autowired
  66     SelfRegistrationManager(DriverProperties driverProperties, MsbApiProvider msbApiProvider, CbamRestApiProvider cbamRestApiProvider) {
  67         this.cbamRestApiProvider = cbamRestApiProvider;
  68         this.msbApiProvider = msbApiProvider;
  69         this.driverProperties = driverProperties;
  70     }
  71
  72     /**
  73      * Register the driver in micro-service bus and subscribe to LCNs from CBAM
  74      */
  75     public void register() {
  76         //the order is important (only publish it's existence after the subscription has been created)
  77         subscribeToLcn(driverProperties.getVnfmId());
  78         try {
  79             registerMicroService();
  80         } catch (RuntimeException e) {
  81             deleteSubscription(driverProperties.getVnfmId());
  82             throw e;
  83         }
  84         ready = true;
  85     }
  86
  87     /**
  88      * De-register the VNFM driver from the micro-service bus
  89      */
  90     public void deRegister() {
  91         try {
  92             logger.info("Cancelling micro service registration");
  93             msbApiProvider.getMsbClient().cancelMicroServiceInfo(SERVICE_NAME, DRIVER_VERSION);
  94         } catch (RouteException e) {
  95             //ONAP throws 500 internal server error, but deletes the micro service
  96             try {
  97                 msbApiProvider.getMsbClient().queryMicroServiceInfo(SERVICE_NAME, DRIVER_VERSION);
  98                 //the micro service still exists
  99                 fatalFailure(logger, "Unable to deRegister Nokia VNFM driver", e);
 100             } catch (RouteException e1) {
 101                 // the micro service was deleted (even though 500 HTTP code was reported)
 102             }
 103         }
 104         deleteSubscription(driverProperties.getVnfmId());
 105     }
 106
 107     /**
 108      * @return the swagger API definition
 109      */
 110     public byte[] getSwaggerApiDefinition() {
 111         return SystemFunctions.systemFunctions().loadFile(SWAGGER_API_DEFINITION);
 112     }
 113
 114     private String getDriverVnfmUrl() {
 115         return "http://" + driverVnfmExternalIp + ":" + driverPort + DriverProperties.BASE_URL;
 116     }
 117
 118     private void deleteSubscription(String vnfmId) {
 119         logger.info("Deleting CBAM LCN subscription");
 120         SubscriptionsApi lcnApi = cbamRestApiProvider.getCbamLcnApi(vnfmId);
 121         try {
 122             String callbackUrl = getDriverVnfmUrl() + DriverProperties.LCN_URL;
 123             for (Subscription subscription : lcnApi.subscriptionsGet(NOKIA_LCN_API_VERSION)) {
 124                 if (subscription.getCallbackUrl().equals(callbackUrl)) {
 125                     lcnApi.subscriptionsSubscriptionIdDelete(subscription.getId(), NOKIA_LCN_API_VERSION);
 126                 }
 127             }
 128         } catch (ApiException e) {
 129             fatalFailure(logger, "Unable to delete CBAM LCN subscription", e);
 130         }
 131     }
 132
 133     private MicroServiceFullInfo registerMicroService() {
 134         logger.info("Registering micro service");
 135         MicroServiceInfo microServiceInfo = new MicroServiceInfo();
 136         microServiceInfo.setUrl(DriverProperties.BASE_URL);
 137         //the PATH should not be set
 138         microServiceInfo.setProtocol("REST");
 139         microServiceInfo.setVisualRange(INTERNAL_SERVICE);
 140         microServiceInfo.setServiceName(SERVICE_NAME);
 141         microServiceInfo.setVersion(DRIVER_VERSION);
 142         //FIXME set enable_ssl to false after the field has been added to MSB SDK
 143         //currently defaults to false, which is good
 144         Node node = new Node();
 145         microServiceInfo.setNodes(new HashSet<>());
 146         microServiceInfo.getNodes().add(node);
 147         node.setIp(driverMsbExternalIp);
 148         node.setPort(driverPort);
 149         node.setTtl("0");
 150         try {
 151             return msbApiProvider.getMsbClient().registerMicroServiceInfo(microServiceInfo);
 152         } catch (RouteException e) {
 153             throw fatalFailure(logger, "Unable to register Nokia VNFM driver", e);
 154         }
 155     }
 156
 157     private void subscribeToLcn(String vnfmId) {
 158         String callbackUrl = getDriverVnfmUrl() + DriverProperties.LCN_URL;
 159         logger.info("Subscribing to CBAM LCN {} with callback to {}", driverProperties.getCbamLcnUrl(), callbackUrl);
 160         SubscriptionsApi lcnApi = cbamRestApiProvider.getCbamLcnApi(vnfmId);
 161         try {
 162             for (Subscription subscription : lcnApi.subscriptionsGet(NOKIA_LCN_API_VERSION)) {
 163                 if (subscription.getCallbackUrl().equals(callbackUrl)) {
 164                     return;
 165                 }
 166             }
 167             CreateSubscriptionRequest request = new CreateSubscriptionRequest();
 168             request.setFilter(new SubscriptionFilter());
 169             request.getFilter().setNotificationTypes(new ArrayList<>());
 170             request.getFilter().getNotificationTypes().add(VnfNotificationType.VNFLIFECYCLECHANGENOTIFICATION);
 171             request.setCallbackUrl(callbackUrl);
 172             request.getFilter().addOperationTypesItem(OperationType.HEAL);
 173             request.getFilter().addOperationTypesItem(OperationType.INSTANTIATE);
 174             request.getFilter().addOperationTypesItem(OperationType.SCALE);
 175             request.getFilter().addOperationTypesItem(OperationType.TERMINATE);
 176             SubscriptionAuthentication subscriptionAuthentication = new SubscriptionAuthentication();
 177             subscriptionAuthentication.setType(NONE);
 178             request.setAuthentication(subscriptionAuthentication);
 179             lcnApi.subscriptionsPost(request, NOKIA_LCN_API_VERSION);
 180         } catch (ApiException e) {
 181             fatalFailure(logger, "Unable to subscribe to CBAM LCN", e);
 182         }
 183     }
 184
 185     /**
 186      * @return is the component ready to serve requests
 187      */
 188     public boolean isReady() {
 189         return ready;
 190     }
 191 }