mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/RequestHandlerUtils.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   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
  13  *
  14  *      http://www.apache.org/licenses/LICENSE-2.0
  15  *
  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=========================================================
  22  */
  23
  24 package org.onap.so.apihandlerinfra;
  25
  26
  27 import com.fasterxml.jackson.annotation.JsonInclude.Include;
  28 import com.fasterxml.jackson.databind.ObjectMapper;
  29 import org.apache.commons.lang.StringUtils;
  30 import org.apache.http.HttpResponse;
  31 import org.apache.http.HttpStatus;
  32 import org.camunda.bpm.engine.history.HistoricProcessInstance;
  33 import org.camunda.bpm.engine.impl.persistence.entity.HistoricProcessInstanceEntity;
  34 import org.onap.logging.ref.slf4j.ONAPLogConstants;
  35 import org.onap.so.apihandler.camundabeans.CamundaResponse;
  36 import org.onap.so.apihandler.common.CommonConstants;
  37 import org.onap.so.apihandler.common.ErrorNumbers;
  38 import org.onap.so.apihandler.common.RequestClient;
  39 import org.onap.so.apihandler.common.RequestClientFactory;
  40 import org.onap.so.apihandler.common.RequestClientParameter;
  41 import org.onap.so.apihandler.common.ResponseBuilder;
  42 import org.onap.so.apihandler.common.ResponseHandler;
  43 import org.onap.so.apihandlerinfra.exceptions.ApiException;
  44 import org.onap.so.apihandlerinfra.exceptions.BPMNFailureException;
  45 import org.onap.so.apihandlerinfra.exceptions.ClientConnectionException;
  46 import org.onap.so.apihandlerinfra.exceptions.ContactCamundaException;
  47 import org.onap.so.apihandlerinfra.exceptions.DuplicateRequestException;
  48 import org.onap.so.apihandlerinfra.exceptions.RequestDbFailureException;
  49 import org.onap.so.apihandlerinfra.exceptions.ValidateException;
  50 import org.onap.so.apihandlerinfra.logging.ErrorLoggerInfo;
  51 import org.onap.so.db.catalog.client.CatalogDbClient;
  52 import org.onap.so.db.request.beans.InfraActiveRequests;
  53 import org.onap.so.db.request.client.RequestsDbClient;
  54 import org.onap.so.exceptions.ValidationException;
  55 import org.onap.so.logger.ErrorCode;
  56 import org.onap.so.logger.LogConstants;
  57 import org.onap.so.logger.MessageEnum;
  58 import org.onap.so.serviceinstancebeans.ModelType;
  59 import org.onap.so.serviceinstancebeans.RelatedInstance;
  60 import org.onap.so.serviceinstancebeans.RelatedInstanceList;
  61 import org.onap.so.serviceinstancebeans.RequestParameters;
  62 import org.onap.so.serviceinstancebeans.ServiceInstancesRequest;
  63 import org.onap.so.serviceinstancebeans.ServiceInstancesResponse;
  64 import org.onap.so.utils.CryptoUtils;
  65 import org.onap.so.utils.UUIDChecker;
  66 import org.slf4j.Logger;
  67 import org.slf4j.LoggerFactory;
  68 import org.slf4j.MDC;
  69 import org.springframework.beans.factory.annotation.Autowired;
  70 import org.springframework.core.ParameterizedTypeReference;
  71 import org.springframework.core.env.Environment;
  72 import org.springframework.http.HttpEntity;
  73 import org.springframework.http.HttpHeaders;
  74 import org.springframework.http.HttpMethod;
  75 import org.springframework.http.ResponseEntity;
  76 import org.springframework.stereotype.Component;
  77 import org.springframework.web.client.HttpStatusCodeException;
  78 import org.springframework.web.client.RestTemplate;
  79 import javax.ws.rs.container.ContainerRequestContext;
  80 import javax.ws.rs.core.MultivaluedMap;
  81 import javax.ws.rs.core.Response;
  82 import javax.xml.bind.DatatypeConverter;
  83 import static org.onap.so.logger.HttpHeadersConstants.REQUESTOR_ID;
  84 import java.io.IOException;
  85 import java.net.URL;
  86 import java.security.GeneralSecurityException;
  87 import java.sql.Timestamp;
  88 import java.util.ArrayList;
  89 import java.util.HashMap;
  90 import java.util.List;
  91 import java.util.Map;
  92 import java.util.Optional;
  93
  94 @Component
  95 public class RequestHandlerUtils {
  96
  97     private static Logger logger = LoggerFactory.getLogger(RequestHandlerUtils.class);
  98
  99     private static final String SAVE_TO_DB = "save instance to db";
 100
 101     @Autowired
 102     private Environment env;
 103
 104     @Autowired
 105     private RequestClientFactory reqClientFactory;
 106
 107     @Autowired
 108     private RequestsDbClient infraActiveRequestsClient;
 109
 110     @Autowired
 111     private ResponseBuilder builder;
 112
 113     @Autowired
 114     private MsoRequest msoRequest;
 115
 116     @Autowired
 117     private RestTemplate restTemplate;
 118
 119     @Autowired
 120     private CatalogDbClient catalogDbClient;
 121
 122     public Response postBPELRequest(InfraActiveRequests currentActiveReq, RequestClientParameter requestClientParameter,
 123             String orchestrationUri, String requestScope) throws ApiException {
 124         RequestClient requestClient = null;
 125         HttpResponse response = null;
 126         try {
 127             requestClient = reqClientFactory.getRequestClient(orchestrationUri);
 128             response = requestClient.post(requestClientParameter);
 129         } catch (Exception e) {
 130
 131             ErrorLoggerInfo errorLoggerInfo =
 132                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR, ErrorCode.AvailabilityError)
 133                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 134             String url = requestClient != null ? requestClient.getUrl() : "";
 135             ClientConnectionException clientException =
 136                     new ClientConnectionException.Builder(url, HttpStatus.SC_BAD_GATEWAY,
 137                             ErrorNumbers.SVC_NO_SERVER_RESOURCES).cause(e).errorInfo(errorLoggerInfo).build();
 138             updateStatus(currentActiveReq, Status.FAILED, clientException.getMessage());
 139
 140             throw clientException;
 141         }
 142
 143         if (response == null) {
 144
 145             ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR,
 146                     ErrorCode.BusinessProcesssError).errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 147             ClientConnectionException clientException = new ClientConnectionException.Builder(requestClient.getUrl(),
 148                     HttpStatus.SC_BAD_GATEWAY, ErrorNumbers.SVC_NO_SERVER_RESOURCES).errorInfo(errorLoggerInfo).build();
 149
 150             updateStatus(currentActiveReq, Status.FAILED, clientException.getMessage());
 151
 152             throw clientException;
 153         }
 154
 155         ResponseHandler respHandler = null;
 156         int bpelStatus = 500;
 157         try {
 158             respHandler = new ResponseHandler(response, requestClient.getType());
 159             bpelStatus = respHandler.getStatus();
 160         } catch (ApiException e) {
 161             logger.error("Exception occurred", e);
 162             ErrorLoggerInfo errorLoggerInfo =
 163                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_RESPONSE_ERROR, ErrorCode.SchemaError)
 164                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 165             ValidateException validateException =
 166                     new ValidateException.Builder("Exception caught mapping Camunda JSON response to object",
 167                             HttpStatus.SC_INTERNAL_SERVER_ERROR, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
 168                                     .errorInfo(errorLoggerInfo).build();
 169             updateStatus(currentActiveReq, Status.FAILED, validateException.getMessage());
 170             throw validateException;
 171         }
 172
 173         // BPEL accepted the request, the request is in progress
 174         if (bpelStatus == HttpStatus.SC_ACCEPTED) {
 175             ServiceInstancesResponse jsonResponse;
 176             CamundaResponse camundaResp = respHandler.getResponse();
 177
 178             if ("Success".equalsIgnoreCase(camundaResp.getMessage())) {
 179                 try {
 180                     ObjectMapper mapper = new ObjectMapper();
 181                     jsonResponse = mapper.readValue(camundaResp.getResponse(), ServiceInstancesResponse.class);
 182                     jsonResponse.getRequestReferences().setRequestId(requestClientParameter.getRequestId());
 183                     Optional<URL> selfLinkUrl = msoRequest.buildSelfLinkUrl(currentActiveReq.getRequestUrl(),
 184                             requestClientParameter.getRequestId());
 185                     if (selfLinkUrl.isPresent()) {
 186                         jsonResponse.getRequestReferences().setRequestSelfLink(selfLinkUrl.get());
 187                     } else {
 188                         jsonResponse.getRequestReferences().setRequestSelfLink(null);
 189                     }
 190                 } catch (IOException e) {
 191                     logger.error("Exception occurred", e);
 192                     ErrorLoggerInfo errorLoggerInfo =
 193                             new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_RESPONSE_ERROR, ErrorCode.SchemaError)
 194                                     .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 195                     ValidateException validateException =
 196                             new ValidateException.Builder("Exception caught mapping Camunda JSON response to object",
 197                                     HttpStatus.SC_NOT_ACCEPTABLE, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
 198                                             .errorInfo(errorLoggerInfo).build();
 199                     updateStatus(currentActiveReq, Status.FAILED, validateException.getMessage());
 200                     throw validateException;
 201                 }
 202                 return builder.buildResponse(HttpStatus.SC_ACCEPTED, requestClientParameter.getRequestId(),
 203                         jsonResponse, requestClientParameter.getApiVersion());
 204             }
 205         }
 206
 207         List<String> variables = new ArrayList<>();
 208         variables.add(bpelStatus + "");
 209         String camundaJSONResponseBody = respHandler.getResponseBody();
 210         if (camundaJSONResponseBody != null && !camundaJSONResponseBody.isEmpty()) {
 211
 212             ErrorLoggerInfo errorLoggerInfo =
 213                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_RESPONSE_ERROR, ErrorCode.BusinessProcesssError)
 214                             .errorSource(requestClient.getUrl()).build();
 215             BPMNFailureException bpmnException =
 216                     new BPMNFailureException.Builder(String.valueOf(bpelStatus) + camundaJSONResponseBody, bpelStatus,
 217                             ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo).build();
 218
 219             updateStatus(currentActiveReq, Status.FAILED, bpmnException.getMessage());
 220
 221             throw bpmnException;
 222         } else {
 223
 224             ErrorLoggerInfo errorLoggerInfo =
 225                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_RESPONSE_ERROR, ErrorCode.BusinessProcesssError)
 226                             .errorSource(requestClient.getUrl()).build();
 227
 228
 229             BPMNFailureException servException = new BPMNFailureException.Builder(String.valueOf(bpelStatus),
 230                     bpelStatus, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo).build();
 231             updateStatus(currentActiveReq, Status.FAILED, servException.getMessage());
 232
 233             throw servException;
 234         }
 235     }
 236
 237     public void updateStatus(InfraActiveRequests aq, Status status, String errorMessage)
 238             throws RequestDbFailureException {
 239         if ((status == Status.FAILED) || (status == Status.COMPLETE)) {
 240             aq.setStatusMessage(errorMessage);
 241             aq.setProgress(new Long(100));
 242             aq.setRequestStatus(status.toString());
 243             Timestamp endTimeStamp = new Timestamp(System.currentTimeMillis());
 244             aq.setEndTime(endTimeStamp);
 245             try {
 246                 infraActiveRequestsClient.save(aq);
 247             } catch (Exception e) {
 248                 ErrorLoggerInfo errorLoggerInfo =
 249                         new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.DataError)
 250                                 .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 251                 throw new RequestDbFailureException.Builder(SAVE_TO_DB, e.toString(),
 252                         HttpStatus.SC_INTERNAL_SERVER_ERROR, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).cause(e)
 253                                 .errorInfo(errorLoggerInfo).build();
 254             }
 255         }
 256     }
 257
 258     public String deriveRequestScope(Actions action, ServiceInstancesRequest sir, String requestUri) {
 259         if (action == Action.inPlaceSoftwareUpdate || action == Action.applyUpdatedConfig) {
 260             return (ModelType.vnf.name());
 261         } else if (action == Action.addMembers || action == Action.removeMembers) {
 262             return (ModelType.instanceGroup.toString());
 263         } else {
 264             String requestScope;
 265             if (sir.getRequestDetails().getModelInfo().getModelType() == null) {
 266                 requestScope = requestScopeFromUri(requestUri);
 267             } else {
 268                 requestScope = sir.getRequestDetails().getModelInfo().getModelType().name();
 269             }
 270             return requestScope;
 271         }
 272     }
 273
 274
 275     public void validateHeaders(ContainerRequestContext context) throws ValidationException {
 276         MultivaluedMap<String, String> headers = context.getHeaders();
 277         if (!headers.containsKey(ONAPLogConstants.Headers.REQUEST_ID)) {
 278             throw new ValidationException(ONAPLogConstants.Headers.REQUEST_ID + " header", true);
 279         }
 280         if (!headers.containsKey(ONAPLogConstants.Headers.PARTNER_NAME)) {
 281             throw new ValidationException(ONAPLogConstants.Headers.PARTNER_NAME + " header", true);
 282         }
 283         if (!headers.containsKey(REQUESTOR_ID)) {
 284             throw new ValidationException(REQUESTOR_ID + " header", true);
 285         }
 286     }
 287
 288     public String getRequestUri(ContainerRequestContext context, String uriPrefix) {
 289         String requestUri = context.getUriInfo().getPath();
 290         String httpUrl = MDC.get(LogConstants.URI_BASE).concat(requestUri);
 291         MDC.put(LogConstants.HTTP_URL, httpUrl);
 292         requestUri = requestUri.substring(requestUri.indexOf(uriPrefix) + uriPrefix.length());
 293         return requestUri;
 294     }
 295
 296     public InfraActiveRequests duplicateCheck(Actions action, HashMap<String, String> instanceIdMap, long startTime,
 297             MsoRequest msoRequest, String instanceName, String requestScope, InfraActiveRequests currentActiveReq)
 298             throws ApiException {
 299         InfraActiveRequests dup = null;
 300         try {
 301             if (!(instanceName == null && requestScope.equals("service") && (action == Action.createInstance
 302                     || action == Action.activateInstance || action == Action.assignInstance))) {
 303                 dup = infraActiveRequestsClient.checkInstanceNameDuplicate(instanceIdMap, instanceName, requestScope);
 304             }
 305         } catch (Exception e) {
 306             ErrorLoggerInfo errorLoggerInfo =
 307                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_DUPLICATE_CHECK_EXC, ErrorCode.DataError)
 308                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 309             RequestDbFailureException requestDbFailureException =
 310                     new RequestDbFailureException.Builder("check for duplicate instance", e.toString(),
 311                             HttpStatus.SC_INTERNAL_SERVER_ERROR, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).cause(e)
 312                                     .errorInfo(errorLoggerInfo).build();
 313             updateStatus(currentActiveReq, Status.FAILED, requestDbFailureException.getMessage());
 314             throw requestDbFailureException;
 315         }
 316         return dup;
 317     }
 318
 319     public boolean camundaHistoryCheck(InfraActiveRequests duplicateRecord, InfraActiveRequests currentActiveReq)
 320             throws RequestDbFailureException, ContactCamundaException {
 321         String requestId = duplicateRecord.getRequestId();
 322         String path = env.getProperty("mso.camunda.rest.history.uri") + requestId;
 323         String targetUrl = env.getProperty("mso.camundaURL") + path;
 324         HttpHeaders headers =
 325                 setCamundaHeaders(env.getRequiredProperty("mso.camundaAuth"), env.getRequiredProperty("mso.msoKey"));
 326         HttpEntity<?> requestEntity = new HttpEntity<>(headers);
 327         ResponseEntity<List<HistoricProcessInstanceEntity>> response = null;
 328         try {
 329             response = restTemplate.exchange(targetUrl, HttpMethod.GET, requestEntity,
 330                     new ParameterizedTypeReference<List<HistoricProcessInstanceEntity>>() {});
 331         } catch (HttpStatusCodeException e) {
 332             ErrorLoggerInfo errorLoggerInfo =
 333                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_DUPLICATE_CHECK_EXC, ErrorCode.DataError)
 334                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 335             ContactCamundaException contactCamundaException =
 336                     new ContactCamundaException.Builder(requestId, e.toString(), HttpStatus.SC_INTERNAL_SERVER_ERROR,
 337                             ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).cause(e).errorInfo(errorLoggerInfo).build();
 338             updateStatus(currentActiveReq, Status.FAILED, contactCamundaException.getMessage());
 339             throw contactCamundaException;
 340         }
 341         if (response.getBody().isEmpty()) {
 342             updateStatus(duplicateRecord, Status.COMPLETE, "Request Completed");
 343         }
 344         for (HistoricProcessInstance instance : response.getBody()) {
 345             if (instance.getState().equals("ACTIVE")) {
 346                 return true;
 347             } else {
 348                 updateStatus(duplicateRecord, Status.COMPLETE, "Request Completed");
 349             }
 350         }
 351         return false;
 352     }
 353
 354     protected HttpHeaders setCamundaHeaders(String auth, String msoKey) {
 355         HttpHeaders headers = new HttpHeaders();
 356         List<org.springframework.http.MediaType> acceptableMediaTypes = new ArrayList<>();
 357         acceptableMediaTypes.add(org.springframework.http.MediaType.APPLICATION_JSON);
 358         headers.setAccept(acceptableMediaTypes);
 359         try {
 360             String userCredentials = CryptoUtils.decrypt(auth, msoKey);
 361             if (userCredentials != null) {
 362                 headers.add(HttpHeaders.AUTHORIZATION,
 363                         "Basic " + DatatypeConverter.printBase64Binary(userCredentials.getBytes()));
 364             }
 365         } catch (GeneralSecurityException e) {
 366             logger.error("Security exception", e);
 367         }
 368         return headers;
 369     }
 370
 371     public ServiceInstancesRequest convertJsonToServiceInstanceRequest(String requestJSON, Actions action,
 372             long startTime, ServiceInstancesRequest sir, MsoRequest msoRequest, String requestId, String requestUri)
 373             throws ApiException {
 374         try {
 375             ObjectMapper mapper = new ObjectMapper();
 376             return mapper.readValue(requestJSON, ServiceInstancesRequest.class);
 377
 378         } catch (IOException e) {
 379
 380             ErrorLoggerInfo errorLoggerInfo =
 381                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
 382                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 383
 384             ValidateException validateException =
 385                     new ValidateException.Builder("Error mapping request: " + e.getMessage(), HttpStatus.SC_BAD_REQUEST,
 386                             ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
 387             String requestScope = requestScopeFromUri(requestUri);
 388
 389             msoRequest.createErrorRequestRecord(Status.FAILED, requestId, validateException.getMessage(), action,
 390                     requestScope, requestJSON);
 391
 392             throw validateException;
 393         }
 394     }
 395
 396     public void parseRequest(ServiceInstancesRequest sir, HashMap<String, String> instanceIdMap, Actions action,
 397             String version, String requestJSON, Boolean aLaCarte, String requestId,
 398             InfraActiveRequests currentActiveReq) throws ValidateException, RequestDbFailureException {
 399         int reqVersion = Integer.parseInt(version.substring(1));
 400         try {
 401             msoRequest.parse(sir, instanceIdMap, action, version, requestJSON, reqVersion, aLaCarte);
 402         } catch (Exception e) {
 403             logger.error("failed to parse request", e);
 404             ErrorLoggerInfo errorLoggerInfo =
 405                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
 406                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 407             ValidateException validateException =
 408                     new ValidateException.Builder("Error parsing request: " + e.getMessage(), HttpStatus.SC_BAD_REQUEST,
 409                             ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
 410
 411             updateStatus(currentActiveReq, Status.FAILED, validateException.getMessage());
 412
 413             throw validateException;
 414         }
 415     }
 416
 417     public void buildErrorOnDuplicateRecord(InfraActiveRequests currentActiveReq, Actions action,
 418             HashMap<String, String> instanceIdMap, long startTime, MsoRequest msoRequest, String instanceName,
 419             String requestScope, InfraActiveRequests dup) throws ApiException {
 420
 421         String instance = null;
 422         if (instanceName != null) {
 423             instance = instanceName;
 424         } else {
 425             instance = instanceIdMap.get(requestScope + "InstanceId");
 426         }
 427         ErrorLoggerInfo errorLoggerInfo =
 428                 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DUPLICATE_FOUND, ErrorCode.SchemaError)
 429                         .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 430
 431         DuplicateRequestException dupException =
 432                 new DuplicateRequestException.Builder(requestScope, instance, dup.getRequestStatus(),
 433                         dup.getRequestId(), HttpStatus.SC_CONFLICT, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR)
 434                                 .errorInfo(errorLoggerInfo).build();
 435
 436         updateStatus(currentActiveReq, Status.FAILED, dupException.getMessage());
 437
 438         throw dupException;
 439     }
 440
 441     public String getRequestId(ContainerRequestContext requestContext) throws ValidateException {
 442         String requestId = null;
 443         if (requestContext.getProperty("requestId") != null) {
 444             requestId = requestContext.getProperty("requestId").toString();
 445         }
 446         if (UUIDChecker.isValidUUID(requestId)) {
 447             return requestId;
 448         } else {
 449             ErrorLoggerInfo errorLoggerInfo =
 450                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_RESPONSE_ERROR, ErrorCode.SchemaError)
 451                             .errorSource(Constants.MSO_PROP_APIHANDLER_INFRA).build();
 452             ValidateException validateException =
 453                     new ValidateException.Builder("Request Id " + requestId + " is not a valid UUID",
 454                             HttpStatus.SC_INTERNAL_SERVER_ERROR, ErrorNumbers.SVC_BAD_PARAMETER)
 455                                     .errorInfo(errorLoggerInfo).build();
 456
 457             throw validateException;
 458         }
 459     }
 460
 461     public void setInstanceId(InfraActiveRequests currentActiveReq, String requestScope, String instanceId,
 462             Map<String, String> instanceIdMap) {
 463         if (StringUtils.isNotBlank(instanceId)) {
 464             if (ModelType.service.name().equalsIgnoreCase(requestScope)) {
 465                 currentActiveReq.setServiceInstanceId(instanceId);
 466             } else if (ModelType.vnf.name().equalsIgnoreCase(requestScope)) {
 467                 currentActiveReq.setVnfId(instanceId);
 468             } else if (ModelType.vfModule.name().equalsIgnoreCase(requestScope)) {
 469                 currentActiveReq.setVfModuleId(instanceId);
 470             } else if (ModelType.volumeGroup.name().equalsIgnoreCase(requestScope)) {
 471                 currentActiveReq.setVolumeGroupId(instanceId);
 472             } else if (ModelType.network.name().equalsIgnoreCase(requestScope)) {
 473                 currentActiveReq.setNetworkId(instanceId);
 474             } else if (ModelType.configuration.name().equalsIgnoreCase(requestScope)) {
 475                 currentActiveReq.setConfigurationId(instanceId);
 476             } else if (ModelType.instanceGroup.toString().equalsIgnoreCase(requestScope)) {
 477                 currentActiveReq.setInstanceGroupId(instanceId);
 478             }
 479         } else if (instanceIdMap != null && !instanceIdMap.isEmpty()) {
 480             if (instanceIdMap.get("serviceInstanceId") != null) {
 481                 currentActiveReq.setServiceInstanceId(instanceIdMap.get("serviceInstanceId"));
 482             }
 483             if (instanceIdMap.get("vnfInstanceId") != null) {
 484                 currentActiveReq.setVnfId(instanceIdMap.get("vnfInstanceId"));
 485             }
 486             if (instanceIdMap.get("vfModuleInstanceId") != null) {
 487                 currentActiveReq.setVfModuleId(instanceIdMap.get("vfModuleInstanceId"));
 488             }
 489             if (instanceIdMap.get("volumeGroupInstanceId") != null) {
 490                 currentActiveReq.setVolumeGroupId(instanceIdMap.get("volumeGroupInstanceId"));
 491             }
 492             if (instanceIdMap.get("networkInstanceId") != null) {
 493                 currentActiveReq.setNetworkId(instanceIdMap.get("networkInstanceId"));
 494             }
 495             if (instanceIdMap.get("configurationInstanceId") != null) {
 496                 currentActiveReq.setConfigurationId(instanceIdMap.get("configurationInstanceId"));
 497             }
 498             if (instanceIdMap.get(CommonConstants.INSTANCE_GROUP_INSTANCE_ID) != null) {
 499                 currentActiveReq.setInstanceGroupId(instanceIdMap.get(CommonConstants.INSTANCE_GROUP_INSTANCE_ID));
 500             }
 501         }
 502     }
 503
 504     public String mapJSONtoMSOStyle(String msoRawRequest, ServiceInstancesRequest serviceInstRequest,
 505             boolean isAlaCarte, Actions action) throws IOException {
 506         ObjectMapper mapper = new ObjectMapper();
 507         mapper.setSerializationInclusion(Include.NON_NULL);
 508         if (msoRawRequest != null) {
 509             ServiceInstancesRequest sir = mapper.readValue(msoRawRequest, ServiceInstancesRequest.class);
 510             if (serviceInstRequest != null && serviceInstRequest.getRequestDetails() != null
 511                     && serviceInstRequest.getRequestDetails().getRequestParameters() != null) {
 512                 if (!isAlaCarte && Action.createInstance.equals(action)) {
 513                     sir.getRequestDetails()
 514                             .setCloudConfiguration(serviceInstRequest.getRequestDetails().getCloudConfiguration());
 515                     sir.getRequestDetails().getRequestParameters().setUserParams(
 516                             serviceInstRequest.getRequestDetails().getRequestParameters().getUserParams());
 517                 }
 518                 sir.getRequestDetails().getRequestParameters()
 519                         .setUsePreload(serviceInstRequest.getRequestDetails().getRequestParameters().getUsePreload());
 520             }
 521
 522             logger.debug("Value as string: {}", mapper.writeValueAsString(sir));
 523             return mapper.writeValueAsString(sir);
 524         }
 525         return null;
 526     }
 527
 528     public Optional<String> retrieveModelName(RequestParameters requestParams) {
 529         String requestTestApi = null;
 530         TestApi testApi = null;
 531
 532         if (requestParams != null) {
 533             requestTestApi = requestParams.getTestApi();
 534         }
 535
 536         if (requestTestApi == null) {
 537             if (requestParams != null && requestParams.getALaCarte() != null && !requestParams.getALaCarte()) {
 538                 requestTestApi = env.getProperty(CommonConstants.MACRO_TEST_API);
 539             } else {
 540                 requestTestApi = env.getProperty(CommonConstants.ALACARTE_TEST_API);
 541             }
 542         }
 543
 544         try {
 545             testApi = TestApi.valueOf(requestTestApi);
 546             return Optional.of(testApi.getModelName());
 547         } catch (Exception e) {
 548             logger.warn("Catching the exception on the valueOf enum call and continuing", e);
 549             throw new IllegalArgumentException("Invalid TestApi is provided", e);
 550         }
 551     }
 552
 553     public String getDefaultModel(ServiceInstancesRequest sir) {
 554         String defaultModel = sir.getRequestDetails().getRequestInfo().getSource() + "_DEFAULT";
 555         Optional<String> oModelName = retrieveModelName(sir.getRequestDetails().getRequestParameters());
 556         if (oModelName.isPresent()) {
 557             defaultModel = oModelName.get();
 558         }
 559         return defaultModel;
 560     }
 561
 562     public String getServiceType(String requestScope, ServiceInstancesRequest sir, Boolean aLaCarteFlag) {
 563         String serviceType = null;
 564         if (requestScope.equalsIgnoreCase(ModelType.service.toString())) {
 565             String defaultServiceModelName = getDefaultModel(sir);
 566             org.onap.so.db.catalog.beans.Service serviceRecord;
 567             if (aLaCarteFlag) {
 568                 serviceRecord = catalogDbClient.getFirstByModelNameOrderByModelVersionDesc(defaultServiceModelName);
 569                 if (serviceRecord != null) {
 570                     serviceType = serviceRecord.getServiceType();
 571                 }
 572             } else {
 573                 serviceRecord =
 574                         catalogDbClient.getServiceByID(sir.getRequestDetails().getModelInfo().getModelVersionId());
 575                 if (serviceRecord != null) {
 576                     serviceType = serviceRecord.getServiceType();
 577                 } else {
 578                     serviceRecord = catalogDbClient.getFirstByModelNameOrderByModelVersionDesc(defaultServiceModelName);
 579                     if (serviceRecord != null) {
 580                         serviceType = serviceRecord.getServiceType();
 581                     }
 582                 }
 583             }
 584         } else {
 585             serviceType = msoRequest.getServiceInstanceType(sir, requestScope);
 586         }
 587         return serviceType;
 588     }
 589
 590     protected String setServiceInstanceId(String requestScope, ServiceInstancesRequest sir) {
 591         if (sir.getServiceInstanceId() != null) {
 592             return sir.getServiceInstanceId();
 593         } else if (requestScope.equalsIgnoreCase(ModelType.instanceGroup.toString())) {
 594             RelatedInstanceList[] relatedInstances = sir.getRequestDetails().getRelatedInstanceList();
 595             if (relatedInstances != null) {
 596                 for (RelatedInstanceList relatedInstanceList : relatedInstances) {
 597                     RelatedInstance relatedInstance = relatedInstanceList.getRelatedInstance();
 598                     if (relatedInstance.getModelInfo().getModelType() == ModelType.service) {
 599                         return relatedInstance.getInstanceId();
 600                     }
 601                 }
 602             }
 603         }
 604         return null;
 605     }
 606
 607     private String requestScopeFromUri(String requestUri) {
 608         String requestScope;
 609         if (requestUri.contains(ModelType.network.name())) {
 610             requestScope = ModelType.network.name();
 611         } else if (requestUri.contains(ModelType.vfModule.name())) {
 612             requestScope = ModelType.vfModule.name();
 613         } else if (requestUri.contains(ModelType.volumeGroup.name())) {
 614             requestScope = ModelType.volumeGroup.name();
 615         } else if (requestUri.contains(ModelType.configuration.name())) {
 616             requestScope = ModelType.configuration.name();
 617         } else if (requestUri.contains(ModelType.vnf.name())) {
 618             requestScope = ModelType.vnf.name();
 619         } else {
 620             requestScope = ModelType.service.name();
 621         }
 622         return requestScope;
 623     }
 624
 625 }