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