2 * ============LICENSE_START=======================================================
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
13 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
23 package org.onap.so.apihandlerinfra;
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;
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.commons.lang3.EnumUtils;
46 import org.apache.http.HttpStatus;
47 import org.onap.so.apihandler.common.ErrorNumbers;
48 import org.onap.so.apihandler.common.ResponseBuilder;
49 import org.onap.so.apihandlerinfra.exceptions.ApiException;
50 import org.onap.so.apihandlerinfra.exceptions.ContactCamundaException;
51 import org.onap.so.apihandlerinfra.exceptions.ValidateException;
52 import org.onap.so.apihandlerinfra.logging.ErrorLoggerInfo;
53 import org.onap.so.constants.OrchestrationRequestFormat;
54 import org.onap.so.constants.Status;
55 import org.onap.so.db.request.beans.InfraActiveRequests;
56 import org.onap.so.db.request.beans.RequestProcessingData;
57 import org.onap.so.db.request.client.RequestsDbClient;
58 import org.onap.so.exceptions.ValidationException;
59 import org.onap.so.logger.ErrorCode;
60 import org.onap.so.logger.MessageEnum;
61 import org.onap.so.serviceinstancebeans.CloudRequestData;
62 import org.onap.so.serviceinstancebeans.GetOrchestrationListResponse;
63 import org.onap.so.serviceinstancebeans.GetOrchestrationResponse;
64 import org.onap.so.serviceinstancebeans.InstanceReferences;
65 import org.onap.so.serviceinstancebeans.Request;
66 import org.onap.so.serviceinstancebeans.RequestDetails;
67 import org.onap.so.serviceinstancebeans.RequestList;
68 import org.onap.so.serviceinstancebeans.RequestStatus;
69 import org.onap.so.serviceinstancebeans.ServiceInstancesRequest;
70 import org.onap.so.utils.UUIDChecker;
71 import org.slf4j.Logger;
72 import org.slf4j.LoggerFactory;
73 import org.springframework.beans.factory.annotation.Autowired;
74 import org.springframework.stereotype.Component;
75 import com.fasterxml.jackson.databind.ObjectMapper;
76 import io.swagger.v3.oas.annotations.OpenAPIDefinition;
77 import io.swagger.v3.oas.annotations.Operation;
78 import io.swagger.v3.oas.annotations.info.Info;
79 import io.swagger.v3.oas.annotations.media.ArraySchema;
80 import io.swagger.v3.oas.annotations.media.Content;
81 import io.swagger.v3.oas.annotations.media.Schema;
82 import io.swagger.v3.oas.annotations.responses.ApiResponse;
84 @Path("onap/so/infra/orchestrationRequests")
85 @OpenAPIDefinition(info = @Info(title = "onap/so/infra/orchestrationRequests",
86 description = "API Requests for Orchestration requests"))
89 public class OrchestrationRequests {
91 private static Logger logger = LoggerFactory.getLogger(OrchestrationRequests.class);
92 private static final String ERROR_MESSAGE_PREFIX = "Error Source: %s, Error Message: %s";
95 private RequestsDbClient requestsDbClient;
98 private MsoRequest msoRequest;
101 private ResponseBuilder builder;
104 private CamundaRequestHandler camundaRequestHandler;
107 @Path("/{version:[vV][4-7]}/{requestId}")
108 @Operation(description = "Find Orchestrated Requests for a given requestId", responses = @ApiResponse(
109 content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
110 @Produces(MediaType.APPLICATION_JSON)
112 public Response getOrchestrationRequest(@PathParam("requestId") String requestId,
113 @PathParam("version") String version, @QueryParam("includeCloudRequest") boolean includeCloudRequest,
114 @QueryParam(value = "format") String format) throws ApiException {
116 String apiVersion = version.substring(1);
117 GetOrchestrationResponse orchestrationResponse = new GetOrchestrationResponse();
119 InfraActiveRequests infraActiveRequest = null;
120 List<org.onap.so.db.request.beans.RequestProcessingData> requestProcessingData = null;
122 if (!UUIDChecker.isValidUUID(requestId)) {
124 ErrorLoggerInfo errorLoggerInfo =
125 new ErrorLoggerInfo.Builder(MessageEnum.APIH_VALIDATION_ERROR, ErrorCode.SchemaError)
126 .errorSource(Constants.MODIFIED_BY_APIHANDLER).build();
127 throw new ValidateException.Builder("Request Id " + requestId + " is not a valid UUID",
128 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).errorInfo(errorLoggerInfo).build();
131 infraActiveRequest = infraActiveRequestLookup(requestId);
134 requestProcessingData = requestsDbClient.getRequestProcessingDataBySoRequestId(requestId);
135 } catch (Exception e) {
136 logger.error("Exception occurred while communicating with RequestDb during requestProcessingData lookup ",
138 ErrorLoggerInfo errorLoggerInfo =
139 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.AvailabilityError).build();
141 ValidateException validateException = new ValidateException.Builder(
142 "Exception occurred while communicating with RequestDb during requestProcessingData lookup",
143 HttpStatus.SC_NOT_FOUND, ErrorNumbers.NO_COMMUNICATION_TO_REQUESTS_DB).cause(e)
144 .errorInfo(errorLoggerInfo).build();
146 throw validateException;
149 Request request = mapInfraActiveRequestToRequest(infraActiveRequest, includeCloudRequest, format);
151 if (!requestProcessingData.isEmpty()) {
152 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
154 request.setRequestId(requestId);
155 orchestrationResponse.setRequest(request);
157 return builder.buildResponse(HttpStatus.SC_OK, requestId, orchestrationResponse, apiVersion);
161 @Path("/{version:[vV][4-7]}")
162 @Operation(description = "Find Orchestrated Requests for a URI Information", responses = @ApiResponse(
163 content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
164 @Produces(MediaType.APPLICATION_JSON)
166 public Response getOrchestrationRequest(@Context UriInfo ui, @PathParam("version") String version,
167 @QueryParam("includeCloudRequest") boolean includeCloudRequest, @QueryParam(value = "format") String format)
168 throws ApiException {
170 MultivaluedMap<String, String> queryParams = ui.getQueryParameters();
172 List<InfraActiveRequests> activeRequests;
174 GetOrchestrationListResponse orchestrationList;
175 Map<String, List<String>> orchestrationMap;
176 String apiVersion = version.substring(1);
179 orchestrationMap = msoRequest.getOrchestrationFilters(queryParams);
180 if (orchestrationMap.isEmpty()) {
181 throw new ValidationException("At least one filter query param must be specified");
183 } catch (ValidationException ex) {
184 logger.error("Exception occurred", ex);
185 ErrorLoggerInfo errorLoggerInfo =
186 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.DataError).build();
187 ValidateException validateException =
188 new ValidateException.Builder(ex.getMessage(), HttpStatus.SC_BAD_REQUEST,
189 ErrorNumbers.SVC_GENERAL_SERVICE_ERROR).cause(ex).errorInfo(errorLoggerInfo).build();
190 throw validateException;
194 activeRequests = requestsDbClient.getOrchestrationFiltersFromInfraActive(orchestrationMap);
196 orchestrationList = new GetOrchestrationListResponse();
197 List<RequestList> requestLists = new ArrayList<>();
199 for (InfraActiveRequests infraActive : activeRequests) {
200 List<RequestProcessingData> requestProcessingData =
201 requestsDbClient.getRequestProcessingDataBySoRequestId(infraActive.getRequestId());
202 RequestList requestList = new RequestList();
203 Request request = mapInfraActiveRequestToRequest(infraActive, includeCloudRequest, format);
205 if (!requestProcessingData.isEmpty()) {
206 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
208 requestList.setRequest(request);
209 requestLists.add(requestList);
212 orchestrationList.setRequestList(requestLists);
213 return builder.buildResponse(HttpStatus.SC_OK, null, orchestrationList, apiVersion);
217 @Path("/{version: [vV][4-7]}/{requestId}/unlock")
218 @Consumes(MediaType.APPLICATION_JSON)
219 @Produces(MediaType.APPLICATION_JSON)
220 @Operation(description = "Unlock Orchestrated Requests for a given requestId", responses = @ApiResponse(
221 content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
223 public Response unlockOrchestrationRequest(String requestJSON, @PathParam("requestId") String requestId,
224 @PathParam("version") String version) throws ApiException {
226 logger.debug("requestId is: {}", requestId);
227 ServiceInstancesRequest sir;
230 ObjectMapper mapper = new ObjectMapper();
231 sir = mapper.readValue(requestJSON, ServiceInstancesRequest.class);
232 } catch (IOException e) {
233 logger.error("Exception occurred", e);
234 ErrorLoggerInfo errorLoggerInfo =
235 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
237 ValidateException validateException =
238 new ValidateException.Builder("Mapping of request to JSON object failed : " + e.getMessage(),
239 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
240 .errorInfo(errorLoggerInfo).build();
242 throw validateException;
246 msoRequest.parseOrchestration(sir);
247 } catch (Exception e) {
248 logger.error("Exception occurred", e);
249 ErrorLoggerInfo errorLoggerInfo =
250 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
252 ValidateException validateException =
253 new ValidateException.Builder("Error parsing request: " + e.getMessage(), HttpStatus.SC_BAD_REQUEST,
254 ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
255 throw validateException;
258 InfraActiveRequests infraActiveRequest = infraActiveRequestLookup(requestId);
260 String status = infraActiveRequest.getRequestStatus();
261 if (Status.IN_PROGRESS.toString().equalsIgnoreCase(status) || Status.PENDING.toString().equalsIgnoreCase(status)
262 || Status.PENDING_MANUAL_TASK.toString().equalsIgnoreCase(status)) {
263 infraActiveRequest.setRequestStatus(Status.UNLOCKED.toString());
264 infraActiveRequest.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
265 infraActiveRequest.setRequestId(requestId);
266 requestsDbClient.save(infraActiveRequest);
269 ErrorLoggerInfo errorLoggerInfo =
270 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND, ErrorCode.DataError).build();
272 ValidateException validateException = new ValidateException.Builder(
273 "Orchestration RequestId " + requestId + " has a status of " + status + " and can not be unlocked",
274 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
277 throw validateException;
279 return Response.status(HttpStatus.SC_NO_CONTENT).entity("").build();
282 protected Request mapInfraActiveRequestToRequest(InfraActiveRequests iar, boolean includeCloudRequest,
283 String format) throws ApiException {
284 String requestBody = iar.getRequestBody();
285 Request request = new Request();
287 ObjectMapper mapper = new ObjectMapper();
289 request.setRequestId(iar.getRequestId());
290 request.setRequestScope(iar.getRequestScope());
291 request.setRequestType(iar.getRequestAction());
293 String originalRequestId = iar.getOriginalRequestId();
294 if (originalRequestId != null) {
295 request.setOriginalRequestId(originalRequestId);
298 InstanceReferences ir = new InstanceReferences();
299 if (iar.getNetworkId() != null)
300 ir.setNetworkInstanceId(iar.getNetworkId());
301 if (iar.getNetworkName() != null)
302 ir.setNetworkInstanceName(iar.getNetworkName());
303 if (iar.getServiceInstanceId() != null)
304 ir.setServiceInstanceId(iar.getServiceInstanceId());
305 if (iar.getServiceInstanceName() != null)
306 ir.setServiceInstanceName(iar.getServiceInstanceName());
307 if (iar.getVfModuleId() != null)
308 ir.setVfModuleInstanceId(iar.getVfModuleId());
309 if (iar.getVfModuleName() != null)
310 ir.setVfModuleInstanceName(iar.getVfModuleName());
311 if (iar.getVnfId() != null)
312 ir.setVnfInstanceId(iar.getVnfId());
313 if (iar.getVnfName() != null)
314 ir.setVnfInstanceName(iar.getVnfName());
315 if (iar.getVolumeGroupId() != null)
316 ir.setVolumeGroupInstanceId(iar.getVolumeGroupId());
317 if (iar.getVolumeGroupName() != null)
318 ir.setVolumeGroupInstanceName(iar.getVolumeGroupName());
319 if (iar.getRequestorId() != null)
320 ir.setRequestorId(iar.getRequestorId());
321 if (iar.getInstanceGroupId() != null)
322 ir.setInstanceGroupId(iar.getInstanceGroupId());
323 if (iar.getInstanceGroupName() != null)
324 ir.setInstanceGroupName(iar.getInstanceGroupName());
326 request.setInstanceReferences(ir);
328 RequestDetails requestDetails = null;
330 if (StringUtils.isNotBlank(requestBody)) {
332 if (requestBody.contains("\"requestDetails\":")) {
333 ServiceInstancesRequest sir = mapper.readValue(requestBody, ServiceInstancesRequest.class);
334 requestDetails = sir.getRequestDetails();
336 requestDetails = mapper.readValue(requestBody, RequestDetails.class);
338 } catch (IOException e) {
339 logger.error("Exception occurred", e);
340 ErrorLoggerInfo errorLoggerInfo =
341 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
343 ValidateException validateException =
344 new ValidateException.Builder("Mapping of request to JSON object failed : ",
345 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
346 .errorInfo(errorLoggerInfo).build();
348 throw validateException;
351 request.setRequestDetails(requestDetails);
353 if (iar.getStartTime() != null) {
354 String startTimeStamp =
355 new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getStartTime()) + " GMT";
356 request.setStartTime(startTimeStamp);
358 if (iar.getEndTime() != null) {
359 String endTimeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getEndTime()) + " GMT";
360 request.setFinishTime(endTimeStamp);
363 RequestStatus status = new RequestStatus();
365 if (iar.getModifyTime() != null) {
366 String timeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getModifyTime()) + " GMT";
367 status.setTimeStamp(timeStamp);
370 status.setRequestState(mapRequestStatusToRequest(iar, format));
372 if (iar.getProgress() != null) {
373 status.setPercentProgress(iar.getProgress().intValue());
376 if (iar.getCloudApiRequests() != null && !iar.getCloudApiRequests().isEmpty() && includeCloudRequest) {
377 iar.getCloudApiRequests().stream().forEach(cloudRequest -> {
379 request.getCloudRequestData()
380 .add(new CloudRequestData(mapper.readValue(cloudRequest.getRequestBody(), Object.class),
381 cloudRequest.getCloudIdentifier()));
382 } catch (Exception e) {
383 logger.error("Error reading Cloud Request", e);
388 mapRequestStatusAndExtSysErrSrcToRequest(iar, status, format);
390 request.setRequestStatus(status);
394 protected String mapRequestStatusToRequest(InfraActiveRequests iar, String format) {
395 if (iar.getRequestStatus() != null) {
396 boolean requestFormat = false;
397 if (format != null) {
398 requestFormat = EnumUtils.isValidEnum(OrchestrationRequestFormat.class, format.toUpperCase());
401 return iar.getRequestStatus();
403 if (Status.ABORTED.toString().equalsIgnoreCase(iar.getRequestStatus())
404 || Status.ROLLED_BACK.toString().equalsIgnoreCase(iar.getRequestStatus())
405 || Status.ROLLED_BACK_TO_ASSIGNED.toString().equalsIgnoreCase(iar.getRequestStatus())
406 || Status.ROLLED_BACK_TO_CREATED.toString().equalsIgnoreCase(iar.getRequestStatus())) {
407 return Status.FAILED.toString();
409 return iar.getRequestStatus();
416 protected void mapRequestStatusAndExtSysErrSrcToRequest(InfraActiveRequests iar, RequestStatus status,
418 String rollbackStatusMessage = iar.getRollbackStatusMessage();
419 String flowStatusMessage = iar.getFlowStatus();
420 String retryStatusMessage = iar.getRetryStatusMessage();
421 String taskName = null;
423 if (flowStatusMessage != null && !flowStatusMessage.equals("Successfully completed all Building Blocks")
424 && !flowStatusMessage.equals("All Rollback flows have completed successfully")) {
425 taskName = camundaRequestHandler.getTaskName(iar.getRequestId());
426 if (taskName != null) {
427 flowStatusMessage = flowStatusMessage + " TASK INFORMATION: " + taskName;
431 String statusMessages = null;
432 if (iar.getStatusMessage() != null) {
433 if (StringUtils.isNotBlank(iar.getExtSystemErrorSource())) {
434 statusMessages = "STATUS: "
435 + String.format(ERROR_MESSAGE_PREFIX, iar.getExtSystemErrorSource(), iar.getStatusMessage());
437 statusMessages = "STATUS: " + iar.getStatusMessage();
441 if (OrchestrationRequestFormat.STATUSDETAIL.toString().equalsIgnoreCase(format)) {
442 if (flowStatusMessage != null) {
443 status.setFlowStatus(flowStatusMessage);
445 if (retryStatusMessage != null) {
446 status.setRetryStatusMessage(retryStatusMessage);
448 if (rollbackStatusMessage != null) {
449 status.setRollbackStatusMessage(rollbackStatusMessage);
451 status.setExtSystemErrorSource(iar.getExtSystemErrorSource());
452 status.setRollbackExtSystemErrorSource(iar.getRollbackExtSystemErrorSource());
455 if (flowStatusMessage != null) {
456 if (statusMessages != null) {
457 statusMessages = statusMessages + " " + "FLOW STATUS: " + flowStatusMessage;
459 statusMessages = "FLOW STATUS: " + flowStatusMessage;
462 if (retryStatusMessage != null) {
463 if (statusMessages != null) {
464 statusMessages = statusMessages + " " + "RETRY STATUS: " + retryStatusMessage;
466 statusMessages = "RETRY STATUS: " + retryStatusMessage;
469 if (rollbackStatusMessage != null) {
470 if (statusMessages != null) {
471 statusMessages = statusMessages + " " + "ROLLBACK STATUS: " + rollbackStatusMessage;
473 statusMessages = "ROLLBACK STATUS: " + rollbackStatusMessage;
478 if (statusMessages != null) {
479 status.setStatusMessage(statusMessages);
483 public List<org.onap.so.serviceinstancebeans.RequestProcessingData> mapRequestProcessingData(
484 List<org.onap.so.db.request.beans.RequestProcessingData> processingData) {
485 List<org.onap.so.serviceinstancebeans.RequestProcessingData> addedRequestProcessingData = new ArrayList<>();
486 org.onap.so.serviceinstancebeans.RequestProcessingData finalProcessingData =
487 new org.onap.so.serviceinstancebeans.RequestProcessingData();
488 String currentGroupingId = null;
489 HashMap<String, String> tempMap = new HashMap<>();
490 List<HashMap<String, String>> tempList = new ArrayList<>();
491 for (RequestProcessingData data : processingData) {
492 String groupingId = data.getGroupingId();
493 String tag = data.getTag();
494 if (currentGroupingId == null || !currentGroupingId.equals(groupingId)) {
495 if (!tempMap.isEmpty()) {
496 tempList.add(tempMap);
497 finalProcessingData.setDataPairs(tempList);
498 addedRequestProcessingData.add(finalProcessingData);
500 finalProcessingData = new org.onap.so.serviceinstancebeans.RequestProcessingData();
501 if (groupingId != null) {
502 finalProcessingData.setGroupingId(groupingId);
505 finalProcessingData.setTag(tag);
507 currentGroupingId = groupingId;
508 tempMap = new HashMap<>();
509 tempList = new ArrayList<>();
510 if (data.getName() != null && data.getValue() != null) {
511 tempMap.put(data.getName(), data.getValue());
514 if (data.getName() != null && data.getValue() != null) {
515 tempMap.put(data.getName(), data.getValue());
519 if (tempMap.size() > 0) {
520 tempList.add(tempMap);
521 finalProcessingData.setDataPairs(tempList);
523 addedRequestProcessingData.add(finalProcessingData);
524 return addedRequestProcessingData;
527 protected InfraActiveRequests infraActiveRequestLookup(String requestId) throws ApiException {
528 InfraActiveRequests infraActiveRequest = null;
530 infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
531 } catch (Exception e) {
532 logger.error("Exception occurred while communicating with RequestDb during InfraActiveRequest lookup ", e);
533 ErrorLoggerInfo errorLoggerInfo =
534 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.AvailabilityError).build();
536 ValidateException validateException = new ValidateException.Builder(
537 "Exception occurred while communicating with RequestDb during InfraActiveRequest lookup",
538 HttpStatus.SC_NOT_FOUND, ErrorNumbers.NO_COMMUNICATION_TO_REQUESTS_DB).cause(e)
539 .errorInfo(errorLoggerInfo).build();
541 throw validateException;
544 if (infraActiveRequest == null) {
545 ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR,
546 ErrorCode.BusinessProcesssError).build();
548 ValidateException validateException = new ValidateException.Builder(
549 "Null response from RequestDB when searching by RequestId " + requestId, HttpStatus.SC_NOT_FOUND,
550 ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo).build();
552 throw validateException;
554 return infraActiveRequest;