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;
85 @Path("onap/so/infra/orchestrationRequests")
86 @OpenAPIDefinition(info = @Info(title = "onap/so/infra/orchestrationRequests",
87 description = "API Requests for Orchestration requests"))
90 public class OrchestrationRequests {
92 private static Logger logger = LoggerFactory.getLogger(OrchestrationRequests.class);
93 private static final String ERROR_MESSAGE_PREFIX = "Error Source: %s, Error Message: %s";
96 private RequestsDbClient requestsDbClient;
99 private MsoRequest msoRequest;
102 private ResponseBuilder builder;
105 private CamundaRequestHandler camundaRequestHandler;
108 @Path("/{version:[vV][4-7]}/{requestId}")
109 @Operation(description = "Find Orchestrated Requests for a given requestId", responses = @ApiResponse(
110 content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
111 @Produces(MediaType.APPLICATION_JSON)
113 public Response getOrchestrationRequest(@PathParam("requestId") String requestId,
114 @PathParam("version") String version, @QueryParam("includeCloudRequest") boolean includeCloudRequest,
115 @QueryParam(value = "format") String format) throws ApiException {
117 String apiVersion = version.substring(1);
118 GetOrchestrationResponse orchestrationResponse = new GetOrchestrationResponse();
120 InfraActiveRequests infraActiveRequest = null;
121 List<org.onap.so.db.request.beans.RequestProcessingData> requestProcessingData = null;
123 if (!UUIDChecker.isValidUUID(requestId)) {
125 ErrorLoggerInfo errorLoggerInfo =
126 new ErrorLoggerInfo.Builder(MessageEnum.APIH_VALIDATION_ERROR, ErrorCode.SchemaError)
127 .errorSource(Constants.MODIFIED_BY_APIHANDLER).build();
128 throw new ValidateException.Builder("Request Id " + requestId + " is not a valid UUID",
129 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).errorInfo(errorLoggerInfo).build();
132 infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
133 requestProcessingData = requestsDbClient.getRequestProcessingDataBySoRequestId(requestId);
135 } catch (Exception e) {
136 logger.error("Exception occurred", e);
137 ErrorLoggerInfo errorLoggerInfo =
138 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.AvailabilityError).build();
140 ValidateException validateException =
141 new ValidateException.Builder("Exception while communciate with Request DB - Infra Request Lookup",
142 HttpStatus.SC_NOT_FOUND, ErrorNumbers.NO_COMMUNICATION_TO_REQUESTS_DB).cause(e)
143 .errorInfo(errorLoggerInfo).build();
145 throw validateException;
149 if (infraActiveRequest == null) {
151 ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR,
152 ErrorCode.BusinessProcesssError).build();
154 ValidateException validateException =
155 new ValidateException.Builder("Orchestration RequestId " + requestId + " is not found in DB",
156 HttpStatus.SC_NO_CONTENT, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR)
157 .errorInfo(errorLoggerInfo).build();
159 throw validateException;
162 Request request = mapInfraActiveRequestToRequest(infraActiveRequest, includeCloudRequest, format);
164 if (!requestProcessingData.isEmpty()) {
165 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
167 request.setRequestId(requestId);
168 orchestrationResponse.setRequest(request);
170 return builder.buildResponse(HttpStatus.SC_OK, requestId, orchestrationResponse, apiVersion);
174 @Path("/{version:[vV][4-7]}")
175 @Operation(description = "Find Orchestrated Requests for a URI Information", responses = @ApiResponse(
176 content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
177 @Produces(MediaType.APPLICATION_JSON)
179 public Response getOrchestrationRequest(@Context UriInfo ui, @PathParam("version") String version,
180 @QueryParam("includeCloudRequest") boolean includeCloudRequest, @QueryParam(value = "format") String format)
181 throws ApiException {
183 MultivaluedMap<String, String> queryParams = ui.getQueryParameters();
185 List<InfraActiveRequests> activeRequests;
187 GetOrchestrationListResponse orchestrationList;
188 Map<String, List<String>> orchestrationMap;
189 String apiVersion = version.substring(1);
192 orchestrationMap = msoRequest.getOrchestrationFilters(queryParams);
193 if (orchestrationMap.isEmpty()) {
194 throw new ValidationException("At least one filter query param must be specified");
196 } catch (ValidationException ex) {
197 logger.error("Exception occurred", ex);
198 ErrorLoggerInfo errorLoggerInfo =
199 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.DataError).build();
200 ValidateException validateException =
201 new ValidateException.Builder(ex.getMessage(), HttpStatus.SC_BAD_REQUEST,
202 ErrorNumbers.SVC_GENERAL_SERVICE_ERROR).cause(ex).errorInfo(errorLoggerInfo).build();
203 throw validateException;
207 activeRequests = requestsDbClient.getOrchestrationFiltersFromInfraActive(orchestrationMap);
209 orchestrationList = new GetOrchestrationListResponse();
210 List<RequestList> requestLists = new ArrayList<>();
212 for (InfraActiveRequests infraActive : activeRequests) {
213 List<RequestProcessingData> requestProcessingData =
214 requestsDbClient.getRequestProcessingDataBySoRequestId(infraActive.getRequestId());
215 RequestList requestList = new RequestList();
216 Request request = mapInfraActiveRequestToRequest(infraActive, includeCloudRequest, format);
218 if (!requestProcessingData.isEmpty()) {
219 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
221 requestList.setRequest(request);
222 requestLists.add(requestList);
225 orchestrationList.setRequestList(requestLists);
226 return builder.buildResponse(HttpStatus.SC_OK, null, orchestrationList, apiVersion);
230 @Path("/{version: [vV][4-7]}/{requestId}/unlock")
231 @Consumes(MediaType.APPLICATION_JSON)
232 @Produces(MediaType.APPLICATION_JSON)
233 @Operation(description = "Unlock Orchestrated Requests for a given requestId", responses = @ApiResponse(
234 content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))))
236 public Response unlockOrchestrationRequest(String requestJSON, @PathParam("requestId") String requestId,
237 @PathParam("version") String version) throws ApiException {
239 logger.debug("requestId is: {}", requestId);
240 ServiceInstancesRequest sir;
242 InfraActiveRequests infraActiveRequest;
245 ObjectMapper mapper = new ObjectMapper();
246 sir = mapper.readValue(requestJSON, ServiceInstancesRequest.class);
247 } catch (IOException 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("Mapping of request to JSON object failed : " + e.getMessage(),
254 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
255 .errorInfo(errorLoggerInfo).build();
257 throw validateException;
261 msoRequest.parseOrchestration(sir);
262 } catch (Exception e) {
263 logger.error("Exception occurred", e);
264 ErrorLoggerInfo errorLoggerInfo =
265 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
267 ValidateException validateException =
268 new ValidateException.Builder("Error parsing request: " + e.getMessage(), HttpStatus.SC_BAD_REQUEST,
269 ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
270 throw validateException;
273 infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
274 if (infraActiveRequest == null) {
275 ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND,
276 ErrorCode.BusinessProcesssError).build();
278 ValidateException validateException =
279 new ValidateException.Builder("Null response from RequestDB when searching by RequestId",
280 HttpStatus.SC_NOT_FOUND, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
283 throw validateException;
286 String status = infraActiveRequest.getRequestStatus();
287 if (Status.IN_PROGRESS.toString().equalsIgnoreCase(status)
288 || Status.PENDING.toString().equalsIgnoreCase(status)
289 || Status.PENDING_MANUAL_TASK.toString().equalsIgnoreCase(status)) {
290 infraActiveRequest.setRequestStatus(Status.UNLOCKED.toString());
291 infraActiveRequest.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
292 infraActiveRequest.setRequestId(requestId);
293 requestsDbClient.save(infraActiveRequest);
296 ErrorLoggerInfo errorLoggerInfo =
297 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND, ErrorCode.DataError)
300 ValidateException validateException = new ValidateException.Builder(
301 "Orchestration RequestId " + requestId + " has a status of " + status
302 + " and can not be unlocked",
303 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
306 throw validateException;
309 return Response.status(HttpStatus.SC_NO_CONTENT).entity("").build();
312 protected Request mapInfraActiveRequestToRequest(InfraActiveRequests iar, boolean includeCloudRequest,
313 String format) throws ApiException {
314 String requestBody = iar.getRequestBody();
315 Request request = new Request();
317 ObjectMapper mapper = new ObjectMapper();
319 request.setRequestId(iar.getRequestId());
320 request.setRequestScope(iar.getRequestScope());
321 request.setRequestType(iar.getRequestAction());
323 String originalRequestId = iar.getOriginalRequestId();
324 if (originalRequestId != null) {
325 request.setOriginalRequestId(originalRequestId);
328 InstanceReferences ir = new InstanceReferences();
329 if (iar.getNetworkId() != null)
330 ir.setNetworkInstanceId(iar.getNetworkId());
331 if (iar.getNetworkName() != null)
332 ir.setNetworkInstanceName(iar.getNetworkName());
333 if (iar.getServiceInstanceId() != null)
334 ir.setServiceInstanceId(iar.getServiceInstanceId());
335 if (iar.getServiceInstanceName() != null)
336 ir.setServiceInstanceName(iar.getServiceInstanceName());
337 if (iar.getVfModuleId() != null)
338 ir.setVfModuleInstanceId(iar.getVfModuleId());
339 if (iar.getVfModuleName() != null)
340 ir.setVfModuleInstanceName(iar.getVfModuleName());
341 if (iar.getVnfId() != null)
342 ir.setVnfInstanceId(iar.getVnfId());
343 if (iar.getVnfName() != null)
344 ir.setVnfInstanceName(iar.getVnfName());
345 if (iar.getVolumeGroupId() != null)
346 ir.setVolumeGroupInstanceId(iar.getVolumeGroupId());
347 if (iar.getVolumeGroupName() != null)
348 ir.setVolumeGroupInstanceName(iar.getVolumeGroupName());
349 if (iar.getRequestorId() != null)
350 ir.setRequestorId(iar.getRequestorId());
351 if (iar.getInstanceGroupId() != null)
352 ir.setInstanceGroupId(iar.getInstanceGroupId());
353 if (iar.getInstanceGroupName() != null)
354 ir.setInstanceGroupName(iar.getInstanceGroupName());
356 request.setInstanceReferences(ir);
358 RequestDetails requestDetails = null;
360 if (StringUtils.isNotBlank(requestBody)) {
362 if (requestBody.contains("\"requestDetails\":")) {
363 ServiceInstancesRequest sir = mapper.readValue(requestBody, ServiceInstancesRequest.class);
364 requestDetails = sir.getRequestDetails();
366 requestDetails = mapper.readValue(requestBody, RequestDetails.class);
368 } catch (IOException e) {
369 logger.error("Exception occurred", e);
370 ErrorLoggerInfo errorLoggerInfo =
371 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
373 ValidateException validateException =
374 new ValidateException.Builder("Mapping of request to JSON object failed : ",
375 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
376 .errorInfo(errorLoggerInfo).build();
378 throw validateException;
381 request.setRequestDetails(requestDetails);
383 if (iar.getStartTime() != null) {
384 String startTimeStamp =
385 new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getStartTime()) + " GMT";
386 request.setStartTime(startTimeStamp);
388 if (iar.getEndTime() != null) {
389 String endTimeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getEndTime()) + " GMT";
390 request.setFinishTime(endTimeStamp);
393 RequestStatus status = new RequestStatus();
395 if (iar.getModifyTime() != null) {
396 String timeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getModifyTime()) + " GMT";
397 status.setTimeStamp(timeStamp);
400 status.setRequestState(mapRequestStatusToRequest(iar, format));
402 if (iar.getProgress() != null) {
403 status.setPercentProgress(iar.getProgress().intValue());
406 if (iar.getCloudApiRequests() != null && !iar.getCloudApiRequests().isEmpty() && includeCloudRequest) {
407 iar.getCloudApiRequests().stream().forEach(cloudRequest -> {
409 request.getCloudRequestData()
410 .add(new CloudRequestData(mapper.readValue(cloudRequest.getRequestBody(), Object.class),
411 cloudRequest.getCloudIdentifier()));
412 } catch (Exception e) {
413 logger.error("Error reading Cloud Request", e);
418 mapRequestStatusAndExtSysErrSrcToRequest(iar, status, format);
420 request.setRequestStatus(status);
424 protected String mapRequestStatusToRequest(InfraActiveRequests iar, String format) {
425 if (iar.getRequestStatus() != null) {
426 boolean requestFormat = false;
427 if (format != null) {
428 requestFormat = EnumUtils.isValidEnum(OrchestrationRequestFormat.class, format.toUpperCase());
431 return iar.getRequestStatus();
433 if (Status.ABORTED.toString().equalsIgnoreCase(iar.getRequestStatus())
434 || Status.ROLLED_BACK.toString().equalsIgnoreCase(iar.getRequestStatus())
435 || Status.ROLLED_BACK_TO_ASSIGNED.toString().equalsIgnoreCase(iar.getRequestStatus())
436 || Status.ROLLED_BACK_TO_CREATED.toString().equalsIgnoreCase(iar.getRequestStatus())) {
437 return Status.FAILED.toString();
439 return iar.getRequestStatus();
446 protected void mapRequestStatusAndExtSysErrSrcToRequest(InfraActiveRequests iar, RequestStatus status,
447 String format) throws ContactCamundaException {
448 String rollbackStatusMessage = iar.getRollbackStatusMessage();
449 String flowStatusMessage = iar.getFlowStatus();
450 String retryStatusMessage = iar.getRetryStatusMessage();
451 String taskName = null;
453 if (flowStatusMessage != null && !flowStatusMessage.equals("Successfully completed all Building Blocks")
454 && !flowStatusMessage.equals("All Rollback flows have completed successfully")) {
455 taskName = camundaRequestHandler.getTaskName(iar.getRequestId());
456 if (taskName != null) {
457 flowStatusMessage = flowStatusMessage + " TASK INFORMATION: " + taskName;
461 String statusMessages = null;
462 if (iar.getStatusMessage() != null) {
463 if (StringUtils.isNotBlank(iar.getExtSystemErrorSource())) {
464 statusMessages = "STATUS: "
465 + String.format(ERROR_MESSAGE_PREFIX, iar.getExtSystemErrorSource(), iar.getStatusMessage());
467 statusMessages = "STATUS: " + iar.getStatusMessage();
471 if (OrchestrationRequestFormat.STATUSDETAIL.toString().equalsIgnoreCase(format)) {
472 if (flowStatusMessage != null) {
473 status.setFlowStatus(flowStatusMessage);
475 if (retryStatusMessage != null) {
476 status.setRetryStatusMessage(retryStatusMessage);
478 if (rollbackStatusMessage != null) {
479 status.setRollbackStatusMessage(rollbackStatusMessage);
481 status.setExtSystemErrorSource(iar.getExtSystemErrorSource());
482 status.setRollbackExtSystemErrorSource(iar.getRollbackExtSystemErrorSource());
485 if (flowStatusMessage != null) {
486 if (statusMessages != null) {
487 statusMessages = statusMessages + " " + "FLOW STATUS: " + flowStatusMessage;
489 statusMessages = "FLOW STATUS: " + flowStatusMessage;
492 if (retryStatusMessage != null) {
493 if (statusMessages != null) {
494 statusMessages = statusMessages + " " + "RETRY STATUS: " + retryStatusMessage;
496 statusMessages = "RETRY STATUS: " + retryStatusMessage;
499 if (rollbackStatusMessage != null) {
500 if (statusMessages != null) {
501 statusMessages = statusMessages + " " + "ROLLBACK STATUS: " + rollbackStatusMessage;
503 statusMessages = "ROLLBACK STATUS: " + rollbackStatusMessage;
508 if (statusMessages != null) {
509 status.setStatusMessage(statusMessages);
513 public List<org.onap.so.serviceinstancebeans.RequestProcessingData> mapRequestProcessingData(
514 List<org.onap.so.db.request.beans.RequestProcessingData> processingData) {
515 List<org.onap.so.serviceinstancebeans.RequestProcessingData> addedRequestProcessingData = new ArrayList<>();
516 org.onap.so.serviceinstancebeans.RequestProcessingData finalProcessingData =
517 new org.onap.so.serviceinstancebeans.RequestProcessingData();
518 String currentGroupingId = null;
519 HashMap<String, String> tempMap = new HashMap<>();
520 List<HashMap<String, String>> tempList = new ArrayList<>();
521 for (RequestProcessingData data : processingData) {
522 String groupingId = data.getGroupingId();
523 String tag = data.getTag();
524 if (currentGroupingId == null || !currentGroupingId.equals(groupingId)) {
525 if (!tempMap.isEmpty()) {
526 tempList.add(tempMap);
527 finalProcessingData.setDataPairs(tempList);
528 addedRequestProcessingData.add(finalProcessingData);
530 finalProcessingData = new org.onap.so.serviceinstancebeans.RequestProcessingData();
531 if (groupingId != null) {
532 finalProcessingData.setGroupingId(groupingId);
535 finalProcessingData.setTag(tag);
537 currentGroupingId = groupingId;
538 tempMap = new HashMap<>();
539 tempList = new ArrayList<>();
540 if (data.getName() != null && data.getValue() != null) {
541 tempMap.put(data.getName(), data.getValue());
544 if (data.getName() != null && data.getValue() != null) {
545 tempMap.put(data.getName(), data.getValue());
549 if (tempMap.size() > 0) {
550 tempList.add(tempMap);
551 finalProcessingData.setDataPairs(tempList);
553 addedRequestProcessingData.add(finalProcessingData);
554 return addedRequestProcessingData;