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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.so.adapters.vnfmadapter.extclients.vnfm;
23 import java.security.GeneralSecurityException;
24 import java.util.ArrayList;
25 import java.util.List;
27 import org.apache.commons.lang3.tuple.ImmutablePair;
28 import org.onap.aai.domain.yang.EsrSystemInfo;
29 import org.onap.so.adapters.vnfmadapter.VnfmAdapterUrlProvider;
30 import org.onap.so.adapters.vnfmadapter.extclients.aai.AaiServiceProvider;
31 import org.onap.so.adapters.vnfmadapter.extclients.vim.model.AccessInfo;
32 import org.onap.so.adapters.vnfmadapter.extclients.vim.model.InterfaceInfo;
33 import org.onap.so.adapters.vnfmadapter.extclients.vim.model.VimCredentials;
34 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.grant.model.InlineResponse201VimConnections;
35 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.InstantiateVnfRequest;
36 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.LccnSubscriptionRequest;
37 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsAuthentication;
38 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsAuthentication.AuthTypeEnum;
39 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsAuthenticationParamsBasic;
40 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsAuthenticationParamsOauth2ClientCredentials;
41 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsFilter;
42 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsFilter.NotificationTypesEnum;
43 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.SubscriptionsFilterVnfInstanceSubscriptionFilter;
44 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.VnfInstancesvnfInstanceIdinstantiateExtVirtualLinks;
45 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo;
46 import org.onap.vnfmadapter.v1.model.CreateVnfRequest;
47 import org.onap.vnfmadapter.v1.model.ExternalVirtualLink;
48 import org.onap.vnfmadapter.v1.model.Tenant;
49 import org.slf4j.Logger;
50 import org.slf4j.LoggerFactory;
51 import org.springframework.beans.factory.annotation.Autowired;
52 import org.springframework.stereotype.Service;
53 import com.google.common.reflect.TypeToken;
54 import com.google.gson.Gson;
55 import com.google.gson.JsonElement;
56 import com.google.gson.JsonObject;
59 * Provides helper methods for interactions with VNFM.
62 public class VnfmHelper {
64 private static final Logger logger = LoggerFactory.getLogger(VnfmHelper.class);
65 private static final String SEPARATOR = "_";
66 private final AaiServiceProvider aaiServiceProvider;
67 private final VnfmAdapterUrlProvider vnfmAdapterUrlProvider;
70 public VnfmHelper(final AaiServiceProvider aaiServiceProvider,
71 final VnfmAdapterUrlProvider vnfmAdapterUrlProvider) {
72 this.aaiServiceProvider = aaiServiceProvider;
73 this.vnfmAdapterUrlProvider = vnfmAdapterUrlProvider;
77 * Create an {@link InstantiateVnfRequest} to send in an instantiation request to a VNFM.
79 * @param tenant the tenant the request is to be fulfilled on
80 * @param createVnfRequest the request received by the VNFM adapter
82 public InstantiateVnfRequest createInstantiateRequest(final Tenant tenant, final CreateVnfRequest createVnfRequest,
83 final String flavourId) {
84 final InstantiateVnfRequest instantiateVnfRequest = new InstantiateVnfRequest();
85 instantiateVnfRequest.setFlavourId(flavourId);
86 instantiateVnfRequest.setVimConnectionInfo(getVimConnectionInfos(tenant));
88 .setAdditionalParams(getAdditionalParametersAsJsonObject(createVnfRequest.getAdditionalParams()));
89 instantiateVnfRequest.setExtVirtualLinks(getExternalVirtualLinks(createVnfRequest.getExternalVirtualLinks()));
90 createVnfRequest.getExternalVirtualLinks();
91 return instantiateVnfRequest;
94 private List<VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo> getVimConnectionInfos(final Tenant tenant) {
95 final List<VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo> connectionInfos = new ArrayList<>();
96 connectionInfos.add(getVimConnectionInfo(tenant));
97 return connectionInfos;
100 private VnfInstancesvnfInstanceIdinstantiateVimConnectionInfo getVimConnectionInfo(final Tenant tenant) {
101 final EsrSystemInfo esrSystemInfo =
102 aaiServiceProvider.invokeGetCloudRegionEsrSystemInfoList(tenant.getCloudOwner(), tenant.getRegionName())
103 .getEsrSystemInfo().iterator().next();
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;
116 private InterfaceInfo getInterfaceInfo(final String url) {
117 final InterfaceInfo interfaceInfo = new InterfaceInfo();
118 interfaceInfo.setIdentityEndPoint(url);
119 return interfaceInfo;
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());
127 final VimCredentials vimCredentials = new VimCredentials();
128 vimCredentials.setUsername(esrSystemInfo.getUserName());
129 vimCredentials.setPassword(esrSystemInfo.getPassword());
130 accessInfo.setCredentials(vimCredentials);
134 private String createVimId(final String cloudOwner, final String cloudRegion) {
135 return cloudOwner + SEPARATOR + cloudRegion;
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());
146 logger.warn("No additional parameters were specified for the operation");
148 return additionalParametersJsonObject;
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());
163 * Create a {@link LccnSubscriptionRequest} to send in an notification subscription request to a VNFM.
165 * @param the ID of the VNF notifications are required for
166 * @return the request
167 * @throws GeneralSecurityException
169 public LccnSubscriptionRequest createNotificationSubscriptionRequest(final String vnfId)
170 throws GeneralSecurityException {
171 final LccnSubscriptionRequest lccnSubscriptionRequest = new LccnSubscriptionRequest();
172 lccnSubscriptionRequest.setAuthentication(getSubscriptionsAuthentication());
173 lccnSubscriptionRequest.setCallbackUri(vnfmAdapterUrlProvider.getVnfLcmOperationOccurrenceNotificationUrl());
174 final SubscriptionsFilter filter = new SubscriptionsFilter();
175 filter.addNotificationTypesItem(NotificationTypesEnum.VNFLCMOPERATIONOCCURRENCENOTIFICATION);
176 final SubscriptionsFilterVnfInstanceSubscriptionFilter vnfInstanceSubscriptionFilter =
177 new SubscriptionsFilterVnfInstanceSubscriptionFilter();
178 vnfInstanceSubscriptionFilter.addVnfInstanceIdsItem(vnfId);
179 filter.setVnfInstanceSubscriptionFilter(vnfInstanceSubscriptionFilter);
180 lccnSubscriptionRequest.setFilter(filter);
181 return lccnSubscriptionRequest;
184 private SubscriptionsAuthentication getSubscriptionsAuthentication() throws GeneralSecurityException {
185 final SubscriptionsAuthentication authentication = new SubscriptionsAuthentication();
187 final ImmutablePair<String, String> decrypedAuth = vnfmAdapterUrlProvider.getDecryptAuth();
189 final SubscriptionsAuthenticationParamsOauth2ClientCredentials oauthParams =
190 new SubscriptionsAuthenticationParamsOauth2ClientCredentials();
191 oauthParams.setTokenEndpoint(vnfmAdapterUrlProvider.getOauthTokenUrl());
192 oauthParams.clientId(decrypedAuth.getLeft());
193 oauthParams.setClientPassword(decrypedAuth.getRight());
194 authentication.addAuthTypeItem(AuthTypeEnum.OAUTH2_CLIENT_CREDENTIALS);
195 authentication.paramsOauth2ClientCredentials(oauthParams);
197 final SubscriptionsAuthenticationParamsBasic basicAuthParams = new SubscriptionsAuthenticationParamsBasic();
198 basicAuthParams.setUserName(decrypedAuth.getLeft());
199 basicAuthParams.setPassword(decrypedAuth.getRight());
200 authentication.addAuthTypeItem(AuthTypeEnum.BASIC);
201 authentication.paramsBasic(basicAuthParams);
203 authentication.addAuthTypeItem(AuthTypeEnum.TLS_CERT);
204 return authentication;
208 * Get the VIM connections for a tenant
210 * @param tenant the tenant
211 * @return the VIM connections
213 public InlineResponse201VimConnections getVimConnections(final Tenant tenant) {
214 final EsrSystemInfo esrSystemInfo =
215 aaiServiceProvider.invokeGetCloudRegionEsrSystemInfoList(tenant.getCloudOwner(), tenant.getRegionName())
216 .getEsrSystemInfo().iterator().next();
218 final InlineResponse201VimConnections vimConnection = new InlineResponse201VimConnections();
219 vimConnection.setId(createVimId(tenant.getCloudOwner(), tenant.getRegionName()));
220 vimConnection.setVimId(vimConnection.getId());
221 vimConnection.setVimType(esrSystemInfo.getType());
222 vimConnection.setInterfaceInfo(getInterfaceInfo(esrSystemInfo.getServiceUrl()));
223 vimConnection.setAccessInfo(getAccessInfo(esrSystemInfo, tenant.getTenantId()));
224 return vimConnection;