2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 - 2019 AT&T Intellectual Property. All rights reserved.
6 * Modifications Copyright (C) 2018 - 2019 Nokia. All rights reserved.
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END=========================================================
21 package org.onap.vid.mso;
23 import static com.fasterxml.jackson.module.kotlin.ExtensionsKt.jacksonObjectMapper;
24 import static java.util.stream.Collectors.collectingAndThen;
25 import static java.util.stream.Collectors.toList;
26 import static org.apache.commons.lang.StringUtils.upperCase;
27 import static org.onap.vid.changeManagement.ChangeManagementRequest.MsoChangeManagementRequest;
28 import static org.onap.vid.controller.MsoController.CONFIGURATION_ID;
29 import static org.onap.vid.controller.MsoController.REQUEST_TYPE;
30 import static org.onap.vid.controller.MsoController.SVC_INSTANCE_ID;
31 import static org.onap.vid.controller.MsoController.VNF_INSTANCE_ID;
32 import static org.onap.vid.controller.MsoController.WORKFLOW_ID;
33 import static org.onap.vid.mso.MsoProperties.MSO_REST_API_CLOUD_RESOURCES_REQUEST_STATUS;
34 import static org.onap.vid.mso.MsoProperties.MSO_REST_API_OPERATIONAL_ENVIRONMENT_ACTIVATE;
35 import static org.onap.vid.mso.MsoProperties.MSO_REST_API_OPERATIONAL_ENVIRONMENT_CREATE;
36 import static org.onap.vid.mso.MsoProperties.MSO_REST_API_OPERATIONAL_ENVIRONMENT_DEACTIVATE;
37 import static org.onap.vid.mso.MsoProperties.MSO_REST_API_WORKFLOW_SPECIFICATIONS;
38 import static org.onap.vid.utils.KotlinUtilsKt.JACKSON_OBJECT_MAPPER;
39 import static org.onap.vid.utils.Logging.debugRequestDetails;
41 import com.fasterxml.jackson.annotation.JsonCreator;
42 import com.fasterxml.jackson.annotation.JsonValue;
43 import com.fasterxml.jackson.databind.DeserializationFeature;
44 import com.fasterxml.jackson.databind.ObjectMapper;
45 import com.google.common.collect.ImmutableList;
46 import com.google.common.collect.ImmutableMap;
47 import io.joshworks.restclient.http.HttpResponse;
48 import java.io.IOException;
49 import java.util.ArrayList;
50 import java.util.Collections;
51 import java.util.HashMap;
52 import java.util.List;
54 import java.util.Objects;
55 import java.util.UUID;
56 import java.util.regex.Pattern;
57 import java.util.stream.Collectors;
58 import java.util.stream.Stream;
59 import javax.ws.rs.BadRequestException;
60 import org.apache.commons.collections4.ListUtils;
61 import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
62 import org.onap.portalsdk.core.util.SystemProperties;
63 import org.onap.vid.aai.ExceptionWithRequestInfo;
64 import org.onap.vid.aai.HttpResponseWithRequestInfo;
65 import org.onap.vid.changeManagement.ChangeManagementRequest;
66 import org.onap.vid.changeManagement.RequestDetailsWrapper;
67 import org.onap.vid.changeManagement.WorkflowRequestDetail;
68 import org.onap.vid.controller.OperationalEnvironmentController;
69 import org.onap.vid.exceptions.GenericUncheckedException;
70 import org.onap.vid.model.SOWorkflowList;
71 import org.onap.vid.model.SoftDeleteRequest;
72 import org.onap.vid.model.probes.ErrorMetadata;
73 import org.onap.vid.model.probes.ExternalComponentStatus;
74 import org.onap.vid.model.probes.HttpRequestMetadata;
75 import org.onap.vid.model.probes.StatusMetadata;
76 import org.onap.vid.mso.model.CloudConfiguration;
77 import org.onap.vid.mso.model.ModelInfo;
78 import org.onap.vid.mso.model.OperationalEnvironmentActivateInfo;
79 import org.onap.vid.mso.model.OperationalEnvironmentDeactivateInfo;
80 import org.onap.vid.mso.model.RequestInfo;
81 import org.onap.vid.mso.model.RequestParameters;
82 import org.onap.vid.mso.rest.OperationalEnvironment.OperationEnvironmentRequestDetails;
83 import org.onap.vid.mso.rest.RelatedInstance;
84 import org.onap.vid.mso.rest.Request;
85 import org.onap.vid.mso.rest.RequestDetails;
86 import org.onap.vid.mso.rest.RequestList;
87 import org.onap.vid.mso.rest.RequestWrapper;
88 import org.onap.vid.mso.rest.Task;
89 import org.onap.vid.mso.rest.TaskList;
90 import org.onap.vid.utils.Logging;
91 import org.springframework.beans.factory.annotation.Autowired;
92 import org.springframework.http.HttpStatus;
94 public class MsoBusinessLogicImpl implements MsoBusinessLogic {
96 static final List<String> DASHBOARD_ALLOWED_TYPES = Stream.of(RequestType.REPLACE_INSTANCE,
97 RequestType.UPDATE_INSTANCE,
98 RequestType.APPLY_UPDATED_CONFIG,
99 RequestType.IN_PLACE_SOFTWARE_UPDATE,
100 RequestType.SCALE_OUT)
101 .map(requestType -> requestType.toString().toUpperCase())
102 .collect(collectingAndThen(toList(), Collections::unmodifiableList));
103 private static final String RESOURCE_TYPE = "resourceType";
104 private static final Pattern SOFTWARE_VERSION_PATTERN = Pattern.compile("^[A-Za-z0-9.\\-]+$");
105 private static final Pattern NUMBER_PATTERN = Pattern.compile("^[0-9]+$");
106 private static final String ACTIVATE = "/activate";
107 private static final String DEACTIVATE = "/deactivate";
108 private static final String ENABLE_PORT = "/enablePort";
109 private static final String DISABLE_PORT = "/disablePort";
110 private static final String ACTIVATE_FABRIC_CONFIGURATION = "/activateFabricConfiguration";
111 private static final String DEACTIVATE_AND_CLOUD_DELETE = "/deactivateAndCloudDelete";
112 private static final String RESOURCE_TYPE_OPERATIONAL_ENVIRONMENT = "operationalEnvironment";
113 private static final String SOURCE_OPERATIONAL_ENVIRONMENT = "VID";
114 private static final ObjectMapper objectMapper = new ObjectMapper();
118 private static final EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(MsoBusinessLogicImpl.class);
120 * The Mso REST client
121 * This should be replaced with mso client factory.
123 private final MsoInterface msoClientInterface;
126 public MsoBusinessLogicImpl(MsoInterface msoClientInterface) {
127 this.msoClientInterface = msoClientInterface;
130 public static String validateEndpointPath(String endpointEnvVariable) {
131 String endpoint = SystemProperties.getProperty(endpointEnvVariable);
132 if (endpoint == null || endpoint.isEmpty()) {
133 throw new GenericUncheckedException(endpointEnvVariable + " env variable is not defined");
138 // this function should get params from tosca and send them to instance at mso, then return success response.
140 public MsoResponseWrapper createSvcInstance(RequestDetails msoRequest) {
141 logInvocationInDebug("createSvcInstance");
143 String endpoint = validateEndpointPath(MsoProperties.MSO_RESTAPI_SERVICE_INSTANCE);
145 return msoClientInterface.createSvcInstance(msoRequest, endpoint);
149 public MsoResponseWrapper createE2eSvcInstance(Object msoRequest) {
150 logInvocationInDebug("createE2eSvcInstance");
151 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_E2E_SVC_INSTANCE);
153 return msoClientInterface.createE2eSvcInstance(msoRequest, endpoint);
157 public MsoResponseWrapper createVnf(RequestDetails requestDetails, String serviceInstanceId) {
158 logInvocationInDebug("createVnf");
160 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_VNF_INSTANCE);
162 String vnfEndpoint = endpoint.replaceFirst(SVC_INSTANCE_ID, serviceInstanceId);
163 return msoClientInterface.createVnf(requestDetails, vnfEndpoint);
167 public MsoResponseWrapper createNwInstance(RequestDetails requestDetails, String serviceInstanceId) {
168 logInvocationInDebug("createNwInstance");
171 endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_NETWORK_INSTANCE);
173 String nwEndpoint = endpoint.replaceFirst(SVC_INSTANCE_ID, serviceInstanceId);
174 return msoClientInterface.createNwInstance(requestDetails, nwEndpoint);
178 public MsoResponseWrapper createVolumeGroupInstance(RequestDetails requestDetails, String serviceInstanceId, String vnfInstanceId) {
179 logInvocationInDebug("createVolumeGroupInstance");
182 endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_VOLUME_GROUP_INSTANCE);
184 String vnfEndpoint = endpoint.replaceFirst(SVC_INSTANCE_ID, serviceInstanceId);
185 vnfEndpoint = vnfEndpoint.replaceFirst(VNF_INSTANCE_ID, vnfInstanceId);
187 return msoClientInterface.createVolumeGroupInstance(requestDetails, vnfEndpoint);
191 public MsoResponseWrapper createVfModuleInstance(RequestDetails requestDetails, String serviceInstanceId, String vnfInstanceId) {
192 logInvocationInDebug("createVfModuleInstance");
194 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_VF_MODULE_INSTANCE);
196 String partialEndpoint = endpoint.replaceFirst(SVC_INSTANCE_ID, serviceInstanceId);
197 String vfModuleEndpoint = partialEndpoint.replaceFirst(VNF_INSTANCE_ID, vnfInstanceId);
199 return msoClientInterface.createVfModuleInstance(requestDetails, vfModuleEndpoint);
203 public MsoResponseWrapper scaleOutVfModuleInstance(org.onap.vid.changeManagement.RequestDetails requestDetails, String serviceInstanceId, String vnfInstanceId) {
204 logInvocationInDebug("scaleOutVfModuleInstance");
206 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_VF_MODULE_SCALE_OUT);
208 String partial_endpoint = endpoint.replaceFirst(SVC_INSTANCE_ID, serviceInstanceId);
209 String vf_module_endpoint = partial_endpoint.replaceFirst(VNF_INSTANCE_ID, vnfInstanceId);
210 RequestDetailsWrapper wrapper = new RequestDetailsWrapper();
211 requestDetails.setVnfName(null);
212 requestDetails.setVnfInstanceId(null);
213 wrapper.requestDetails = requestDetails;
215 return msoClientInterface.scaleOutVFModuleInstance(wrapper, vf_module_endpoint);
219 public MsoResponseWrapper invokeVnfWorkflow(WorkflowRequestDetail request, String userId, UUID serviceInstanceId, UUID vnfInstanceId, UUID workflow_UUID) {
220 logInvocationInDebug("invokeVnfWorkflow");
222 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_WORKFLOW_INSTANCE);
224 String final_endpoint = endpoint
225 .replaceFirst(SVC_INSTANCE_ID, serviceInstanceId.toString())
226 .replaceFirst(WORKFLOW_ID, workflow_UUID.toString())
227 .replaceFirst(VNF_INSTANCE_ID, vnfInstanceId.toString());
229 Map<String,String> extraHeaders = new HashMap<>();
231 UUID requestId = UUID.randomUUID();
232 extraHeaders.put("X-ONAP-RequestID",requestId.toString());
233 extraHeaders.put("X-ONAP-PartnerName","VID");
234 extraHeaders.put("X-RequestorID",userId);
236 return msoClientInterface.invokeWorkflow(request,final_endpoint,extraHeaders);
240 public MsoResponseWrapper createConfigurationInstance(org.onap.vid.mso.rest.RequestDetailsWrapper requestDetailsWrapper, String serviceInstanceId) {
241 logInvocationInDebug("createConfigurationInstance");
243 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_CONFIGURATIONS);
244 endpoint = endpoint.replace(SVC_INSTANCE_ID, serviceInstanceId);
246 return msoClientInterface.createConfigurationInstance(requestDetailsWrapper, endpoint);
250 public MsoResponseWrapper deleteE2eSvcInstance(Object requestDetails, String serviceInstanceId) {
251 logInvocationInDebug("deleteE2eSvcInstance");
253 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_E2E_SVC_INSTANCE) + "/" + serviceInstanceId;
255 return msoClientInterface.deleteE2eSvcInstance(requestDetails, endpoint);
259 public MsoResponseWrapper deleteSvcInstance(RequestDetails requestDetails, String serviceInstanceId, String serviceStatus) {
260 logInvocationInDebug("deleteSvcInstance");
263 endpoint = validateEndpointPath(MsoProperties.MSO_RESTAPI_SERVICE_INSTANCE);
264 if (shouldUnassignService(serviceStatus)){
265 logger.debug(EELFLoggerDelegate.debugLogger, "unassign service");
266 String svcEndpoint = endpoint + "/" + serviceInstanceId + "/unassign";
267 return msoClientInterface.unassignSvcInstance(requestDetails, svcEndpoint);
270 String svcEndpoint = endpoint + "/" + serviceInstanceId;
271 return msoClientInterface.deleteSvcInstance(requestDetails, svcEndpoint);
274 private boolean shouldUnassignService(String serviceStatus) {
275 return ImmutableList.of("created", "pendingdelete", "pending-delete", "assigned").contains(serviceStatus.toLowerCase());
279 public MsoResponseWrapper deleteVnf(RequestDetails requestDetails, String serviceInstanceId, String vnfInstanceId) {
280 logInvocationInDebug("deleteVnf");
282 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_VNF_INSTANCE);
283 String vnfEndpoint = endpoint.replaceFirst(SVC_INSTANCE_ID, serviceInstanceId);
284 vnfEndpoint = vnfEndpoint + '/' + vnfInstanceId;
286 return msoClientInterface.deleteVnf(requestDetails, vnfEndpoint);
290 public MsoResponseWrapper deleteVfModule(RequestDetails requestDetails, String serviceInstanceId, String vnfInstanceId, String vfModuleId) {
291 logInvocationInDebug("deleteVfModule");
293 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_VF_MODULE_INSTANCE);
294 String vfModulesEndpoint = endpoint.replaceFirst(SVC_INSTANCE_ID, serviceInstanceId).replaceFirst(VNF_INSTANCE_ID, vnfInstanceId);
295 String deleteVfEndpoint = vfModulesEndpoint + '/' + vfModuleId;
297 return msoClientInterface.deleteVfModule(requestDetails, deleteVfEndpoint);
301 public MsoResponseWrapper deleteVolumeGroupInstance(RequestDetails requestDetails, String serviceInstanceId, String vnfInstanceId, String volumeGroupId) {
302 logInvocationInDebug("deleteVolumeGroupInstance");
304 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_VOLUME_GROUP_INSTANCE);
305 String svcEndpoint = endpoint.replaceFirst(SVC_INSTANCE_ID, serviceInstanceId);
306 String vnfEndpoint = svcEndpoint.replaceFirst(VNF_INSTANCE_ID, vnfInstanceId);
307 String deleteVolumeGroupEndpoint = vnfEndpoint + "/" + volumeGroupId;
309 return msoClientInterface.deleteVolumeGroupInstance(requestDetails, deleteVolumeGroupEndpoint);
313 public MsoResponseWrapper deleteNwInstance(RequestDetails requestDetails, String serviceInstanceId, String networkInstanceId) {
314 logInvocationInDebug("deleteNwInstance");
316 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_NETWORK_INSTANCE);
317 String svcEndpoint = endpoint.replaceFirst(SVC_INSTANCE_ID, serviceInstanceId);
318 String deleteNwEndpoint = svcEndpoint + "/" + networkInstanceId;
320 return msoClientInterface.deleteNwInstance(requestDetails, deleteNwEndpoint);
324 public MsoResponseWrapper getOrchestrationRequest(String requestId) {
325 String methodName = "getOrchestrationRequest";
326 logInvocationInDebug(methodName);
328 String p = SystemProperties.getProperty(MsoProperties.MSO_REST_API_GET_ORC_REQ);
329 String path = p + "/" + requestId;
331 return msoClientInterface.getOrchestrationRequest(path);
333 } catch (Exception e) {
334 logException(methodName, e);
340 public MsoResponseWrapper getOrchestrationRequests(String filterString) {
341 String methodName = "getOrchestrationRequest";
342 logInvocationInDebug(methodName);
344 String p = SystemProperties.getProperty(MsoProperties.MSO_REST_API_GET_ORC_REQS);
345 String path = p + filterString;
347 return msoClientInterface.getOrchestrationRequest(path);
349 } catch (Exception e) {
350 logException(methodName, e);
356 public List<Request> getOrchestrationRequestsForDashboard() {
357 String methodName = "getOrchestrationRequestsForDashboard";
358 logInvocationInDebug(methodName);
360 List<Request> dashboardOrchestrationReqs = new ArrayList<>();
362 List<RequestWrapper> vnfOrchestrationReqsWrappers = getOrchestrationRequestsByFilter("modelType", "vnf");
363 dashboardOrchestrationReqs = vnfOrchestrationReqsWrappers.stream()
364 .filter(reqWrapper -> Objects.nonNull(reqWrapper.getRequest())
365 && DASHBOARD_ALLOWED_TYPES.contains(upperCase(reqWrapper.getRequest().getRequestType())))
366 .map(RequestWrapper::getRequest)
367 .collect(Collectors.toList());
369 List<RequestWrapper> scaleOutOrchestrationReqWrappers = getOrchestrationRequestsByFilter("action", "scaleOut");
370 List<Request> scaleoutRequests = scaleOutOrchestrationReqWrappers.stream()
371 .filter(reqWrapper -> Objects.nonNull(reqWrapper.getRequest()))
372 .map(RequestWrapper::getRequest)
373 .collect(Collectors.toList());
375 dashboardOrchestrationReqs.addAll(scaleoutRequests);
376 } catch (Exception e) {
377 logException(methodName, e);
380 return dashboardOrchestrationReqs;
383 private String constructOrchestrationRequestFilter(String filterName, String filterValue) {
384 return String.format("%sfilter=%s:EQUALS:%s",
385 SystemProperties.getProperty(MsoProperties.MSO_REST_API_GET_ORC_REQS), filterName, filterValue);
388 private List<RequestWrapper> getOrchestrationRequestsByFilter(String filterName, String filterValue) {
389 HttpResponseWithRequestInfo<String> msoResponseWrapper = getRawOrchestrationRequestsByFilter(filterName, filterValue);
390 return deserializeOrchestrationRequestsJson(msoResponseWrapper.getResponse().getBody());
393 private HttpResponseWithRequestInfo<String> getRawOrchestrationRequestsByFilter(String filterName, String filterValue) {
394 String orchestrationReqPath = constructOrchestrationRequestFilter(filterName, filterValue);
395 return msoClientInterface.getOrchestrationRequest(orchestrationReqPath, true);
398 private List<RequestWrapper> deserializeOrchestrationRequestsJson(String orchestrationRequestsJson) {
399 logInvocationInDebug("deserializeOrchestrationRequestsJson");
401 ObjectMapper mapper = jacksonObjectMapper();
402 mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
403 mapper.configure(DeserializationFeature.READ_ENUMS_USING_TO_STRING, true);
404 RequestList requestList;
406 requestList = mapper.readValue(orchestrationRequestsJson, RequestList.class);
407 } catch (IOException e) {
408 throw new GenericUncheckedException(e);
410 return ListUtils.emptyIfNull(requestList.getRequestList());
415 public List<Task> getManualTasksByRequestId(String originalRequestId) {
416 String methodName = "getManualTasksByRequestId";
417 logInvocationInDebug(methodName);
420 String p = SystemProperties.getProperty(MsoProperties.MSO_REST_API_GET_MAN_TASKS);
421 String path = p + "?originalRequestId=" + originalRequestId;
423 RestObject<String> restObjStr = new RestObject<>();
427 MsoResponseWrapper msoResponseWrapper = msoClientInterface.getManualTasksByRequestId(str, "", path, restObjStr);
428 return deserializeManualTasksJson(msoResponseWrapper.getEntity());
430 } catch (Exception e) {
431 logException(methodName, e);
436 private List<Task> deserializeManualTasksJson(String manualTasksJson) {
437 logInvocationInDebug("deserializeManualTasksJson");
440 TaskList taskList = JACKSON_OBJECT_MAPPER.readValue(manualTasksJson, TaskList.class);
441 return taskList.getTaskList();
442 } catch (IOException e) {
443 throw new GenericUncheckedException(e);
449 public MsoResponseWrapper completeManualTask(RequestDetails requestDetails, String taskId) {
450 String methodName = "completeManualTask";
451 logInvocationInDebug(methodName);
453 String p = SystemProperties.getProperty(MsoProperties.MSO_REST_API_GET_MAN_TASKS);
454 String path = p + "/" + taskId + "/complete";
456 RestObject<String> restObjStr = new RestObject<>();
460 return msoClientInterface.completeManualTask(requestDetails, str, "", path, restObjStr);
462 } catch (Exception e) {
463 logException(methodName, e);
469 public MsoResponseWrapper activateServiceInstance(RequestDetails requestDetails, String serviceInstanceId) {
470 String methodName = "activateServiceInstance";
471 logInvocationInDebug(methodName);
473 String serviceEndpoint = SystemProperties.getProperty(MsoProperties.MSO_RESTAPI_SERVICE_INSTANCE);
474 String activateServicePath = serviceEndpoint + "/" + serviceInstanceId + ACTIVATE;
476 RestObject<String> restObjStr = new RestObject<>();
480 msoClientInterface.setServiceInstanceStatus(requestDetails, activateServicePath);
482 return MsoUtil.wrapResponse(restObjStr);
484 } catch (Exception e) {
485 logException(methodName, e);
492 public MsoResponseWrapperInterface updateVnf(org.onap.vid.changeManagement.RequestDetails requestDetails, String serviceInstanceId, String vnfInstanceId) {
493 logInvocationInDebug("updateVnf");
496 endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_VNF_INSTANCE);
497 String vnfEndpoint = endpoint.replaceFirst(SVC_INSTANCE_ID, serviceInstanceId);
498 vnfEndpoint = vnfEndpoint + '/' + vnfInstanceId;
499 return msoClientInterface.updateVnf(requestDetails, vnfEndpoint);
503 public MsoResponseWrapperInterface replaceVnf(org.onap.vid.changeManagement.RequestDetails requestDetails, String serviceInstanceId, String vnfInstanceId) {
504 logInvocationInDebug("replaceVnf");
506 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_VNF_CHANGE_MANAGEMENT_INSTANCE);
507 String vnfEndpoint = endpoint.replaceFirst(SVC_INSTANCE_ID, serviceInstanceId);
508 vnfEndpoint = vnfEndpoint.replace(VNF_INSTANCE_ID, vnfInstanceId);
509 vnfEndpoint = vnfEndpoint.replace(REQUEST_TYPE, MsoChangeManagementRequest.REPLACE);
510 return msoClientInterface.replaceVnf(requestDetails, vnfEndpoint);
513 public RequestDetailsWrapper generateInPlaceMsoRequest(org.onap.vid.changeManagement.RequestDetails requestDetails) {
514 validateUpdateVnfSoftwarePayload(requestDetails);
515 RequestDetails inPlaceSoftwareUpdateRequest = new RequestDetails();
516 inPlaceSoftwareUpdateRequest.setCloudConfiguration(requestDetails.getCloudConfiguration());
517 inPlaceSoftwareUpdateRequest.setRequestParameters(requestDetails.getRequestParameters());
518 inPlaceSoftwareUpdateRequest.setRequestInfo(requestDetails.getRequestInfo());
519 RequestDetailsWrapper requestDetailsWrapper = new RequestDetailsWrapper();
520 requestDetailsWrapper.requestDetails = inPlaceSoftwareUpdateRequest;
521 return requestDetailsWrapper;
525 public RequestDetailsWrapper generateConfigMsoRequest(org.onap.vid.changeManagement.RequestDetails requestDetails) {
526 validateUpdateVnfConfig(requestDetails);
527 RequestDetails configUpdateRequest = new RequestDetails();
528 configUpdateRequest.setRequestParameters(requestDetails.getRequestParameters());
529 configUpdateRequest.setRequestInfo(requestDetails.getRequestInfo());
530 RequestDetailsWrapper requestDetailsWrapper = new RequestDetailsWrapper();
531 requestDetailsWrapper.requestDetails = configUpdateRequest;
532 return requestDetailsWrapper;
536 public String getActivateFabricConfigurationPath(String serviceInstanceId) {
537 String path = validateEndpointPath(MsoProperties.MSO_RESTAPI_SERVICE_INSTANCE);
538 path += "/" + serviceInstanceId + ACTIVATE_FABRIC_CONFIGURATION;
544 public String getDeactivateAndCloudDeletePath(String serviceInstanceId, String vnfInstanceId, String vfModuleInstanceId) {
545 String path = validateEndpointPath(MsoProperties.MSO_REST_API_VF_MODULE_INSTANCE);
546 path = path.replaceFirst(SVC_INSTANCE_ID, serviceInstanceId);
547 path = path.replaceFirst(VNF_INSTANCE_ID, vnfInstanceId);
548 path += "/" + vfModuleInstanceId + DEACTIVATE_AND_CLOUD_DELETE;
554 public RequestDetails buildRequestDetailsForSoftDelete(SoftDeleteRequest softDeleteRequest) {
555 RequestDetails requestDetails = new RequestDetails();
556 RequestInfo requestInfo = new RequestInfo();
557 requestInfo.setSource("VID");
558 requestInfo.setRequestorId(softDeleteRequest.getUserId());
559 requestDetails.setRequestInfo(requestInfo);
561 CloudConfiguration cloudConfiguration = new CloudConfiguration(softDeleteRequest.getLcpCloudRegionId(), softDeleteRequest.getTenantId(), null);
562 requestDetails.setCloudConfiguration(cloudConfiguration);
564 ModelInfo modelInfo = new ModelInfo();
565 modelInfo.setModelType("vfModule");
566 requestDetails.setModelInfo(modelInfo);
568 RequestParameters requestParameters = new RequestParameters();
569 requestParameters.setTestApi("GR_API");
570 requestDetails.setRequestParameters(requestParameters);
572 return requestDetails;
576 public SOWorkflowList getWorkflowListByModelId(String modelVersionId) {
577 logInvocationInDebug("getWorkflowListByModelId");
578 String pathTemplate = validateEndpointPath(MSO_REST_API_WORKFLOW_SPECIFICATIONS);
579 String path = pathTemplate.replaceFirst("<model_version_id>", modelVersionId);
581 HttpResponse<SOWorkflowList> workflowListByModelId = msoClientInterface.getWorkflowListByModelId(path);
582 if (!isSuccessful(workflowListByModelId)) {
583 logger.error(EELFLoggerDelegate.errorLogger, workflowListByModelId.getStatusText());
584 throw new WorkflowListException(String.format("Get worklflow list for id: %s failed due to %s", modelVersionId, workflowListByModelId.getStatusText()));
586 return workflowListByModelId.getBody();
591 public MsoResponseWrapperInterface updateVnfSoftware(org.onap.vid.changeManagement.RequestDetails requestDetails, String serviceInstanceId, String vnfInstanceId) {
592 logInvocationInDebug("updateVnfSoftware");
593 String vnfEndpoint = getChangeManagementEndpoint(serviceInstanceId, vnfInstanceId, MsoChangeManagementRequest.SOFTWARE_UPDATE); //workflow name in mso is different than workflow name in vid UI
594 RequestDetailsWrapper finalRequestDetails = generateInPlaceMsoRequest(requestDetails);
595 return msoClientInterface.changeManagementUpdate(finalRequestDetails, vnfEndpoint);
599 public MsoResponseWrapperInterface updateVnfConfig(org.onap.vid.changeManagement.RequestDetails requestDetails, String serviceInstanceId, String vnfInstanceId) {
600 logInvocationInDebug("updateVnfConfig");
601 RequestDetailsWrapper finalRequestDetails = generateConfigMsoRequest(requestDetails);
602 String vnfEndpoint = getChangeManagementEndpoint(serviceInstanceId, vnfInstanceId, MsoChangeManagementRequest.CONFIG_UPDATE);
603 return msoClientInterface.changeManagementUpdate(finalRequestDetails, vnfEndpoint);
606 private String getChangeManagementEndpoint(String serviceInstanceId, String vnfInstanceId, String vnfRequestType) {
607 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_VNF_CHANGE_MANAGEMENT_INSTANCE);
608 String vnfEndpoint = endpoint.replaceFirst(SVC_INSTANCE_ID, serviceInstanceId);
609 vnfEndpoint = vnfEndpoint.replace(VNF_INSTANCE_ID, vnfInstanceId);
610 vnfEndpoint = vnfEndpoint.replace(REQUEST_TYPE, vnfRequestType);
614 private Map getChangeManagementPayload(RequestDetails requestDetails, String message) {
615 if (requestDetails.getRequestParameters() == null || requestDetails.getRequestParameters().getAdditionalProperties() == null) {
616 throw new BadRequestException(message);
618 Object payloadRaw = requestDetails.getRequestParameters().getAdditionalProperties().get("payload");
620 return JACKSON_OBJECT_MAPPER.readValue((String) payloadRaw, Map.class);
621 } catch (Exception exception) {
622 throw new BadRequestException(message);
626 private void validateUpdateVnfSoftwarePayload(RequestDetails requestDetails) {
627 final String noValidPayloadMsg = "No valid payload in " + ChangeManagementRequest.VNF_IN_PLACE_SOFTWARE_UPDATE + " request";
629 Map payload = getChangeManagementPayload(requestDetails, noValidPayloadMsg);
630 validateUpdateVnfSoftwarePayloadProperty(payload, noValidPayloadMsg, "existing_software_version", SOFTWARE_VERSION_PATTERN);
631 validateUpdateVnfSoftwarePayloadProperty(payload, noValidPayloadMsg, "new_software_version", SOFTWARE_VERSION_PATTERN);
633 //if "operations_timeout" is not integer, trying to read it as String that represent a number
634 if (!(payload.get("operations_timeout") instanceof Integer)) {
635 validateUpdateVnfSoftwarePayloadProperty(payload, noValidPayloadMsg, "operations_timeout", NUMBER_PATTERN);
639 private void validateUpdateVnfSoftwarePayloadProperty(Map payload, String noValidPayloadMsg, String propertyName, Pattern pattern) {
640 Object forValidation = payload.get(propertyName);
641 final String noValidPayloadPropertyMsg = noValidPayloadMsg + ", " + propertyName + " property is not valid";
642 if (!(forValidation instanceof String)) {
643 throw new BadRequestException(noValidPayloadPropertyMsg);
645 if (!pattern.matcher((String) forValidation).matches()) {
646 throw new BadRequestException(noValidPayloadPropertyMsg);
651 public MsoResponseWrapper deleteConfiguration(org.onap.vid.mso.rest.RequestDetailsWrapper requestDetailsWrapper,
652 String serviceInstanceId,
653 String configurationId) {
655 logInvocationInDebug("deleteConfiguration");
656 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_CONFIGURATION_INSTANCE);
657 endpoint = endpoint.replace(SVC_INSTANCE_ID, serviceInstanceId);
658 endpoint = endpoint.replace(CONFIGURATION_ID, configurationId);
660 return msoClientInterface.deleteConfiguration(requestDetailsWrapper, endpoint);
664 public MsoResponseWrapper setConfigurationActiveStatus(
665 RequestDetails requestDetails,
666 String serviceInstanceId,
667 String configurationId,
668 boolean isActivate) {
670 logInvocationInDebug("setConfigurationActiveStatus");
672 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_CONFIGURATION_INSTANCE);
673 endpoint = endpoint.replace(SVC_INSTANCE_ID, serviceInstanceId);
674 endpoint = endpoint.replace(CONFIGURATION_ID, configurationId);
676 String isActivateState = (isActivate ? ACTIVATE : DEACTIVATE);
677 endpoint = endpoint + isActivateState;
679 return msoClientInterface.setConfigurationActiveStatus(requestDetails, endpoint);
683 public MsoResponseWrapper setServiceInstanceStatus(RequestDetails requestDetails, String serviceInstanceId, boolean isActivate) {
684 logInvocationInDebug("setServiceInstanceStatus");
685 String methodName = "setServiceInstanceStatus";
687 String serviceEndpoint = validateEndpointPath(MsoProperties.MSO_RESTAPI_SERVICE_INSTANCE);
688 String endpoint = serviceEndpoint + "/" + serviceInstanceId;
690 String isActivateState = (isActivate ? ACTIVATE : DEACTIVATE);
691 endpoint = endpoint + isActivateState;
693 return msoClientInterface.setServiceInstanceStatus(requestDetails, endpoint);
694 } catch (Exception e) {
695 logger.error(EELFLoggerDelegate.errorLogger, methodName + e.toString());
696 logger.debug(EELFLoggerDelegate.debugLogger, methodName + e.toString());
702 public MsoResponseWrapper setPortOnConfigurationStatus(
703 RequestDetails requestDetails,
704 String serviceInstanceId,
705 String configurationId,
707 logInvocationInDebug("setPortOnConfigurationStatus");
709 String endpoint = validateEndpointPath(MsoProperties.MSO_REST_API_CONFIGURATION_INSTANCE);
710 endpoint = endpoint.replace(SVC_INSTANCE_ID, serviceInstanceId);
711 endpoint = endpoint.replace(CONFIGURATION_ID, configurationId);
713 String isEnablePortStatus = (isEnable ? ENABLE_PORT : DISABLE_PORT);
714 endpoint = endpoint + isEnablePortStatus;
716 return msoClientInterface.setPortOnConfigurationStatus(requestDetails, endpoint);
721 public RequestDetailsWrapper<RequestDetails> createOperationalEnvironmentActivationRequestDetails(OperationalEnvironmentActivateInfo details) {
722 RequestDetails requestDetails = new RequestDetails();
723 RequestInfo requestInfo = new RequestInfo();
724 requestInfo.setAdditionalProperty(RESOURCE_TYPE, RESOURCE_TYPE_OPERATIONAL_ENVIRONMENT);
725 requestInfo.setSource(SOURCE_OPERATIONAL_ENVIRONMENT);
726 requestInfo.setRequestorId(details.getUserId());
727 requestDetails.setRequestInfo(requestInfo);
729 RelatedInstance relatedInstance = new RelatedInstance();
730 relatedInstance.setAdditionalProperty(RESOURCE_TYPE, RESOURCE_TYPE_OPERATIONAL_ENVIRONMENT);
731 relatedInstance.setInstanceId(details.getRelatedInstanceId());
732 relatedInstance.setInstanceName(details.getRelatedInstanceName());
733 requestDetails.setAdditionalProperty("relatedInstanceList", Collections.singletonList(ImmutableMap.of("relatedInstance", relatedInstance)));
735 RequestParameters requestParameters = new RequestParameters();
736 requestParameters.setUserParams(null);
737 requestParameters.setAdditionalProperty("operationalEnvironmentType", "VNF");
738 requestParameters.setAdditionalProperty("workloadContext", details.getWorkloadContext());
739 requestParameters.setAdditionalProperty("manifest", details.getManifest());
740 requestDetails.setRequestParameters(requestParameters);
742 RequestDetailsWrapper<RequestDetails> requestDetailsWrapper = new RequestDetailsWrapper<>(requestDetails);
744 debugRequestDetails(requestDetailsWrapper, logger);
746 return requestDetailsWrapper;
750 public String getOperationalEnvironmentActivationPath(OperationalEnvironmentActivateInfo details) {
751 String path = validateEndpointPath(MSO_REST_API_OPERATIONAL_ENVIRONMENT_ACTIVATE);
752 path = path.replace("<operational_environment_id>", details.getOperationalEnvironmentId());
757 public RequestDetailsWrapper<RequestDetails> createOperationalEnvironmentDeactivationRequestDetails(OperationalEnvironmentDeactivateInfo details) {
758 RequestDetails requestDetails = new RequestDetails();
760 RequestInfo requestInfo = new RequestInfo();
761 requestInfo.setAdditionalProperty(RESOURCE_TYPE, RESOURCE_TYPE_OPERATIONAL_ENVIRONMENT);
762 requestInfo.setSource(SOURCE_OPERATIONAL_ENVIRONMENT);
763 requestInfo.setRequestorId(details.getUserId());
764 requestDetails.setRequestInfo(requestInfo);
766 RequestParameters requestParameters = new RequestParameters();
767 requestParameters.setUserParams(null);
768 requestParameters.setAdditionalProperty("operationalEnvironmentType", "VNF");
769 requestDetails.setRequestParameters(requestParameters);
770 RequestDetailsWrapper<RequestDetails> requestDetailsWrapper = new RequestDetailsWrapper<>(requestDetails);
771 debugRequestDetails(requestDetailsWrapper, logger);
772 return requestDetailsWrapper;
776 public String getCloudResourcesRequestsStatusPath(String requestId) {
777 String path = validateEndpointPath(MSO_REST_API_CLOUD_RESOURCES_REQUEST_STATUS);
778 path = path.replace("<request_id>", requestId);
783 public String getOperationalEnvironmentDeactivationPath(OperationalEnvironmentDeactivateInfo details) {
784 String path = validateEndpointPath(MSO_REST_API_OPERATIONAL_ENVIRONMENT_DEACTIVATE);
785 path = path.replace("<operational_environment_id>", details.getOperationalEnvironmentId());
790 public String getOperationalEnvironmentCreationPath() {
791 return validateEndpointPath(MSO_REST_API_OPERATIONAL_ENVIRONMENT_CREATE);
796 public RequestDetailsWrapper<OperationEnvironmentRequestDetails> convertParametersToRequestDetails(OperationalEnvironmentController.OperationalEnvironmentCreateBody input, String userId) {
797 OperationEnvironmentRequestDetails.RequestInfo requestInfo = new OperationEnvironmentRequestDetails.RequestInfo(
798 RESOURCE_TYPE_OPERATIONAL_ENVIRONMENT,
799 input.getInstanceName(),
800 SOURCE_OPERATIONAL_ENVIRONMENT,
803 OperationEnvironmentRequestDetails.RelatedInstance relatedInstance = new OperationEnvironmentRequestDetails.RelatedInstance(
804 RESOURCE_TYPE_OPERATIONAL_ENVIRONMENT,
805 input.getEcompInstanceId(),
806 input.getEcompInstanceName());
808 List<OperationEnvironmentRequestDetails.RelatedInstance> relatedInstanceList = Collections.singletonList((relatedInstance));
810 OperationEnvironmentRequestDetails.RequestParameters requestParameters = new OperationEnvironmentRequestDetails.RequestParameters(
811 input.getOperationalEnvironmentType(),
812 input.getTenantContext(),
813 input.getWorkloadContext());
815 OperationEnvironmentRequestDetails requestDetails = new OperationEnvironmentRequestDetails(requestInfo, relatedInstanceList, requestParameters);
816 RequestDetailsWrapper<OperationEnvironmentRequestDetails> requestDetailsWrapper = new RequestDetailsWrapper<>(requestDetails);
817 debugRequestDetails(requestDetailsWrapper, logger);
818 return requestDetailsWrapper;
822 public MsoResponseWrapper removeRelationshipFromServiceInstance(RequestDetails requestDetails, String serviceInstanceId) {
823 logInvocationInDebug("removeRelationshipFromServiceInstance");
825 String serviceEndpoint = SystemProperties.getProperty(MsoProperties.MSO_RESTAPI_SERVICE_INSTANCE);
826 String removeRelationshipsPath = serviceEndpoint + "/" + serviceInstanceId + "/removeRelationships";
828 return msoClientInterface.removeRelationshipFromServiceInstance(requestDetails, removeRelationshipsPath);
832 public MsoResponseWrapper addRelationshipToServiceInstance(RequestDetails requestDetails, String serviceInstanceId) {
833 logInvocationInDebug("addRelationshipToServiceInstance");
835 String serviceEndpoint = SystemProperties.getProperty(MsoProperties.MSO_RESTAPI_SERVICE_INSTANCE);
836 String addRelationshipsPath = serviceEndpoint + "/" + serviceInstanceId + "/addRelationships";
838 return msoClientInterface.addRelationshipToServiceInstance(requestDetails, addRelationshipsPath);
843 public ExternalComponentStatus probeComponent() {
844 final long startTime = System.currentTimeMillis();
845 HttpResponseWithRequestInfo<String> responseWithRequestInfo = null;
847 responseWithRequestInfo = getRawOrchestrationRequestsByFilter("requestExecutionDate", "01-01-2100" );
848 int httpCode = responseWithRequestInfo.getResponse().getStatus();
849 boolean isAvailable = httpCode == 200 || httpCode == 202;
851 //make sure response can be parsed to RequestList.class
852 JACKSON_OBJECT_MAPPER.readValue(responseWithRequestInfo.getResponse().getBody(), RequestList.class);
855 HttpRequestMetadata metadata = new HttpRequestMetadata(responseWithRequestInfo,
856 isAvailable ? "OK" : "MSO returned no orchestration requests",
857 System.currentTimeMillis() - startTime, true);
858 return new ExternalComponentStatus(ExternalComponentStatus.Component.MSO, isAvailable, metadata);
860 } catch (ExceptionWithRequestInfo e) {
861 long duration = System.currentTimeMillis() - startTime;
862 return new ExternalComponentStatus(ExternalComponentStatus.Component.MSO, false,
863 new HttpRequestMetadata(e, duration));
864 } catch (Exception e) {
865 StatusMetadata metadata;
866 long duration = System.currentTimeMillis() - startTime;
868 if (responseWithRequestInfo == null) {
869 metadata = new ErrorMetadata(Logging.exceptionToDescription(e), duration);
871 metadata = new HttpRequestMetadata(responseWithRequestInfo, Logging.exceptionToDescription(e), duration, true);
874 return new ExternalComponentStatus(ExternalComponentStatus.Component.MSO, false, metadata);
878 private void validateUpdateVnfConfig(RequestDetails requestDetails) {
879 final String noValidPayloadMsg = "No valid payload in " + ChangeManagementRequest.CONFIG_UPDATE + " request";
881 Map payload = getChangeManagementPayload(requestDetails, noValidPayloadMsg);
882 validateConfigUpdateVnfPayloadProperty(payload, noValidPayloadMsg, "request-parameters");
883 validateConfigUpdateVnfPayloadProperty(payload, noValidPayloadMsg, "configuration-parameters");
886 private void validateConfigUpdateVnfPayloadProperty(Map payload, String noValidPayloadMsg, String propertyName) {
887 final String noValidPayloadPropertyMsg = noValidPayloadMsg + ", " + propertyName + " property is not valid";
888 if (!payload.containsKey(propertyName)) {
889 throw new BadRequestException(noValidPayloadPropertyMsg);
893 private void logInvocationInDebug(String methodName) {
894 logger.debug(EELFLoggerDelegate.debugLogger, methodName + " start");
897 private void logException(String methodName, Exception e) {
898 logger.error(EELFLoggerDelegate.errorLogger, methodName + e.toString());
899 logger.debug(EELFLoggerDelegate.debugLogger, methodName + e.toString());
902 private boolean isSuccessful(HttpResponse<SOWorkflowList> workflowListByModelId) {
903 int status = workflowListByModelId.getStatus();
904 return HttpStatus.OK.value() == status || HttpStatus.ACCEPTED.value() == status;
907 static class WorkflowListException extends RuntimeException{
909 WorkflowListException(String message) {
914 public enum RequestType {
916 CREATE_INSTANCE("createInstance"),
917 DELETE_INSTANCE("deleteInstance"),
918 REPLACE_INSTANCE("replaceInstance"),
919 UPDATE_INSTANCE("updateInstance"),
920 ACTIVATE_INSTANCE("activateInstance"),
921 DEACTIVATE_INSTANCE("deactivateInstance"),
922 APPLY_UPDATED_CONFIG("applyUpdatedConfig"),
923 IN_PLACE_SOFTWARE_UPDATE("inPlaceSoftwareUpdate"),
924 SCALE_OUT("scaleOut"),
926 NOT_PROVIDED("not provided");
927 private final String value;
928 private static final Map<String, RequestType> CONSTANTS = new HashMap<>();
931 for (RequestType c : values()) {
932 CONSTANTS.put(c.value, c);
936 RequestType(String value) {
941 public static RequestType fromValue(String value) {
942 RequestType constant = CONSTANTS.get(value);
943 if (constant == null) {
944 throw new IllegalArgumentException(value);
952 public String toString() {