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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Modifications Copyright (c) 2019 Samsung
   8  * ================================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.so.apihandlerinfra;
  24
  25 import java.io.IOException;
  26 import java.text.SimpleDateFormat;
  27 import java.util.ArrayList;
  28 import java.util.HashMap;
  29 import java.util.List;
  30 import java.util.Map;
  31 import javax.transaction.Transactional;
  32 import javax.ws.rs.Consumes;
  33 import javax.ws.rs.GET;
  34 import javax.ws.rs.POST;
  35 import javax.ws.rs.Path;
  36 import javax.ws.rs.PathParam;
  37 import javax.ws.rs.Produces;
  38 import javax.ws.rs.QueryParam;
  39 import javax.ws.rs.core.Context;
  40 import javax.ws.rs.core.MediaType;
  41 import javax.ws.rs.core.MultivaluedMap;
  42 import javax.ws.rs.core.Response;
  43 import javax.ws.rs.core.UriInfo;
  44 import org.apache.commons.lang.StringUtils;
  45 import org.apache.http.HttpStatus;
  46 import org.onap.so.apihandler.common.ErrorNumbers;
  47 import org.onap.so.apihandler.common.ResponseBuilder;
  48 import org.onap.so.apihandlerinfra.exceptions.ApiException;
  49 import org.onap.so.apihandlerinfra.exceptions.ValidateException;
  50 import org.onap.so.apihandlerinfra.logging.ErrorLoggerInfo;
  51 import org.onap.so.db.request.beans.InfraActiveRequests;
  52 import org.onap.so.db.request.beans.RequestProcessingData;
  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.MessageEnum;
  57 import org.onap.so.serviceinstancebeans.CloudRequestData;
  58 import org.onap.so.serviceinstancebeans.GetOrchestrationListResponse;
  59 import org.onap.so.serviceinstancebeans.GetOrchestrationResponse;
  60 import org.onap.so.serviceinstancebeans.InstanceReferences;
  61 import org.onap.so.serviceinstancebeans.Request;
  62 import org.onap.so.serviceinstancebeans.RequestDetails;
  63 import org.onap.so.serviceinstancebeans.RequestList;
  64 import org.onap.so.serviceinstancebeans.RequestStatus;
  65 import org.onap.so.serviceinstancebeans.ServiceInstancesRequest;
  66 import org.onap.so.utils.UUIDChecker;
  67 import org.slf4j.Logger;
  68 import org.slf4j.LoggerFactory;
  69 import org.springframework.beans.factory.annotation.Autowired;
  70 import org.springframework.stereotype.Component;
  71 import com.fasterxml.jackson.databind.ObjectMapper;
  72 import io.swagger.annotations.Api;
  73 import io.swagger.annotations.ApiOperation;
  74
  75 @Path("onap/so/infra/orchestrationRequests")
  76 @Api(value = "onap/so/infra/orchestrationRequests", description = "API Requests for Orchestration requests")
  77 @Component
  78 public class OrchestrationRequests {
  79
  80     private static Logger logger = LoggerFactory.getLogger(OrchestrationRequests.class);
  81
  82     @Autowired
  83     private RequestsDbClient requestsDbClient;
  84
  85     @Autowired
  86     private MsoRequest msoRequest;
  87
  88     @Autowired
  89     private ResponseBuilder builder;
  90
  91     @GET
  92     @Path("/{version:[vV][4-7]}/{requestId}")
  93     @ApiOperation(value = "Find Orchestrated Requests for a given requestId", response = Response.class)
  94     @Produces(MediaType.APPLICATION_JSON)
  95     @Transactional
  96     public Response getOrchestrationRequest(@PathParam("requestId") String requestId,
  97             @PathParam("version") String version, @QueryParam("includeCloudRequest") boolean includeCloudRequest)
  98             throws ApiException {
  99
 100         String apiVersion = version.substring(1);
 101         GetOrchestrationResponse orchestrationResponse = new GetOrchestrationResponse();
 102
 103         InfraActiveRequests infraActiveRequest = null;
 104         List<org.onap.so.db.request.beans.RequestProcessingData> requestProcessingData = null;
 105
 106         if (!UUIDChecker.isValidUUID(requestId)) {
 107
 108             ErrorLoggerInfo errorLoggerInfo =
 109                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_VALIDATION_ERROR, ErrorCode.SchemaError)
 110                             .errorSource(Constants.MODIFIED_BY_APIHANDLER).build();
 111             throw new ValidateException.Builder("Request Id " + requestId + " is not a valid UUID",
 112                     HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).errorInfo(errorLoggerInfo).build();
 113         }
 114         try {
 115             infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
 116             requestProcessingData = requestsDbClient.getRequestProcessingDataBySoRequestId(requestId);
 117
 118         } catch (Exception e) {
 119             logger.error("Exception occurred", e);
 120             ErrorLoggerInfo errorLoggerInfo =
 121                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.AvailabilityError).build();
 122
 123             ValidateException validateException =
 124                     new ValidateException.Builder("Exception while communciate with Request DB - Infra Request Lookup",
 125                             HttpStatus.SC_NOT_FOUND, ErrorNumbers.NO_COMMUNICATION_TO_REQUESTS_DB).cause(e)
 126                                     .errorInfo(errorLoggerInfo).build();
 127
 128             throw validateException;
 129
 130         }
 131
 132         if (infraActiveRequest == null) {
 133
 134             ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR,
 135                     ErrorCode.BusinessProcesssError).build();
 136
 137             ValidateException validateException =
 138                     new ValidateException.Builder("Orchestration RequestId " + requestId + " is not found in DB",
 139                             HttpStatus.SC_NO_CONTENT, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR)
 140                                     .errorInfo(errorLoggerInfo).build();
 141
 142             throw validateException;
 143         }
 144
 145         Request request = mapInfraActiveRequestToRequest(infraActiveRequest, includeCloudRequest);
 146         if (!requestProcessingData.isEmpty()) {
 147             request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
 148         }
 149         request.setRequestId(requestId);
 150         orchestrationResponse.setRequest(request);
 151
 152         return builder.buildResponse(HttpStatus.SC_OK, requestId, orchestrationResponse, apiVersion);
 153     }
 154
 155     @GET
 156     @Path("/{version:[vV][4-7]}")
 157     @ApiOperation(value = "Find Orchestrated Requests for a URI Information", response = Response.class)
 158     @Produces(MediaType.APPLICATION_JSON)
 159     @Transactional
 160     public Response getOrchestrationRequest(@Context UriInfo ui, @PathParam("version") String version,
 161             @QueryParam("includeCloudRequest") boolean includeCloudRequest) throws ApiException {
 162
 163         long startTime = System.currentTimeMillis();
 164
 165         MultivaluedMap<String, String> queryParams = ui.getQueryParameters();
 166
 167         List<InfraActiveRequests> activeRequests = null;
 168
 169         GetOrchestrationListResponse orchestrationList = null;
 170         Map<String, List<String>> orchestrationMap;
 171         String apiVersion = version.substring(1);
 172
 173         try {
 174             orchestrationMap = msoRequest.getOrchestrationFilters(queryParams);
 175             if (orchestrationMap.isEmpty()) {
 176                 throw new ValidationException("At least one filter query param must be specified");
 177             }
 178         } catch (ValidationException ex) {
 179             logger.error("Exception occurred", ex);
 180             ErrorLoggerInfo errorLoggerInfo =
 181                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.DataError).build();
 182             ValidateException validateException =
 183                     new ValidateException.Builder(ex.getMessage(), HttpStatus.SC_BAD_REQUEST,
 184                             ErrorNumbers.SVC_GENERAL_SERVICE_ERROR).cause(ex).errorInfo(errorLoggerInfo).build();
 185             throw validateException;
 186
 187         }
 188
 189         activeRequests = requestsDbClient.getOrchestrationFiltersFromInfraActive(orchestrationMap);
 190
 191         orchestrationList = new GetOrchestrationListResponse();
 192         List<RequestList> requestLists = new ArrayList<>();
 193
 194         for (InfraActiveRequests infraActive : activeRequests) {
 195             List<RequestProcessingData> requestProcessingData =
 196                     requestsDbClient.getRequestProcessingDataBySoRequestId(infraActive.getRequestId());
 197             RequestList requestList = new RequestList();
 198             Request request = mapInfraActiveRequestToRequest(infraActive, includeCloudRequest);
 199             if (!requestProcessingData.isEmpty()) {
 200                 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
 201             }
 202             requestList.setRequest(request);
 203             requestLists.add(requestList);
 204         }
 205
 206         orchestrationList.setRequestList(requestLists);
 207         return builder.buildResponse(HttpStatus.SC_OK, null, orchestrationList, apiVersion);
 208     }
 209
 210     @POST
 211     @Path("/{version: [vV][4-7]}/{requestId}/unlock")
 212     @Consumes(MediaType.APPLICATION_JSON)
 213     @Produces(MediaType.APPLICATION_JSON)
 214     @ApiOperation(value = "Unlock Orchestrated Requests for a given requestId", response = Response.class)
 215     @Transactional
 216     public Response unlockOrchestrationRequest(String requestJSON, @PathParam("requestId") String requestId,
 217             @PathParam("version") String version) throws ApiException {
 218
 219         long startTime = System.currentTimeMillis();
 220         logger.debug("requestId is: {}", requestId);
 221         ServiceInstancesRequest sir = null;
 222
 223         InfraActiveRequests infraActiveRequest = null;
 224         Request request = null;
 225
 226         try {
 227             ObjectMapper mapper = new ObjectMapper();
 228             sir = mapper.readValue(requestJSON, ServiceInstancesRequest.class);
 229         } catch (IOException e) {
 230             logger.error("Exception occurred", e);
 231             ErrorLoggerInfo errorLoggerInfo =
 232                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
 233                             .build();
 234             ValidateException validateException =
 235                     new ValidateException.Builder("Mapping of request to JSON object failed : " + e.getMessage(),
 236                             HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
 237                                     .errorInfo(errorLoggerInfo).build();
 238
 239             throw validateException;
 240
 241         }
 242         try {
 243             msoRequest.parseOrchestration(sir);
 244         } catch (Exception e) {
 245             logger.error("Exception occurred", e);
 246             ErrorLoggerInfo errorLoggerInfo =
 247                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
 248                             .build();
 249             ValidateException validateException =
 250                     new ValidateException.Builder("Error parsing request: " + e.getMessage(), HttpStatus.SC_BAD_REQUEST,
 251                             ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
 252             throw validateException;
 253         }
 254
 255         infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
 256         if (infraActiveRequest == null) {
 257             ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND,
 258                     ErrorCode.BusinessProcesssError).build();
 259
 260             ValidateException validateException =
 261                     new ValidateException.Builder("Null response from RequestDB when searching by RequestId",
 262                             HttpStatus.SC_NOT_FOUND, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
 263                                     .build();
 264
 265             throw validateException;
 266
 267         } else {
 268             String status = infraActiveRequest.getRequestStatus();
 269             if (status.equalsIgnoreCase("IN_PROGRESS") || status.equalsIgnoreCase("PENDING")
 270                     || status.equalsIgnoreCase("PENDING_MANUAL_TASK")) {
 271                 infraActiveRequest.setRequestStatus("UNLOCKED");
 272                 infraActiveRequest.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
 273                 infraActiveRequest.setRequestId(requestId);
 274                 requestsDbClient.save(infraActiveRequest);
 275             } else {
 276
 277                 ErrorLoggerInfo errorLoggerInfo =
 278                         new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND, ErrorCode.DataError)
 279                                 .build();
 280
 281                 ValidateException validateException = new ValidateException.Builder(
 282                         "Orchestration RequestId " + requestId + " has a status of " + status
 283                                 + " and can not be unlocked",
 284                         HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
 285                                 .build();
 286
 287                 throw validateException;
 288             }
 289         }
 290         return Response.status(HttpStatus.SC_NO_CONTENT).entity("").build();
 291     }
 292
 293     protected Request mapInfraActiveRequestToRequest(InfraActiveRequests iar, boolean includeCloudRequest)
 294             throws ApiException {
 295         String requestBody = iar.getRequestBody();
 296         Request request = new Request();
 297
 298         ObjectMapper mapper = new ObjectMapper();
 299
 300         request.setRequestId(iar.getRequestId());
 301         request.setRequestScope(iar.getRequestScope());
 302         request.setRequestType(iar.getRequestAction());
 303         String rollbackStatusMessage = iar.getRollbackStatusMessage();
 304         String flowStatusMessage = iar.getFlowStatus();
 305         String retryStatusMessage = iar.getRetryStatusMessage();
 306
 307         String originalRequestId = iar.getOriginalRequestId();
 308         if (originalRequestId != null) {
 309             request.setOriginalRequestId(originalRequestId);
 310         }
 311
 312         InstanceReferences ir = new InstanceReferences();
 313         if (iar.getNetworkId() != null)
 314             ir.setNetworkInstanceId(iar.getNetworkId());
 315         if (iar.getNetworkName() != null)
 316             ir.setNetworkInstanceName(iar.getNetworkName());
 317         if (iar.getServiceInstanceId() != null)
 318             ir.setServiceInstanceId(iar.getServiceInstanceId());
 319         if (iar.getServiceInstanceName() != null)
 320             ir.setServiceInstanceName(iar.getServiceInstanceName());
 321         if (iar.getVfModuleId() != null)
 322             ir.setVfModuleInstanceId(iar.getVfModuleId());
 323         if (iar.getVfModuleName() != null)
 324             ir.setVfModuleInstanceName(iar.getVfModuleName());
 325         if (iar.getVnfId() != null)
 326             ir.setVnfInstanceId(iar.getVnfId());
 327         if (iar.getVnfName() != null)
 328             ir.setVnfInstanceName(iar.getVnfName());
 329         if (iar.getVolumeGroupId() != null)
 330             ir.setVolumeGroupInstanceId(iar.getVolumeGroupId());
 331         if (iar.getVolumeGroupName() != null)
 332             ir.setVolumeGroupInstanceName(iar.getVolumeGroupName());
 333         if (iar.getRequestorId() != null)
 334             ir.setRequestorId(iar.getRequestorId());
 335         if (iar.getInstanceGroupId() != null)
 336             ir.setInstanceGroupId(iar.getInstanceGroupId());
 337         if (iar.getInstanceGroupName() != null)
 338             ir.setInstanceGroupName(iar.getInstanceGroupName());
 339
 340         request.setInstanceReferences(ir);
 341
 342         RequestDetails requestDetails = null;
 343
 344         if (StringUtils.isNotBlank(requestBody)) {
 345             try {
 346                 if (requestBody.contains("\"requestDetails\":")) {
 347                     ServiceInstancesRequest sir = mapper.readValue(requestBody, ServiceInstancesRequest.class);
 348                     requestDetails = sir.getRequestDetails();
 349                 } else {
 350                     requestDetails = mapper.readValue(requestBody, RequestDetails.class);
 351                 }
 352             } catch (IOException e) {
 353                 logger.error("Exception occurred", e);
 354                 ErrorLoggerInfo errorLoggerInfo =
 355                         new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
 356                                 .build();
 357                 ValidateException validateException =
 358                         new ValidateException.Builder("Mapping of request to JSON object failed : ",
 359                                 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
 360                                         .errorInfo(errorLoggerInfo).build();
 361
 362                 throw validateException;
 363             }
 364         }
 365         request.setRequestDetails(requestDetails);
 366
 367         if (iar.getStartTime() != null) {
 368             String startTimeStamp =
 369                     new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getStartTime()) + " GMT";
 370             request.setStartTime(startTimeStamp);
 371         }
 372         if (iar.getEndTime() != null) {
 373             String endTimeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getEndTime()) + " GMT";
 374             request.setFinishTime(endTimeStamp);
 375         }
 376         String statusMessages = null;
 377         RequestStatus status = new RequestStatus();
 378         if (iar.getStatusMessage() != null) {
 379             statusMessages = "STATUS: " + iar.getStatusMessage();
 380         }
 381         if (flowStatusMessage != null) {
 382             if (statusMessages != null) {
 383                 statusMessages = statusMessages + " " + "FLOW STATUS: " + flowStatusMessage;
 384             } else {
 385                 statusMessages = "FLOW STATUS: " + flowStatusMessage;
 386             }
 387         }
 388         if (retryStatusMessage != null) {
 389             if (statusMessages != null) {
 390                 statusMessages = statusMessages + " " + "RETRY STATUS: " + retryStatusMessage;
 391             } else {
 392                 statusMessages = "RETRY STATUS: " + retryStatusMessage;
 393             }
 394         }
 395         if (rollbackStatusMessage != null) {
 396             if (statusMessages != null) {
 397                 statusMessages = statusMessages + " " + "ROLLBACK STATUS: " + rollbackStatusMessage;
 398             } else {
 399                 statusMessages = "ROLLBACK STATUS: " + rollbackStatusMessage;
 400             }
 401         }
 402         if (statusMessages != null) {
 403             status.setStatusMessage(statusMessages);
 404         }
 405         if (iar.getModifyTime() != null) {
 406             String timeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getModifyTime()) + " GMT";
 407             status.setTimeStamp(timeStamp);
 408         }
 409
 410         if (iar.getRequestStatus() != null) {
 411             status.setRequestState(iar.getRequestStatus());
 412         }
 413
 414         if (iar.getProgress() != null) {
 415             status.setPercentProgress(iar.getProgress().intValue());
 416         }
 417
 418         if (iar.getCloudApiRequests() != null && !iar.getCloudApiRequests().isEmpty() && includeCloudRequest) {
 419             iar.getCloudApiRequests().stream().forEach(cloudRequest -> {
 420                 try {
 421                     request.getCloudRequestData()
 422                             .add(new CloudRequestData(mapper.readValue(cloudRequest.getRequestBody(), Object.class),
 423                                     cloudRequest.getCloudIdentifier()));
 424                 } catch (Exception e) {
 425                     logger.error("Error reading Cloud Request", e);
 426                 }
 427             });
 428         }
 429
 430         request.setRequestStatus(status);
 431         return request;
 432     }
 433
 434     public List<org.onap.so.serviceinstancebeans.RequestProcessingData> mapRequestProcessingData(
 435             List<org.onap.so.db.request.beans.RequestProcessingData> processingData) {
 436         List<org.onap.so.serviceinstancebeans.RequestProcessingData> addedRequestProcessingData = new ArrayList<>();
 437         org.onap.so.serviceinstancebeans.RequestProcessingData finalProcessingData =
 438                 new org.onap.so.serviceinstancebeans.RequestProcessingData();
 439         String currentGroupingId = null;
 440         HashMap<String, String> tempMap = new HashMap<>();
 441         List<HashMap<String, String>> tempList = new ArrayList<>();
 442         for (RequestProcessingData data : processingData) {
 443             String groupingId = data.getGroupingId();
 444             String tag = data.getTag();
 445             if (currentGroupingId == null || !currentGroupingId.equals(groupingId)) {
 446                 if (!tempMap.isEmpty()) {
 447                     tempList.add(tempMap);
 448                     finalProcessingData.setDataPairs(tempList);
 449                     addedRequestProcessingData.add(finalProcessingData);
 450                 }
 451                 finalProcessingData = new org.onap.so.serviceinstancebeans.RequestProcessingData();
 452                 if (groupingId != null) {
 453                     finalProcessingData.setGroupingId(groupingId);
 454                 }
 455                 if (tag != null) {
 456                     finalProcessingData.setTag(tag);
 457                 }
 458                 currentGroupingId = groupingId;
 459                 tempMap = new HashMap<>();
 460                 tempList = new ArrayList<>();
 461                 if (data.getName() != null && data.getValue() != null) {
 462                     tempMap.put(data.getName(), data.getValue());
 463                 }
 464             } else {
 465                 if (data.getName() != null && data.getValue() != null) {
 466                     tempMap.put(data.getName(), data.getValue());
 467                 }
 468             }
 469         }
 470         if (tempMap.size() > 0) {
 471             tempList.add(tempMap);
 472             finalProcessingData.setDataPairs(tempList);
 473         }
 474         addedRequestProcessingData.add(finalProcessingData);
 475         return addedRequestProcessingData;
 476     }
 477 }