Sonar fixes in OrchestrationRequests
[so.git] / 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.constants.OrchestrationRequestFormat;
52 import org.onap.so.constants.Status;
53 import org.onap.so.db.request.beans.InfraActiveRequests;
54 import org.onap.so.db.request.beans.RequestProcessingData;
55 import org.onap.so.db.request.client.RequestsDbClient;
56 import org.onap.so.exceptions.ValidationException;
57 import org.onap.so.logger.ErrorCode;
58 import org.onap.so.logger.MessageEnum;
59 import org.onap.so.serviceinstancebeans.CloudRequestData;
60 import org.onap.so.serviceinstancebeans.GetOrchestrationListResponse;
61 import org.onap.so.serviceinstancebeans.GetOrchestrationResponse;
62 import org.onap.so.serviceinstancebeans.InstanceReferences;
63 import org.onap.so.serviceinstancebeans.Request;
64 import org.onap.so.serviceinstancebeans.RequestDetails;
65 import org.onap.so.serviceinstancebeans.RequestList;
66 import org.onap.so.serviceinstancebeans.RequestStatus;
67 import org.onap.so.serviceinstancebeans.ServiceInstancesRequest;
68 import org.onap.so.utils.UUIDChecker;
69 import org.slf4j.Logger;
70 import org.slf4j.LoggerFactory;
71 import org.springframework.beans.factory.annotation.Autowired;
72 import org.springframework.stereotype.Component;
73 import com.fasterxml.jackson.databind.ObjectMapper;
74 import io.swagger.annotations.Api;
75 import io.swagger.annotations.ApiOperation;
76
77
78 @Path("onap/so/infra/orchestrationRequests")
79 @Api(value = "onap/so/infra/orchestrationRequests", description = "API Requests for Orchestration requests")
80 @Component
81 public class OrchestrationRequests {
82
83     private static Logger logger = LoggerFactory.getLogger(OrchestrationRequests.class);
84
85     @Autowired
86     private RequestsDbClient requestsDbClient;
87
88     @Autowired
89     private MsoRequest msoRequest;
90
91     @Autowired
92     private ResponseBuilder builder;
93
94     @GET
95     @Path("/{version:[vV][4-7]}/{requestId}")
96     @ApiOperation(value = "Find Orchestrated Requests for a given requestId", response = Response.class)
97     @Produces(MediaType.APPLICATION_JSON)
98     @Transactional
99     public Response getOrchestrationRequest(@PathParam("requestId") String requestId,
100             @PathParam("version") String version, @QueryParam("includeCloudRequest") boolean includeCloudRequest,
101             @QueryParam(value = "format") String format) throws ApiException {
102
103         String apiVersion = version.substring(1);
104         GetOrchestrationResponse orchestrationResponse = new GetOrchestrationResponse();
105
106         InfraActiveRequests infraActiveRequest = null;
107         List<org.onap.so.db.request.beans.RequestProcessingData> requestProcessingData = null;
108
109         if (!UUIDChecker.isValidUUID(requestId)) {
110
111             ErrorLoggerInfo errorLoggerInfo =
112                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_VALIDATION_ERROR, ErrorCode.SchemaError)
113                             .errorSource(Constants.MODIFIED_BY_APIHANDLER).build();
114             throw new ValidateException.Builder("Request Id " + requestId + " is not a valid UUID",
115                     HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).errorInfo(errorLoggerInfo).build();
116         }
117         try {
118             infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
119             requestProcessingData = requestsDbClient.getRequestProcessingDataBySoRequestId(requestId);
120
121         } catch (Exception e) {
122             logger.error("Exception occurred", e);
123             ErrorLoggerInfo errorLoggerInfo =
124                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.AvailabilityError).build();
125
126             ValidateException validateException =
127                     new ValidateException.Builder("Exception while communciate with Request DB - Infra Request Lookup",
128                             HttpStatus.SC_NOT_FOUND, ErrorNumbers.NO_COMMUNICATION_TO_REQUESTS_DB).cause(e)
129                                     .errorInfo(errorLoggerInfo).build();
130
131             throw validateException;
132
133         }
134
135         if (infraActiveRequest == null) {
136
137             ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR,
138                     ErrorCode.BusinessProcesssError).build();
139
140             ValidateException validateException =
141                     new ValidateException.Builder("Orchestration RequestId " + requestId + " is not found in DB",
142                             HttpStatus.SC_NO_CONTENT, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR)
143                                     .errorInfo(errorLoggerInfo).build();
144
145             throw validateException;
146         }
147
148         Request request = mapInfraActiveRequestToRequest(infraActiveRequest, includeCloudRequest, format);
149
150         if (!requestProcessingData.isEmpty()) {
151             request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
152         }
153         request.setRequestId(requestId);
154         orchestrationResponse.setRequest(request);
155
156         return builder.buildResponse(HttpStatus.SC_OK, requestId, orchestrationResponse, apiVersion);
157     }
158
159     @GET
160     @Path("/{version:[vV][4-7]}")
161     @ApiOperation(value = "Find Orchestrated Requests for a URI Information", response = Response.class)
162     @Produces(MediaType.APPLICATION_JSON)
163     @Transactional
164     public Response getOrchestrationRequest(@Context UriInfo ui, @PathParam("version") String version,
165             @QueryParam("includeCloudRequest") boolean includeCloudRequest, @QueryParam(value = "format") String format)
166             throws ApiException {
167
168         MultivaluedMap<String, String> queryParams = ui.getQueryParameters();
169
170         List<InfraActiveRequests> activeRequests;
171
172         GetOrchestrationListResponse orchestrationList;
173         Map<String, List<String>> orchestrationMap;
174         String apiVersion = version.substring(1);
175
176         try {
177             orchestrationMap = msoRequest.getOrchestrationFilters(queryParams);
178             if (orchestrationMap.isEmpty()) {
179                 throw new ValidationException("At least one filter query param must be specified");
180             }
181         } catch (ValidationException ex) {
182             logger.error("Exception occurred", ex);
183             ErrorLoggerInfo errorLoggerInfo =
184                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.DataError).build();
185             ValidateException validateException =
186                     new ValidateException.Builder(ex.getMessage(), HttpStatus.SC_BAD_REQUEST,
187                             ErrorNumbers.SVC_GENERAL_SERVICE_ERROR).cause(ex).errorInfo(errorLoggerInfo).build();
188             throw validateException;
189
190         }
191
192         activeRequests = requestsDbClient.getOrchestrationFiltersFromInfraActive(orchestrationMap);
193
194         orchestrationList = new GetOrchestrationListResponse();
195         List<RequestList> requestLists = new ArrayList<>();
196
197         for (InfraActiveRequests infraActive : activeRequests) {
198             List<RequestProcessingData> requestProcessingData =
199                     requestsDbClient.getRequestProcessingDataBySoRequestId(infraActive.getRequestId());
200             RequestList requestList = new RequestList();
201             Request request = mapInfraActiveRequestToRequest(infraActive, includeCloudRequest, format);
202
203             if (!requestProcessingData.isEmpty()) {
204                 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
205             }
206             requestList.setRequest(request);
207             requestLists.add(requestList);
208         }
209
210         orchestrationList.setRequestList(requestLists);
211         return builder.buildResponse(HttpStatus.SC_OK, null, orchestrationList, apiVersion);
212     }
213
214     @POST
215     @Path("/{version: [vV][4-7]}/{requestId}/unlock")
216     @Consumes(MediaType.APPLICATION_JSON)
217     @Produces(MediaType.APPLICATION_JSON)
218     @ApiOperation(value = "Unlock Orchestrated Requests for a given requestId", response = Response.class)
219     @Transactional
220     public Response unlockOrchestrationRequest(String requestJSON, @PathParam("requestId") String requestId,
221             @PathParam("version") String version) throws ApiException {
222
223         logger.debug("requestId is: {}", requestId);
224         ServiceInstancesRequest sir;
225
226         InfraActiveRequests infraActiveRequest;
227
228         try {
229             ObjectMapper mapper = new ObjectMapper();
230             sir = mapper.readValue(requestJSON, ServiceInstancesRequest.class);
231         } catch (IOException e) {
232             logger.error("Exception occurred", e);
233             ErrorLoggerInfo errorLoggerInfo =
234                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
235                             .build();
236             ValidateException validateException =
237                     new ValidateException.Builder("Mapping of request to JSON object failed : " + e.getMessage(),
238                             HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
239                                     .errorInfo(errorLoggerInfo).build();
240
241             throw validateException;
242
243         }
244         try {
245             msoRequest.parseOrchestration(sir);
246         } catch (Exception e) {
247             logger.error("Exception occurred", e);
248             ErrorLoggerInfo errorLoggerInfo =
249                     new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
250                             .build();
251             ValidateException validateException =
252                     new ValidateException.Builder("Error parsing request: " + e.getMessage(), HttpStatus.SC_BAD_REQUEST,
253                             ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
254             throw validateException;
255         }
256
257         infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
258         if (infraActiveRequest == null) {
259             ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND,
260                     ErrorCode.BusinessProcesssError).build();
261
262             ValidateException validateException =
263                     new ValidateException.Builder("Null response from RequestDB when searching by RequestId",
264                             HttpStatus.SC_NOT_FOUND, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
265                                     .build();
266
267             throw validateException;
268
269         } else {
270             String status = infraActiveRequest.getRequestStatus();
271             if (Status.IN_PROGRESS.toString().equalsIgnoreCase(status)
272                     || Status.PENDING.toString().equalsIgnoreCase(status)
273                     || Status.PENDING_MANUAL_TASK.toString().equalsIgnoreCase(status)) {
274                 infraActiveRequest.setRequestStatus(Status.UNLOCKED.toString());
275                 infraActiveRequest.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
276                 infraActiveRequest.setRequestId(requestId);
277                 requestsDbClient.save(infraActiveRequest);
278             } else {
279
280                 ErrorLoggerInfo errorLoggerInfo =
281                         new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND, ErrorCode.DataError)
282                                 .build();
283
284                 ValidateException validateException = new ValidateException.Builder(
285                         "Orchestration RequestId " + requestId + " has a status of " + status
286                                 + " and can not be unlocked",
287                         HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
288                                 .build();
289
290                 throw validateException;
291             }
292         }
293         return Response.status(HttpStatus.SC_NO_CONTENT).entity("").build();
294     }
295
296     protected Request mapInfraActiveRequestToRequest(InfraActiveRequests iar, boolean includeCloudRequest,
297             String format) throws ApiException {
298         String requestBody = iar.getRequestBody();
299         Request request = new Request();
300
301         ObjectMapper mapper = new ObjectMapper();
302
303         request.setRequestId(iar.getRequestId());
304         request.setRequestScope(iar.getRequestScope());
305         request.setRequestType(iar.getRequestAction());
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
377         RequestStatus status = new RequestStatus();
378
379         if (iar.getModifyTime() != null) {
380             String timeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getModifyTime()) + " GMT";
381             status.setTimeStamp(timeStamp);
382         }
383
384         status.setRequestState(mapRequestStatusToRequest(iar, format));
385
386         if (iar.getProgress() != null) {
387             status.setPercentProgress(iar.getProgress().intValue());
388         }
389
390         if (iar.getCloudApiRequests() != null && !iar.getCloudApiRequests().isEmpty() && includeCloudRequest) {
391             iar.getCloudApiRequests().stream().forEach(cloudRequest -> {
392                 try {
393                     request.getCloudRequestData()
394                             .add(new CloudRequestData(mapper.readValue(cloudRequest.getRequestBody(), Object.class),
395                                     cloudRequest.getCloudIdentifier()));
396                 } catch (Exception e) {
397                     logger.error("Error reading Cloud Request", e);
398                 }
399             });
400         }
401
402         mapRequestStatusAndExtSysErrSrcToRequest(iar, status, format);
403
404         request.setRequestStatus(status);
405         return request;
406     }
407
408     protected String mapRequestStatusToRequest(InfraActiveRequests iar, String format) {
409         if (iar.getRequestStatus() != null) {
410             if (!StringUtils.isBlank(format) && OrchestrationRequestFormat.DETAIL.toString().equalsIgnoreCase(format)) {
411                 return iar.getRequestStatus();
412             } else {
413                 if (Status.ABORTED.toString().equalsIgnoreCase(iar.getRequestStatus())
414                         || Status.ROLLED_BACK.toString().equalsIgnoreCase(iar.getRequestStatus())
415                         || Status.ROLLED_BACK_TO_ASSIGNED.toString().equalsIgnoreCase(iar.getRequestStatus())
416                         || Status.ROLLED_BACK_TO_CREATED.toString().equalsIgnoreCase(iar.getRequestStatus())) {
417                     return Status.FAILED.toString();
418                 } else {
419                     return iar.getRequestStatus();
420                 }
421             }
422         }
423         return null;
424     }
425
426     protected void mapRequestStatusAndExtSysErrSrcToRequest(InfraActiveRequests iar, RequestStatus status,
427             String format) {
428         String rollbackStatusMessage = iar.getRollbackStatusMessage();
429         String flowStatusMessage = iar.getFlowStatus();
430         String retryStatusMessage = iar.getRetryStatusMessage();
431
432         String statusMessages = null;
433         if (iar.getStatusMessage() != null) {
434             statusMessages = "STATUS: " + iar.getStatusMessage();
435         }
436
437         if (OrchestrationRequestFormat.STATUSDETAIL.toString().equalsIgnoreCase(format)) {
438             if (flowStatusMessage != null) {
439                 status.setFlowStatus(flowStatusMessage);
440             }
441             if (retryStatusMessage != null) {
442                 status.setRetryStatusMessage(retryStatusMessage);
443             }
444             if (rollbackStatusMessage != null) {
445                 status.setRollbackStatusMessage(rollbackStatusMessage);
446             }
447             status.setExtSystemErrorSource(iar.getExtSystemErrorSource());
448             status.setRollbackExtSystemErrorSource(iar.getRollbackExtSystemErrorSource());
449         } else {
450
451             if (flowStatusMessage != null) {
452                 if (statusMessages != null) {
453                     statusMessages = statusMessages + " " + "FLOW STATUS: " + flowStatusMessage;
454                 } else {
455                     statusMessages = "FLOW STATUS: " + flowStatusMessage;
456                 }
457             }
458             if (retryStatusMessage != null) {
459                 if (statusMessages != null) {
460                     statusMessages = statusMessages + " " + "RETRY STATUS: " + retryStatusMessage;
461                 } else {
462                     statusMessages = "RETRY STATUS: " + retryStatusMessage;
463                 }
464             }
465             if (rollbackStatusMessage != null) {
466                 if (statusMessages != null) {
467                     statusMessages = statusMessages + " " + "ROLLBACK STATUS: " + rollbackStatusMessage;
468                 } else {
469                     statusMessages = "ROLLBACK STATUS: " + rollbackStatusMessage;
470                 }
471             }
472         }
473
474         if (statusMessages != null) {
475             status.setStatusMessage(statusMessages);
476         }
477     }
478
479     public List<org.onap.so.serviceinstancebeans.RequestProcessingData> mapRequestProcessingData(
480             List<org.onap.so.db.request.beans.RequestProcessingData> processingData) {
481         List<org.onap.so.serviceinstancebeans.RequestProcessingData> addedRequestProcessingData = new ArrayList<>();
482         org.onap.so.serviceinstancebeans.RequestProcessingData finalProcessingData =
483                 new org.onap.so.serviceinstancebeans.RequestProcessingData();
484         String currentGroupingId = null;
485         HashMap<String, String> tempMap = new HashMap<>();
486         List<HashMap<String, String>> tempList = new ArrayList<>();
487         for (RequestProcessingData data : processingData) {
488             String groupingId = data.getGroupingId();
489             String tag = data.getTag();
490             if (currentGroupingId == null || !currentGroupingId.equals(groupingId)) {
491                 if (!tempMap.isEmpty()) {
492                     tempList.add(tempMap);
493                     finalProcessingData.setDataPairs(tempList);
494                     addedRequestProcessingData.add(finalProcessingData);
495                 }
496                 finalProcessingData = new org.onap.so.serviceinstancebeans.RequestProcessingData();
497                 if (groupingId != null) {
498                     finalProcessingData.setGroupingId(groupingId);
499                 }
500                 if (tag != null) {
501                     finalProcessingData.setTag(tag);
502                 }
503                 currentGroupingId = groupingId;
504                 tempMap = new HashMap<>();
505                 tempList = new ArrayList<>();
506                 if (data.getName() != null && data.getValue() != null) {
507                     tempMap.put(data.getName(), data.getValue());
508                 }
509             } else {
510                 if (data.getName() != null && data.getValue() != null) {
511                     tempMap.put(data.getName(), data.getValue());
512                 }
513             }
514         }
515         if (tempMap.size() > 0) {
516             tempList.add(tempMap);
517             finalProcessingData.setDataPairs(tempList);
518         }
519         addedRequestProcessingData.add(finalProcessingData);
520         return addedRequestProcessingData;
521     }
522 }