gerrit.onap Code Review - so.git/blob

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