adapters/mso-vnfm-adapter/mso-vnfm-etsi-adapter/src/main/java/org/onap/so/adapters/vnfmadapter/extclients/vnfm/VnfmHelper.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 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
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  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.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.so.adapters.vnfmadapter.extclients.vnfm;
  22
  23 import static org.onap.so.adapters.vnfmadapter.Constants.BASE_URL;
  24 import static org.onap.so.adapters.vnfmadapter.Constants.OPERATION_NOTIFICATION_ENDPOINT;
  25 import com.google.common.reflect.TypeToken;
  26 import com.google.gson.Gson;
  27 import com.google.gson.JsonElement;
  28 import com.google.gson.JsonObject;
  29 import java.security.GeneralSecurityException;
  30 import java.util.ArrayList;
  31 import java.util.List;
  32 import java.util.Map;
  33 import org.onap.aai.domain.yang.EsrSystemInfo;
  34 import org.onap.so.adapters.vnfmadapter.extclients.aai.AaiServiceProvider;
  35 import org.onap.so.adapters.vnfmadapter.extclients.vim.model.AccessInfo;
  36 import org.onap.so.adapters.vnfmadapter.extclients.vim.model.InterfaceInfo;
  37 import org.onap.so.adapters.vnfmadapter.extclients.vim.model.VimCredentials;
  38 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.grant.model.InlineResponse201VimConnections;
  39 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.InstantiateVnfRequest;
  40 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.LccnSubscriptionRequest;
  41 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsAuthentication;
  42 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsAuthentication.AuthTypeEnum;
  43 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsAuthenticationParamsBasic;
  44 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsFilter;
  45 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsFilter.NotificationTypesEnum;
  46 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsFilterVnfInstanceSubscriptionFilter;
  47 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.VnfInstancesvnfInstanceIdinstantiateExtVirtualLinks;
  48 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo;
  49 import org.onap.so.utils.CryptoUtils;
  50 import org.onap.vnfmadapter.v1.model.CreateVnfRequest;
  51 import org.onap.vnfmadapter.v1.model.ExternalVirtualLink;
  52 import org.onap.vnfmadapter.v1.model.Tenant;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55 import org.springframework.beans.factory.annotation.Autowired;
  56 import org.springframework.beans.factory.annotation.Value;
  57 import org.springframework.stereotype.Service;
  58
  59 /**
  60  * Provides helper methods for interactions with VNFM.
  61  */
  62 @Service
  63 public class VnfmHelper {
  64
  65     private static final Logger logger = LoggerFactory.getLogger(VnfmHelper.class);
  66     private static final String SEPARATOR = "_";
  67     private final AaiServiceProvider aaiServiceProvider;
  68
  69     @Value("${vnfmadapter.endpoint}")
  70     private String vnfmAdapterEndoint;
  71
  72     @Value("${vnfmadapter.auth:E39823AAB2739CC654C4E92B52C05BC34149342D0A46451B00CA508C8EDC62242CE4E9DA9445D3C01A3F13}")
  73     private String vnfmAdapterAuth;
  74
  75     @Value("${mso.key}")
  76     private String msoEncryptionKey;
  77
  78     @Autowired
  79     public VnfmHelper(final AaiServiceProvider aaiServiceProvider) {
  80         this.aaiServiceProvider = aaiServiceProvider;
  81     }
  82
  83     /**
  84      * Create an {@link InstantiateVnfRequest} to send in an instantiation request to a VNFM.
  85      *
  86      * @param tenant the tenant the request is to be fulfilled on
  87      * @param createVnfRequest the request received by the VNFM adapter
  88      */
  89     public InstantiateVnfRequest createInstantiateRequest(final Tenant tenant, final CreateVnfRequest createVnfRequest,
  90             final String flavourId) {
  91         final InstantiateVnfRequest instantiateVnfRequest = new InstantiateVnfRequest();
  92         instantiateVnfRequest.setFlavourId(flavourId);
  93         instantiateVnfRequest.setVimConnectionInfo(getVimConnectionInfos(tenant));
  94         instantiateVnfRequest
  95                 .setAdditionalParams(getAdditionalParametersAsJsonObject(createVnfRequest.getAdditionalParams()));
  96         instantiateVnfRequest.setExtVirtualLinks(getExternalVirtualLinks(createVnfRequest.getExternalVirtualLinks()));
  97         createVnfRequest.getExternalVirtualLinks();
  98         return instantiateVnfRequest;
  99     }
 100
 101     private String getFlavourId() {
 102         // TODO read from csar
 103         return "default";
 104     }
 105
 106     private List<VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo> getVimConnectionInfos(final Tenant tenant) {
 107         final List<VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo> connectionInfos = new ArrayList<>();
 108         connectionInfos.add(getVimConnectionInfo(tenant));
 109         return connectionInfos;
 110     }
 111
 112     private VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo getVimConnectionInfo(final Tenant tenant) {
 113         final EsrSystemInfo esrSystemInfo =
 114                 aaiServiceProvider.invokeGetCloudRegionEsrSystemInfoList(tenant.getCloudOwner(), tenant.getRegionName())
 115                         .getEsrSystemInfo().iterator().next();
 116
 117         final VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo vnfInstancesVimConnectionInfo =
 118                 new VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo();
 119         final String vimId = createVimId(tenant.getCloudOwner(), tenant.getRegionName());
 120         vnfInstancesVimConnectionInfo.setId(vimId);
 121         vnfInstancesVimConnectionInfo.setVimId(vimId);
 122         vnfInstancesVimConnectionInfo.setVimType(esrSystemInfo.getType());
 123         vnfInstancesVimConnectionInfo.setInterfaceInfo(getInterfaceInfo(esrSystemInfo.getServiceUrl()));
 124         vnfInstancesVimConnectionInfo.setAccessInfo(getAccessInfo(esrSystemInfo, tenant.getTenantId()));
 125         return vnfInstancesVimConnectionInfo;
 126     }
 127
 128     private InterfaceInfo getInterfaceInfo(final String url) {
 129         final InterfaceInfo interfaceInfo = new InterfaceInfo();
 130         interfaceInfo.setIdentityEndPoint(url);
 131         return interfaceInfo;
 132     }
 133
 134     private AccessInfo getAccessInfo(final EsrSystemInfo esrSystemInfo, final String tenantId) {
 135         final AccessInfo accessInfo = new AccessInfo();
 136         accessInfo.setProjectId(tenantId);
 137         accessInfo.setDomainName(esrSystemInfo.getCloudDomain());
 138
 139         final VimCredentials vimCredentials = new VimCredentials();
 140         vimCredentials.setUsername(esrSystemInfo.getUserName());
 141         vimCredentials.setPassword(esrSystemInfo.getPassword());
 142         accessInfo.setCredentials(vimCredentials);
 143         return accessInfo;
 144     }
 145
 146     private String createVimId(final String cloudOwner, final String cloudRegion) {
 147         return cloudOwner + SEPARATOR + cloudRegion;
 148     }
 149
 150     private JsonObject getAdditionalParametersAsJsonObject(final Map<String, String> additionalParameters) {
 151         final JsonObject additionalParametersJsonObject = new JsonObject();
 152         if (additionalParameters != null) {
 153             for (final Map.Entry<String, JsonElement> item : new Gson().toJsonTree(additionalParameters)
 154                     .getAsJsonObject().entrySet()) {
 155                 additionalParametersJsonObject.add(item.getKey(), item.getValue());
 156             }
 157         } else {
 158             logger.warn("No additional parameters were specified for the operation");
 159         }
 160         return additionalParametersJsonObject;
 161     }
 162
 163     private List<VnfInstancesvnfInstanceIdinstantiateExtVirtualLinks> getExternalVirtualLinks(
 164             final List<ExternalVirtualLink> extVirtualLinks) {
 165         if (extVirtualLinks != null) {
 166             final String extVirtualLinksJsonObject =
 167                     new Gson().toJson(extVirtualLinks, new TypeToken<List<ExternalVirtualLink>>() {}.getType());
 168             return new Gson().fromJson(extVirtualLinksJsonObject,
 169                     new TypeToken<List<VnfInstancesvnfInstanceIdinstantiateExtVirtualLinks>>() {}.getType());
 170         }
 171         return null;
 172     }
 173
 174     /**
 175      * Create a {@link LccnSubscriptionRequest} to send in an notification subscription request to a VNFM.
 176      *
 177      * @param the ID of the VNF notifications are required for
 178      * @return the request
 179      * @throws GeneralSecurityException
 180      */
 181     public LccnSubscriptionRequest createNotificationSubscriptionRequest(final String vnfId)
 182             throws GeneralSecurityException {
 183         final LccnSubscriptionRequest lccnSubscriptionRequest = new LccnSubscriptionRequest();
 184         lccnSubscriptionRequest.setAuthentication(getSubscriptionsAuthentication());
 185         lccnSubscriptionRequest.setCallbackUri(vnfmAdapterEndoint + BASE_URL + OPERATION_NOTIFICATION_ENDPOINT);
 186         final SubscriptionsFilter filter = new SubscriptionsFilter();
 187         filter.addNotificationTypesItem(NotificationTypesEnum.VNFLCMOPERATIONOCCURRENCENOTIFICATION);
 188         final SubscriptionsFilterVnfInstanceSubscriptionFilter vnfInstanceSubscriptionFilter =
 189                 new SubscriptionsFilterVnfInstanceSubscriptionFilter();
 190         vnfInstanceSubscriptionFilter.addVnfInstanceIdsItem(vnfId);
 191         filter.setVnfInstanceSubscriptionFilter(vnfInstanceSubscriptionFilter);
 192         lccnSubscriptionRequest.setFilter(filter);
 193         return lccnSubscriptionRequest;
 194     }
 195
 196     private SubscriptionsAuthentication getSubscriptionsAuthentication() throws GeneralSecurityException {
 197         final SubscriptionsAuthenticationParamsBasic basicAuthParams = new SubscriptionsAuthenticationParamsBasic();
 198         final String[] decrypedAuth = CryptoUtils.decrypt(vnfmAdapterAuth, msoEncryptionKey).split(":");
 199         basicAuthParams.setUserName(decrypedAuth[0]);
 200         basicAuthParams.setPassword(decrypedAuth[1]);
 201
 202         final SubscriptionsAuthentication authentication = new SubscriptionsAuthentication();
 203         authentication.addAuthTypeItem(AuthTypeEnum.BASIC);
 204         authentication.paramsBasic(basicAuthParams);
 205         return authentication;
 206     }
 207
 208     /**
 209      * Get the VIM connections for a tenant
 210      *
 211      * @param tenant the tenant
 212      * @return the VIM connections
 213      */
 214     public InlineResponse201VimConnections getVimConnections(final Tenant tenant) {
 215         final EsrSystemInfo esrSystemInfo =
 216                 aaiServiceProvider.invokeGetCloudRegionEsrSystemInfoList(tenant.getCloudOwner(), tenant.getRegionName())
 217                         .getEsrSystemInfo().iterator().next();
 218
 219         final InlineResponse201VimConnections vimConnection = new InlineResponse201VimConnections();
 220         vimConnection.setId(createVimId(tenant.getCloudOwner(), tenant.getRegionName()));
 221         vimConnection.setVimId(vimConnection.getId());
 222         vimConnection.setVimType(esrSystemInfo.getType());
 223         vimConnection.setInterfaceInfo(getInterfaceInfo(esrSystemInfo.getServiceUrl()));
 224         vimConnection.setAccessInfo(getAccessInfo(esrSystemInfo, tenant.getTenantId()));
 225         return vimConnection;
 226     }
 227
 228
 229 }