2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * Copyright (C) 2017 Huawei Technologies Co., Ltd. All rights reserved.
7 * ================================================================================
8 * Modifications Copyright (c) 2019 Samsung
9 * ================================================================================
10 * Licensed under the Apache License, Version 2.0 (the "License");
11 * you may not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
14 * http://www.apache.org/licenses/LICENSE-2.0
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS,
18 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
21 * ============LICENSE_END=========================================================
24 package org.onap.so.apihandlerinfra;
27 import static org.onap.so.logger.HttpHeadersConstants.REQUESTOR_ID;
28 import java.io.IOException;
30 import java.sql.Timestamp;
31 import java.util.ArrayList;
32 import java.util.HashMap;
33 import java.util.List;
35 import java.util.Optional;
36 import javax.ws.rs.container.ContainerRequestContext;
37 import javax.ws.rs.core.MultivaluedMap;
38 import javax.ws.rs.core.Response;
39 import org.apache.commons.lang.StringUtils;
40 import org.apache.http.HttpResponse;
41 import org.apache.http.HttpStatus;
42 import org.camunda.bpm.engine.history.HistoricProcessInstance;
43 import org.camunda.bpm.engine.impl.persistence.entity.HistoricProcessInstanceEntity;
44 import org.onap.logging.ref.slf4j.ONAPLogConstants;
45 import org.onap.so.apihandler.camundabeans.CamundaResponse;
46 import org.onap.so.apihandler.common.CommonConstants;
47 import org.onap.so.apihandler.common.ErrorNumbers;
48 import org.onap.so.apihandler.common.RequestClient;
49 import org.onap.so.apihandler.common.RequestClientFactory;
50 import org.onap.so.apihandler.common.RequestClientParameter;
51 import org.onap.so.apihandler.common.ResponseBuilder;
52 import org.onap.so.apihandler.common.ResponseHandler;
53 import org.onap.so.apihandlerinfra.exceptions.ApiException;
54 import org.onap.so.apihandlerinfra.exceptions.BPMNFailureException;
55 import org.onap.so.apihandlerinfra.exceptions.ClientConnectionException;
56 import org.onap.so.apihandlerinfra.exceptions.ContactCamundaException;
57 import org.onap.so.apihandlerinfra.exceptions.DuplicateRequestException;
58 import org.onap.so.apihandlerinfra.exceptions.RequestDbFailureException;
59 import org.onap.so.apihandlerinfra.exceptions.ValidateException;
60 import org.onap.so.apihandlerinfra.exceptions.VfModuleNotFoundException;
61 import org.onap.so.apihandlerinfra.infra.rest.handler.AbstractRestHandler;
62 import org.onap.so.apihandlerinfra.logging.ErrorLoggerInfo;
63 import org.onap.so.constants.Status;
64 import org.onap.so.db.catalog.beans.VfModule;
65 import org.onap.so.db.catalog.client.CatalogDbClient;
66 import org.onap.so.db.request.beans.InfraActiveRequests;
67 import org.onap.so.db.request.client.RequestsDbClient;
68 import org.onap.so.exceptions.ValidationException;
69 import org.onap.so.logger.ErrorCode;
70 import org.onap.so.logger.LogConstants;
71 import org.onap.so.logger.MessageEnum;
72 import org.onap.so.serviceinstancebeans.ModelInfo;
73 import org.onap.so.serviceinstancebeans.ModelType;
74 import org.onap.so.serviceinstancebeans.RelatedInstance;
75 import org.onap.so.serviceinstancebeans.RelatedInstanceList;
76 import org.onap.so.serviceinstancebeans.RequestParameters;
77 import org.onap.so.serviceinstancebeans.ServiceInstancesRequest;
78 import org.onap.so.serviceinstancebeans.ServiceInstancesResponse;
79 import org.onap.so.utils.UUIDChecker;
80 import org.slf4j.Logger;
81 import org.slf4j.LoggerFactory;
83 import org.springframework.beans.factory.annotation.Autowired;
84 import org.springframework.core.env.Environment;
85 import org.springframework.http.ResponseEntity;
86 import org.springframework.stereotype.Component;
87 import org.springframework.web.client.HttpStatusCodeException;
88 import org.springframework.web.client.RestClientException;
89 import com.fasterxml.jackson.annotation.JsonInclude.Include;
90 import com.fasterxml.jackson.databind.ObjectMapper;
93 public class RequestHandlerUtils extends AbstractRestHandler {
95 private static Logger logger = LoggerFactory.getLogger(RequestHandlerUtils.class);
97 private static final String SAVE_TO_DB = "save instance to db";
100 private Environment env;
103 private RequestClientFactory reqClientFactory;
106 private RequestsDbClient infraActiveRequestsClient;
109 private ResponseBuilder builder;
112 private MsoRequest msoRequest;
115 private CamundaRequestHandler camundaRequestHandler;
118 private CatalogDbClient catalogDbClient;
120 public Response postBPELRequest(InfraActiveRequests currentActiveReq, RequestClientParameter requestClientParameter,
121 String orchestrationUri, String requestScope) throws ApiException {
122 RequestClient requestClient = null;
123 HttpResponse response = null;
125 requestClient = reqClientFactory.getRequestClient(orchestrationUri);
126 response = requestClient.post(requestClientParameter);
127 } catch (Exception e) {
129 ErrorLoggerInfo errorLoggerInfo =
130 new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR, ErrorCode.AvailabilityError)
131 .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
132 String url = requestClient != null ? requestClient.getUrl() : "";
133 ClientConnectionException clientException =
134 new ClientConnectionException.Builder(url, HttpStatus.SC_BAD_GATEWAY,
135 ErrorNumbers.SVC_NO_SERVER_RESOURCES).cause(e).errorInfo(errorLoggerInfo).build();
136 updateStatus(currentActiveReq, Status.FAILED, clientException.getMessage());
138 throw clientException;
141 if (response == null) {
143 ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR,
144 ErrorCode.BusinessProcesssError).errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
145 ClientConnectionException clientException = new ClientConnectionException.Builder(requestClient.getUrl(),
146 HttpStatus.SC_BAD_GATEWAY, ErrorNumbers.SVC_NO_SERVER_RESOURCES).errorInfo(errorLoggerInfo).build();
148 updateStatus(currentActiveReq, Status.FAILED, clientException.getMessage());
150 throw clientException;
153 ResponseHandler respHandler = null;
154 int bpelStatus = 500;
156 respHandler = new ResponseHandler(response, requestClient.getType());
157 bpelStatus = respHandler.getStatus();
158 } catch (ApiException e) {
159 logger.error("Exception occurred", e);
160 ErrorLoggerInfo errorLoggerInfo =
161 new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_RESPONSE_ERROR, ErrorCode.SchemaError)
162 .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
163 ValidateException validateException =
164 new ValidateException.Builder("Exception caught mapping Camunda JSON response to object",
165 HttpStatus.SC_INTERNAL_SERVER_ERROR, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
166 .errorInfo(errorLoggerInfo).build();
167 updateStatus(currentActiveReq, Status.FAILED, validateException.getMessage());
168 throw validateException;
171 // BPEL accepted the request, the request is in progress
172 if (bpelStatus == HttpStatus.SC_ACCEPTED) {
173 ServiceInstancesResponse jsonResponse;
174 CamundaResponse camundaResp = respHandler.getResponse();
176 if ("Success".equalsIgnoreCase(camundaResp.getMessage())) {
178 ObjectMapper mapper = new ObjectMapper();
179 jsonResponse = mapper.readValue(camundaResp.getResponse(), ServiceInstancesResponse.class);
180 jsonResponse.getRequestReferences().setRequestId(requestClientParameter.getRequestId());
181 Optional<URL> selfLinkUrl =
182 buildSelfLinkUrl(currentActiveReq.getRequestUrl(), requestClientParameter.getRequestId());
183 if (selfLinkUrl.isPresent()) {
184 jsonResponse.getRequestReferences().setRequestSelfLink(selfLinkUrl.get());
186 jsonResponse.getRequestReferences().setRequestSelfLink(null);
188 } catch (IOException e) {
189 logger.error("Exception occurred", e);
190 ErrorLoggerInfo errorLoggerInfo =
191 new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_RESPONSE_ERROR, ErrorCode.SchemaError)
192 .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
193 ValidateException validateException =
194 new ValidateException.Builder("Exception caught mapping Camunda JSON response to object",
195 HttpStatus.SC_NOT_ACCEPTABLE, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
196 .errorInfo(errorLoggerInfo).build();
197 updateStatus(currentActiveReq, Status.FAILED, validateException.getMessage());
198 throw validateException;
200 return builder.buildResponse(HttpStatus.SC_ACCEPTED, requestClientParameter.getRequestId(),
201 jsonResponse, requestClientParameter.getApiVersion());
205 List<String> variables = new ArrayList<>();
206 variables.add(bpelStatus + "");
207 String camundaJSONResponseBody = respHandler.getResponseBody();
208 if (camundaJSONResponseBody != null && !camundaJSONResponseBody.isEmpty()) {
210 ErrorLoggerInfo errorLoggerInfo =
211 new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_RESPONSE_ERROR, ErrorCode.BusinessProcesssError)
212 .errorSource(requestClient.getUrl()).build();
213 BPMNFailureException bpmnException =
214 new BPMNFailureException.Builder(String.valueOf(bpelStatus) + camundaJSONResponseBody, bpelStatus,
215 ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo).build();
217 updateStatus(currentActiveReq, Status.FAILED, bpmnException.getMessage());
222 ErrorLoggerInfo errorLoggerInfo =
223 new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_RESPONSE_ERROR, ErrorCode.BusinessProcesssError)
224 .errorSource(requestClient.getUrl()).build();
227 BPMNFailureException servException = new BPMNFailureException.Builder(String.valueOf(bpelStatus),
228 bpelStatus, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo).build();
229 updateStatus(currentActiveReq, Status.FAILED, servException.getMessage());
235 public void updateStatus(InfraActiveRequests aq, Status status, String errorMessage)
236 throws RequestDbFailureException {
237 if ((status == Status.FAILED) || (status == Status.COMPLETE)) {
238 aq.setStatusMessage(errorMessage);
239 aq.setProgress(new Long(100));
240 aq.setRequestStatus(status.toString());
241 Timestamp endTimeStamp = new Timestamp(System.currentTimeMillis());
242 aq.setEndTime(endTimeStamp);
244 infraActiveRequestsClient.save(aq);
245 } catch (Exception e) {
246 ErrorLoggerInfo errorLoggerInfo =
247 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.DataError)
248 .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
249 throw new RequestDbFailureException.Builder(SAVE_TO_DB, e.toString(),
250 HttpStatus.SC_INTERNAL_SERVER_ERROR, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).cause(e)
251 .errorInfo(errorLoggerInfo).build();
256 public String deriveRequestScope(Actions action, ServiceInstancesRequest sir, String requestUri) {
257 if (action == Action.inPlaceSoftwareUpdate || action == Action.applyUpdatedConfig) {
258 return (ModelType.vnf.name());
259 } else if (action == Action.addMembers || action == Action.removeMembers) {
260 return (ModelType.instanceGroup.toString());
263 if (sir.getRequestDetails().getModelInfo().getModelType() == null) {
264 requestScope = requestScopeFromUri(requestUri);
266 requestScope = sir.getRequestDetails().getModelInfo().getModelType().name();
273 public void validateHeaders(ContainerRequestContext context) throws ValidationException {
274 MultivaluedMap<String, String> headers = context.getHeaders();
275 if (!headers.containsKey(ONAPLogConstants.Headers.REQUEST_ID)) {
276 throw new ValidationException(ONAPLogConstants.Headers.REQUEST_ID + " header", true);
278 if (!headers.containsKey(ONAPLogConstants.Headers.PARTNER_NAME)) {
279 throw new ValidationException(ONAPLogConstants.Headers.PARTNER_NAME + " header", true);
281 if (!headers.containsKey(REQUESTOR_ID)) {
282 throw new ValidationException(REQUESTOR_ID + " header", true);
286 public String getRequestUri(ContainerRequestContext context, String uriPrefix) {
287 String requestUri = context.getUriInfo().getPath();
288 String httpUrl = MDC.get(LogConstants.URI_BASE).concat(requestUri);
289 MDC.put(LogConstants.HTTP_URL, httpUrl);
290 requestUri = requestUri.substring(requestUri.indexOf(uriPrefix) + uriPrefix.length());
294 public InfraActiveRequests duplicateCheck(Actions action, HashMap<String, String> instanceIdMap,
295 String instanceName, String requestScope, InfraActiveRequests currentActiveReq) throws ApiException {
296 InfraActiveRequests dup = null;
298 if (!(instanceName == null && requestScope.equals("service") && (action == Action.createInstance
299 || action == Action.activateInstance || action == Action.assignInstance))) {
300 dup = infraActiveRequestsClient.checkInstanceNameDuplicate(instanceIdMap, instanceName, requestScope);
302 } catch (Exception e) {
303 ErrorLoggerInfo errorLoggerInfo =
304 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DUPLICATE_CHECK_EXC, ErrorCode.DataError)
305 .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
306 RequestDbFailureException requestDbFailureException =
307 new RequestDbFailureException.Builder("check for duplicate instance", e.toString(),
308 HttpStatus.SC_INTERNAL_SERVER_ERROR, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).cause(e)
309 .errorInfo(errorLoggerInfo).build();
310 updateStatus(currentActiveReq, Status.FAILED, requestDbFailureException.getMessage());
311 throw requestDbFailureException;
316 public boolean camundaHistoryCheck(InfraActiveRequests duplicateRecord, InfraActiveRequests currentActiveReq)
317 throws RequestDbFailureException, ContactCamundaException {
318 String requestId = duplicateRecord.getRequestId();
319 ResponseEntity<List<HistoricProcessInstanceEntity>> response = null;
321 response = camundaRequestHandler.getCamundaProcessInstanceHistory(requestId);
322 } catch (RestClientException e) {
323 logger.error("Error querying Camunda for process-instance history for requestId: {}, exception: {}",
324 requestId, e.getMessage());
325 ContactCamundaException contactCamundaException =
326 new ContactCamundaException.Builder("process-instance", requestId, e.toString(),
327 HttpStatus.SC_INTERNAL_SERVER_ERROR, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).cause(e)
329 updateStatus(currentActiveReq, Status.FAILED, contactCamundaException.getMessage());
330 throw contactCamundaException;
333 if (response.getBody().isEmpty()) {
334 updateStatus(duplicateRecord, Status.COMPLETE, "Request Completed");
336 for (HistoricProcessInstance instance : response.getBody()) {
337 if (instance.getState().equals("ACTIVE")) {
340 updateStatus(duplicateRecord, Status.COMPLETE, "Request Completed");
346 public ServiceInstancesRequest convertJsonToServiceInstanceRequest(String requestJSON, Actions action,
347 String requestId, String requestUri) throws ApiException {
349 ObjectMapper mapper = new ObjectMapper();
350 return mapper.readValue(requestJSON, ServiceInstancesRequest.class);
352 } catch (IOException e) {
354 ErrorLoggerInfo errorLoggerInfo =
355 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
356 .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
358 ValidateException validateException =
359 new ValidateException.Builder("Error mapping request: " + e.getMessage(), HttpStatus.SC_BAD_REQUEST,
360 ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
361 String requestScope = requestScopeFromUri(requestUri);
363 msoRequest.createErrorRequestRecord(Status.FAILED, requestId, validateException.getMessage(), action,
364 requestScope, requestJSON);
366 throw validateException;
370 public void parseRequest(ServiceInstancesRequest sir, HashMap<String, String> instanceIdMap, Actions action,
371 String version, String requestJSON, Boolean aLaCarte, String requestId,
372 InfraActiveRequests currentActiveReq) throws ValidateException, RequestDbFailureException {
373 int reqVersion = Integer.parseInt(version.substring(1));
375 msoRequest.parse(sir, instanceIdMap, action, version, requestJSON, reqVersion, aLaCarte);
376 } catch (Exception e) {
377 logger.error("failed to parse request", e);
378 ErrorLoggerInfo errorLoggerInfo =
379 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
380 .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
381 ValidateException validateException =
382 new ValidateException.Builder("Error parsing request: " + e.getMessage(), HttpStatus.SC_BAD_REQUEST,
383 ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
385 updateStatus(currentActiveReq, Status.FAILED, validateException.getMessage());
387 throw validateException;
391 public void buildErrorOnDuplicateRecord(InfraActiveRequests currentActiveReq, Actions action,
392 HashMap<String, String> instanceIdMap, String instanceName, String requestScope, InfraActiveRequests dup)
393 throws ApiException {
395 String instance = null;
396 if (instanceName != null) {
397 instance = instanceName;
399 instance = instanceIdMap.get(requestScope + "InstanceId");
401 ErrorLoggerInfo errorLoggerInfo =
402 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DUPLICATE_FOUND, ErrorCode.SchemaError)
403 .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
405 DuplicateRequestException dupException =
406 new DuplicateRequestException.Builder(requestScope, instance, dup.getRequestStatus(),
407 dup.getRequestId(), HttpStatus.SC_CONFLICT, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR)
408 .errorInfo(errorLoggerInfo).build();
410 updateStatus(currentActiveReq, Status.FAILED, dupException.getMessage());
415 public String getRequestId(ContainerRequestContext requestContext) throws ValidateException {
416 String requestId = null;
417 if (requestContext.getProperty("requestId") != null) {
418 requestId = requestContext.getProperty("requestId").toString();
420 if (UUIDChecker.isValidUUID(requestId)) {
423 ErrorLoggerInfo errorLoggerInfo =
424 new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_RESPONSE_ERROR, ErrorCode.SchemaError)
425 .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
426 ValidateException validateException =
427 new ValidateException.Builder("Request Id " + requestId + " is not a valid UUID",
428 HttpStatus.SC_INTERNAL_SERVER_ERROR, ErrorNumbers.SVC_BAD_PARAMETER)
429 .errorInfo(errorLoggerInfo).build();
431 throw validateException;
435 public void setInstanceId(InfraActiveRequests currentActiveReq, String requestScope, String instanceId,
436 Map<String, String> instanceIdMap) {
437 if (StringUtils.isNotBlank(instanceId)) {
438 if (ModelType.service.name().equalsIgnoreCase(requestScope)) {
439 currentActiveReq.setServiceInstanceId(instanceId);
440 } else if (ModelType.vnf.name().equalsIgnoreCase(requestScope)) {
441 currentActiveReq.setVnfId(instanceId);
442 } else if (ModelType.vfModule.name().equalsIgnoreCase(requestScope)) {
443 currentActiveReq.setVfModuleId(instanceId);
444 } else if (ModelType.volumeGroup.name().equalsIgnoreCase(requestScope)) {
445 currentActiveReq.setVolumeGroupId(instanceId);
446 } else if (ModelType.network.name().equalsIgnoreCase(requestScope)) {
447 currentActiveReq.setNetworkId(instanceId);
448 } else if (ModelType.configuration.name().equalsIgnoreCase(requestScope)) {
449 currentActiveReq.setConfigurationId(instanceId);
450 } else if (ModelType.instanceGroup.toString().equalsIgnoreCase(requestScope)) {
451 currentActiveReq.setInstanceGroupId(instanceId);
453 } else if (instanceIdMap != null && !instanceIdMap.isEmpty()) {
454 if (instanceIdMap.get("serviceInstanceId") != null) {
455 currentActiveReq.setServiceInstanceId(instanceIdMap.get("serviceInstanceId"));
457 if (instanceIdMap.get("vnfInstanceId") != null) {
458 currentActiveReq.setVnfId(instanceIdMap.get("vnfInstanceId"));
460 if (instanceIdMap.get("vfModuleInstanceId") != null) {
461 currentActiveReq.setVfModuleId(instanceIdMap.get("vfModuleInstanceId"));
463 if (instanceIdMap.get("volumeGroupInstanceId") != null) {
464 currentActiveReq.setVolumeGroupId(instanceIdMap.get("volumeGroupInstanceId"));
466 if (instanceIdMap.get("networkInstanceId") != null) {
467 currentActiveReq.setNetworkId(instanceIdMap.get("networkInstanceId"));
469 if (instanceIdMap.get("configurationInstanceId") != null) {
470 currentActiveReq.setConfigurationId(instanceIdMap.get("configurationInstanceId"));
472 if (instanceIdMap.get(CommonConstants.INSTANCE_GROUP_INSTANCE_ID) != null) {
473 currentActiveReq.setInstanceGroupId(instanceIdMap.get(CommonConstants.INSTANCE_GROUP_INSTANCE_ID));
478 public String mapJSONtoMSOStyle(String msoRawRequest, ServiceInstancesRequest serviceInstRequest,
479 boolean isAlaCarte, Actions action) throws IOException {
480 ObjectMapper mapper = new ObjectMapper();
481 mapper.setSerializationInclusion(Include.NON_NULL);
482 if (msoRawRequest != null) {
483 ServiceInstancesRequest sir = mapper.readValue(msoRawRequest, ServiceInstancesRequest.class);
484 if (serviceInstRequest != null && serviceInstRequest.getRequestDetails() != null
485 && serviceInstRequest.getRequestDetails().getRequestParameters() != null) {
486 if (!isAlaCarte && Action.createInstance.equals(action)) {
487 sir.getRequestDetails()
488 .setCloudConfiguration(serviceInstRequest.getRequestDetails().getCloudConfiguration());
489 sir.getRequestDetails().getRequestParameters().setUserParams(
490 serviceInstRequest.getRequestDetails().getRequestParameters().getUserParams());
492 sir.getRequestDetails().getRequestParameters()
493 .setUsePreload(serviceInstRequest.getRequestDetails().getRequestParameters().getUsePreload());
496 logger.debug("Value as string: {}", mapper.writeValueAsString(sir));
497 return mapper.writeValueAsString(sir);
502 public Optional<String> retrieveModelName(RequestParameters requestParams) {
503 String requestTestApi = null;
504 TestApi testApi = null;
506 if (requestParams != null) {
507 requestTestApi = requestParams.getTestApi();
510 if (requestTestApi == null) {
511 if (requestParams != null && requestParams.getALaCarte() != null && !requestParams.getALaCarte()) {
512 requestTestApi = env.getProperty(CommonConstants.MACRO_TEST_API);
514 requestTestApi = env.getProperty(CommonConstants.ALACARTE_TEST_API);
519 testApi = TestApi.valueOf(requestTestApi);
520 return Optional.of(testApi.getModelName());
521 } catch (Exception e) {
522 logger.warn("Catching the exception on the valueOf enum call and continuing", e);
523 throw new IllegalArgumentException("Invalid TestApi is provided", e);
527 public String getDefaultModel(ServiceInstancesRequest sir) {
528 String defaultModel = sir.getRequestDetails().getRequestInfo().getSource() + "_DEFAULT";
529 Optional<String> oModelName = retrieveModelName(sir.getRequestDetails().getRequestParameters());
530 if (oModelName.isPresent()) {
531 defaultModel = oModelName.get();
536 public String getServiceType(String requestScope, ServiceInstancesRequest sir, Boolean aLaCarteFlag) {
537 String serviceType = null;
538 if (requestScope.equalsIgnoreCase(ModelType.service.toString())) {
539 String defaultServiceModelName = getDefaultModel(sir);
540 org.onap.so.db.catalog.beans.Service serviceRecord;
542 serviceRecord = catalogDbClient.getFirstByModelNameOrderByModelVersionDesc(defaultServiceModelName);
543 if (serviceRecord != null) {
544 serviceType = serviceRecord.getServiceType();
548 catalogDbClient.getServiceByID(sir.getRequestDetails().getModelInfo().getModelVersionId());
549 if (serviceRecord != null) {
550 serviceType = serviceRecord.getServiceType();
552 serviceRecord = catalogDbClient.getFirstByModelNameOrderByModelVersionDesc(defaultServiceModelName);
553 if (serviceRecord != null) {
554 serviceType = serviceRecord.getServiceType();
559 serviceType = msoRequest.getServiceInstanceType(sir, requestScope);
564 protected String setServiceInstanceId(String requestScope, ServiceInstancesRequest sir) {
565 if (sir.getServiceInstanceId() != null) {
566 return sir.getServiceInstanceId();
567 } else if (requestScope.equalsIgnoreCase(ModelType.instanceGroup.toString())) {
568 RelatedInstanceList[] relatedInstances = sir.getRequestDetails().getRelatedInstanceList();
569 if (relatedInstances != null) {
570 for (RelatedInstanceList relatedInstanceList : relatedInstances) {
571 RelatedInstance relatedInstance = relatedInstanceList.getRelatedInstance();
572 if (relatedInstance.getModelInfo().getModelType() == ModelType.service) {
573 return relatedInstance.getInstanceId();
581 private String requestScopeFromUri(String requestUri) {
583 if (requestUri.contains(ModelType.network.name())) {
584 requestScope = ModelType.network.name();
585 } else if (requestUri.contains(ModelType.vfModule.name())) {
586 requestScope = ModelType.vfModule.name();
587 } else if (requestUri.contains(ModelType.volumeGroup.name())) {
588 requestScope = ModelType.volumeGroup.name();
589 } else if (requestUri.contains(ModelType.configuration.name())) {
590 requestScope = ModelType.configuration.name();
591 } else if (requestUri.contains(ModelType.vnf.name())) {
592 requestScope = ModelType.vnf.name();
594 requestScope = ModelType.service.name();
599 protected InfraActiveRequests createNewRecordCopyFromInfraActiveRequest(InfraActiveRequests infraActiveRequest,
600 String requestId, Timestamp startTimeStamp, String source, String requestUri, String requestorId,
601 String originalRequestId) throws ApiException {
602 InfraActiveRequests request = new InfraActiveRequests();
603 request.setRequestId(requestId);
604 request.setStartTime(startTimeStamp);
605 request.setSource(source);
606 request.setRequestUrl(requestUri);
607 request.setProgress(new Long(5));
608 request.setRequestorId(requestorId);
609 request.setRequestStatus(Status.IN_PROGRESS.toString());
610 request.setOriginalRequestId(originalRequestId);
611 request.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
612 if (infraActiveRequest != null) {
613 request.setTenantId(infraActiveRequest.getTenantId());
614 request.setRequestBody(updateRequestorIdInRequestBody(infraActiveRequest, requestorId));
615 request.setAicCloudRegion(infraActiveRequest.getAicCloudRegion());
616 request.setRequestScope(infraActiveRequest.getRequestScope());
617 request.setRequestAction(infraActiveRequest.getRequestAction());
618 setInstanceIdAndName(infraActiveRequest, request);
623 protected void setInstanceIdAndName(InfraActiveRequests infraActiveRequest,
624 InfraActiveRequests currentActiveRequest) throws ApiException {
625 String requestScope = infraActiveRequest.getRequestScope();
627 ModelType type = ModelType.valueOf(requestScope);
628 String instanceName = type.getName(infraActiveRequest);
629 if (instanceName == null && type.equals(ModelType.vfModule)) {
630 logger.error("vfModule for requestId: {} being resumed does not have an instanceName.",
631 infraActiveRequest.getRequestId());
632 ValidateException validateException = new ValidateException.Builder(
633 "vfModule for requestId: " + infraActiveRequest.getRequestId()
634 + " being resumed does not have an instanceName.",
635 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).build();
636 updateStatus(currentActiveRequest, Status.FAILED, validateException.getMessage());
637 throw validateException;
639 if (instanceName != null) {
640 type.setName(currentActiveRequest, instanceName);
642 type.setId(currentActiveRequest, type.getId(infraActiveRequest));
643 } catch (IllegalArgumentException e) {
645 "requestScope \"{}\" does not match a ModelType enum. Unable to set instanceId and instanceName from the original request.",
650 protected Boolean getIsBaseVfModule(ModelInfo modelInfo, Actions action, String vnfType,
651 String sdcServiceModelVersion, InfraActiveRequests currentActiveReq) throws ApiException {
652 // Get VF Module-specific base module indicator
654 String modelVersionId = modelInfo.getModelVersionId();
655 Boolean isBaseVfModule = false;
657 if (modelVersionId != null) {
658 vfm = catalogDbClient.getVfModuleByModelUUID(modelVersionId);
659 } else if (modelInfo.getModelInvariantId() != null && modelInfo.getModelVersion() != null) {
660 vfm = catalogDbClient.getVfModuleByModelInvariantUUIDAndModelVersion(modelInfo.getModelInvariantId(),
661 modelInfo.getModelVersion());
665 if (vfm.getIsBase()) {
666 isBaseVfModule = true;
668 } else if (action == Action.createInstance || action == Action.updateInstance) {
669 String serviceVersionText = "";
670 if (sdcServiceModelVersion != null && !sdcServiceModelVersion.isEmpty()) {
671 serviceVersionText = " with version " + sdcServiceModelVersion;
673 String errorMessage = "VnfType " + vnfType + " and VF Module Model Name " + modelInfo.getModelName()
674 + serviceVersionText + " not found in MSO Catalog DB";
675 ErrorLoggerInfo errorLoggerInfo =
676 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND, ErrorCode.DataError)
677 .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
678 VfModuleNotFoundException vfModuleException = new VfModuleNotFoundException.Builder(errorMessage,
679 HttpStatus.SC_NOT_FOUND, ErrorNumbers.SVC_BAD_PARAMETER).errorInfo(errorLoggerInfo).build();
680 updateStatus(currentActiveReq, Status.FAILED, vfModuleException.getMessage());
681 throw vfModuleException;
683 return isBaseVfModule;
686 protected ModelType getModelType(Actions action, ModelInfo modelInfo) {
687 if (action == Action.applyUpdatedConfig || action == Action.inPlaceSoftwareUpdate) {
688 return ModelType.vnf;
689 } else if (action == Action.addMembers || action == Action.removeMembers) {
690 return ModelType.instanceGroup;
692 return modelInfo.getModelType();
696 protected String updateRequestorIdInRequestBody(InfraActiveRequests infraActiveRequest, String newRequestorId) {
697 String requestBody = infraActiveRequest.getRequestBody();
698 return requestBody.replaceAll(
699 "(?s)(\"requestInfo\"\\s*?:\\s*?\\{.*?\"requestorId\"\\s*?:\\s*?\")(.*?)(\"[ ]*(?:,|\\R|\\}))",
700 "$1" + newRequestorId + "$3");