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.annotations.Api;
77 import io.swagger.annotations.ApiOperation;
80 @Path("onap/so/infra/orchestrationRequests")
81 @Api(value = "onap/so/infra/orchestrationRequests", description = "API Requests for Orchestration requests")
83 public class OrchestrationRequests {
85 private static Logger logger = LoggerFactory.getLogger(OrchestrationRequests.class);
86 private static final String ERROR_MESSAGE_PREFIX = "Error Source: %s, Error Message: %s";
89 private RequestsDbClient requestsDbClient;
92 private MsoRequest msoRequest;
95 private ResponseBuilder builder;
98 private CamundaRequestHandler camundaRequestHandler;
101 @Path("/{version:[vV][4-7]}/{requestId}")
102 @ApiOperation(value = "Find Orchestrated Requests for a given requestId", response = Response.class)
103 @Produces(MediaType.APPLICATION_JSON)
105 public Response getOrchestrationRequest(@PathParam("requestId") String requestId,
106 @PathParam("version") String version, @QueryParam("includeCloudRequest") boolean includeCloudRequest,
107 @QueryParam(value = "format") String format) throws ApiException {
109 String apiVersion = version.substring(1);
110 GetOrchestrationResponse orchestrationResponse = new GetOrchestrationResponse();
112 InfraActiveRequests infraActiveRequest = null;
113 List<org.onap.so.db.request.beans.RequestProcessingData> requestProcessingData = null;
115 if (!UUIDChecker.isValidUUID(requestId)) {
117 ErrorLoggerInfo errorLoggerInfo =
118 new ErrorLoggerInfo.Builder(MessageEnum.APIH_VALIDATION_ERROR, ErrorCode.SchemaError)
119 .errorSource(Constants.MODIFIED_BY_APIHANDLER).build();
120 throw new ValidateException.Builder("Request Id " + requestId + " is not a valid UUID",
121 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).errorInfo(errorLoggerInfo).build();
124 infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
125 requestProcessingData = requestsDbClient.getRequestProcessingDataBySoRequestId(requestId);
127 } catch (Exception e) {
128 logger.error("Exception occurred", e);
129 ErrorLoggerInfo errorLoggerInfo =
130 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.AvailabilityError).build();
132 ValidateException validateException =
133 new ValidateException.Builder("Exception while communciate with Request DB - Infra Request Lookup",
134 HttpStatus.SC_NOT_FOUND, ErrorNumbers.NO_COMMUNICATION_TO_REQUESTS_DB).cause(e)
135 .errorInfo(errorLoggerInfo).build();
137 throw validateException;
141 if (infraActiveRequest == null) {
143 ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR,
144 ErrorCode.BusinessProcesssError).build();
146 ValidateException validateException =
147 new ValidateException.Builder("Orchestration RequestId " + requestId + " is not found in DB",
148 HttpStatus.SC_NO_CONTENT, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR)
149 .errorInfo(errorLoggerInfo).build();
151 throw validateException;
154 Request request = mapInfraActiveRequestToRequest(infraActiveRequest, includeCloudRequest, format);
156 if (!requestProcessingData.isEmpty()) {
157 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
159 request.setRequestId(requestId);
160 orchestrationResponse.setRequest(request);
162 return builder.buildResponse(HttpStatus.SC_OK, requestId, orchestrationResponse, apiVersion);
166 @Path("/{version:[vV][4-7]}")
167 @ApiOperation(value = "Find Orchestrated Requests for a URI Information", response = Response.class)
168 @Produces(MediaType.APPLICATION_JSON)
170 public Response getOrchestrationRequest(@Context UriInfo ui, @PathParam("version") String version,
171 @QueryParam("includeCloudRequest") boolean includeCloudRequest, @QueryParam(value = "format") String format)
172 throws ApiException {
174 MultivaluedMap<String, String> queryParams = ui.getQueryParameters();
176 List<InfraActiveRequests> activeRequests;
178 GetOrchestrationListResponse orchestrationList;
179 Map<String, List<String>> orchestrationMap;
180 String apiVersion = version.substring(1);
183 orchestrationMap = msoRequest.getOrchestrationFilters(queryParams);
184 if (orchestrationMap.isEmpty()) {
185 throw new ValidationException("At least one filter query param must be specified");
187 } catch (ValidationException ex) {
188 logger.error("Exception occurred", ex);
189 ErrorLoggerInfo errorLoggerInfo =
190 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.DataError).build();
191 ValidateException validateException =
192 new ValidateException.Builder(ex.getMessage(), HttpStatus.SC_BAD_REQUEST,
193 ErrorNumbers.SVC_GENERAL_SERVICE_ERROR).cause(ex).errorInfo(errorLoggerInfo).build();
194 throw validateException;
198 activeRequests = requestsDbClient.getOrchestrationFiltersFromInfraActive(orchestrationMap);
200 orchestrationList = new GetOrchestrationListResponse();
201 List<RequestList> requestLists = new ArrayList<>();
203 for (InfraActiveRequests infraActive : activeRequests) {
204 List<RequestProcessingData> requestProcessingData =
205 requestsDbClient.getRequestProcessingDataBySoRequestId(infraActive.getRequestId());
206 RequestList requestList = new RequestList();
207 Request request = mapInfraActiveRequestToRequest(infraActive, includeCloudRequest, format);
209 if (!requestProcessingData.isEmpty()) {
210 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
212 requestList.setRequest(request);
213 requestLists.add(requestList);
216 orchestrationList.setRequestList(requestLists);
217 return builder.buildResponse(HttpStatus.SC_OK, null, orchestrationList, apiVersion);
221 @Path("/{version: [vV][4-7]}/{requestId}/unlock")
222 @Consumes(MediaType.APPLICATION_JSON)
223 @Produces(MediaType.APPLICATION_JSON)
224 @ApiOperation(value = "Unlock Orchestrated Requests for a given requestId", response = Response.class)
226 public Response unlockOrchestrationRequest(String requestJSON, @PathParam("requestId") String requestId,
227 @PathParam("version") String version) throws ApiException {
229 logger.debug("requestId is: {}", requestId);
230 ServiceInstancesRequest sir;
232 InfraActiveRequests infraActiveRequest;
235 ObjectMapper mapper = new ObjectMapper();
236 sir = mapper.readValue(requestJSON, ServiceInstancesRequest.class);
237 } catch (IOException e) {
238 logger.error("Exception occurred", e);
239 ErrorLoggerInfo errorLoggerInfo =
240 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
242 ValidateException validateException =
243 new ValidateException.Builder("Mapping of request to JSON object failed : " + e.getMessage(),
244 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
245 .errorInfo(errorLoggerInfo).build();
247 throw validateException;
251 msoRequest.parseOrchestration(sir);
252 } catch (Exception e) {
253 logger.error("Exception occurred", e);
254 ErrorLoggerInfo errorLoggerInfo =
255 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
257 ValidateException validateException =
258 new ValidateException.Builder("Error parsing request: " + e.getMessage(), HttpStatus.SC_BAD_REQUEST,
259 ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
260 throw validateException;
263 infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
264 if (infraActiveRequest == null) {
265 ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND,
266 ErrorCode.BusinessProcesssError).build();
268 ValidateException validateException =
269 new ValidateException.Builder("Null response from RequestDB when searching by RequestId",
270 HttpStatus.SC_NOT_FOUND, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
273 throw validateException;
276 String status = infraActiveRequest.getRequestStatus();
277 if (Status.IN_PROGRESS.toString().equalsIgnoreCase(status)
278 || Status.PENDING.toString().equalsIgnoreCase(status)
279 || Status.PENDING_MANUAL_TASK.toString().equalsIgnoreCase(status)) {
280 infraActiveRequest.setRequestStatus(Status.UNLOCKED.toString());
281 infraActiveRequest.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
282 infraActiveRequest.setRequestId(requestId);
283 requestsDbClient.save(infraActiveRequest);
286 ErrorLoggerInfo errorLoggerInfo =
287 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND, ErrorCode.DataError)
290 ValidateException validateException = new ValidateException.Builder(
291 "Orchestration RequestId " + requestId + " has a status of " + status
292 + " and can not be unlocked",
293 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
296 throw validateException;
299 return Response.status(HttpStatus.SC_NO_CONTENT).entity("").build();
302 protected Request mapInfraActiveRequestToRequest(InfraActiveRequests iar, boolean includeCloudRequest,
303 String format) throws ApiException {
304 String requestBody = iar.getRequestBody();
305 Request request = new Request();
307 ObjectMapper mapper = new ObjectMapper();
309 request.setRequestId(iar.getRequestId());
310 request.setRequestScope(iar.getRequestScope());
311 request.setRequestType(iar.getRequestAction());
313 String originalRequestId = iar.getOriginalRequestId();
314 if (originalRequestId != null) {
315 request.setOriginalRequestId(originalRequestId);
318 InstanceReferences ir = new InstanceReferences();
319 if (iar.getNetworkId() != null)
320 ir.setNetworkInstanceId(iar.getNetworkId());
321 if (iar.getNetworkName() != null)
322 ir.setNetworkInstanceName(iar.getNetworkName());
323 if (iar.getServiceInstanceId() != null)
324 ir.setServiceInstanceId(iar.getServiceInstanceId());
325 if (iar.getServiceInstanceName() != null)
326 ir.setServiceInstanceName(iar.getServiceInstanceName());
327 if (iar.getVfModuleId() != null)
328 ir.setVfModuleInstanceId(iar.getVfModuleId());
329 if (iar.getVfModuleName() != null)
330 ir.setVfModuleInstanceName(iar.getVfModuleName());
331 if (iar.getVnfId() != null)
332 ir.setVnfInstanceId(iar.getVnfId());
333 if (iar.getVnfName() != null)
334 ir.setVnfInstanceName(iar.getVnfName());
335 if (iar.getVolumeGroupId() != null)
336 ir.setVolumeGroupInstanceId(iar.getVolumeGroupId());
337 if (iar.getVolumeGroupName() != null)
338 ir.setVolumeGroupInstanceName(iar.getVolumeGroupName());
339 if (iar.getRequestorId() != null)
340 ir.setRequestorId(iar.getRequestorId());
341 if (iar.getInstanceGroupId() != null)
342 ir.setInstanceGroupId(iar.getInstanceGroupId());
343 if (iar.getInstanceGroupName() != null)
344 ir.setInstanceGroupName(iar.getInstanceGroupName());
346 request.setInstanceReferences(ir);
348 RequestDetails requestDetails = null;
350 if (StringUtils.isNotBlank(requestBody)) {
352 if (requestBody.contains("\"requestDetails\":")) {
353 ServiceInstancesRequest sir = mapper.readValue(requestBody, ServiceInstancesRequest.class);
354 requestDetails = sir.getRequestDetails();
356 requestDetails = mapper.readValue(requestBody, RequestDetails.class);
358 } catch (IOException e) {
359 logger.error("Exception occurred", e);
360 ErrorLoggerInfo errorLoggerInfo =
361 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
363 ValidateException validateException =
364 new ValidateException.Builder("Mapping of request to JSON object failed : ",
365 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
366 .errorInfo(errorLoggerInfo).build();
368 throw validateException;
371 request.setRequestDetails(requestDetails);
373 if (iar.getStartTime() != null) {
374 String startTimeStamp =
375 new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getStartTime()) + " GMT";
376 request.setStartTime(startTimeStamp);
378 if (iar.getEndTime() != null) {
379 String endTimeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getEndTime()) + " GMT";
380 request.setFinishTime(endTimeStamp);
383 RequestStatus status = new RequestStatus();
385 if (iar.getModifyTime() != null) {
386 String timeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getModifyTime()) + " GMT";
387 status.setTimeStamp(timeStamp);
390 status.setRequestState(mapRequestStatusToRequest(iar, format));
392 if (iar.getProgress() != null) {
393 status.setPercentProgress(iar.getProgress().intValue());
396 if (iar.getCloudApiRequests() != null && !iar.getCloudApiRequests().isEmpty() && includeCloudRequest) {
397 iar.getCloudApiRequests().stream().forEach(cloudRequest -> {
399 request.getCloudRequestData()
400 .add(new CloudRequestData(mapper.readValue(cloudRequest.getRequestBody(), Object.class),
401 cloudRequest.getCloudIdentifier()));
402 } catch (Exception e) {
403 logger.error("Error reading Cloud Request", e);
408 mapRequestStatusAndExtSysErrSrcToRequest(iar, status, format);
410 request.setRequestStatus(status);
414 protected String mapRequestStatusToRequest(InfraActiveRequests iar, String format) {
415 if (iar.getRequestStatus() != null) {
416 boolean requestFormat = false;
417 if (format != null) {
418 requestFormat = EnumUtils.isValidEnum(OrchestrationRequestFormat.class, format.toUpperCase());
421 return iar.getRequestStatus();
423 if (Status.ABORTED.toString().equalsIgnoreCase(iar.getRequestStatus())
424 || Status.ROLLED_BACK.toString().equalsIgnoreCase(iar.getRequestStatus())
425 || Status.ROLLED_BACK_TO_ASSIGNED.toString().equalsIgnoreCase(iar.getRequestStatus())
426 || Status.ROLLED_BACK_TO_CREATED.toString().equalsIgnoreCase(iar.getRequestStatus())) {
427 return Status.FAILED.toString();
429 return iar.getRequestStatus();
436 protected void mapRequestStatusAndExtSysErrSrcToRequest(InfraActiveRequests iar, RequestStatus status,
437 String format) throws ContactCamundaException {
438 String rollbackStatusMessage = iar.getRollbackStatusMessage();
439 String flowStatusMessage = iar.getFlowStatus();
440 String retryStatusMessage = iar.getRetryStatusMessage();
441 String taskName = null;
443 if (flowStatusMessage != null && !flowStatusMessage.equals("Successfully completed all Building Blocks")
444 && !flowStatusMessage.equals("All Rollback flows have completed successfully")) {
445 taskName = camundaRequestHandler.getTaskName(iar.getRequestId());
446 if (taskName != null) {
447 flowStatusMessage = flowStatusMessage + " TASK INFORMATION: " + taskName;
451 String statusMessages = null;
452 if (iar.getStatusMessage() != null) {
453 if (StringUtils.isNotBlank(iar.getExtSystemErrorSource())) {
454 statusMessages = "STATUS: "
455 + String.format(ERROR_MESSAGE_PREFIX, iar.getExtSystemErrorSource(), iar.getStatusMessage());
457 statusMessages = "STATUS: " + iar.getStatusMessage();
461 if (OrchestrationRequestFormat.STATUSDETAIL.toString().equalsIgnoreCase(format)) {
462 if (flowStatusMessage != null) {
463 status.setFlowStatus(flowStatusMessage);
465 if (retryStatusMessage != null) {
466 status.setRetryStatusMessage(retryStatusMessage);
468 if (rollbackStatusMessage != null) {
469 status.setRollbackStatusMessage(rollbackStatusMessage);
471 status.setExtSystemErrorSource(iar.getExtSystemErrorSource());
472 status.setRollbackExtSystemErrorSource(iar.getRollbackExtSystemErrorSource());
475 if (flowStatusMessage != null) {
476 if (statusMessages != null) {
477 statusMessages = statusMessages + " " + "FLOW STATUS: " + flowStatusMessage;
479 statusMessages = "FLOW STATUS: " + flowStatusMessage;
482 if (retryStatusMessage != null) {
483 if (statusMessages != null) {
484 statusMessages = statusMessages + " " + "RETRY STATUS: " + retryStatusMessage;
486 statusMessages = "RETRY STATUS: " + retryStatusMessage;
489 if (rollbackStatusMessage != null) {
490 if (statusMessages != null) {
491 statusMessages = statusMessages + " " + "ROLLBACK STATUS: " + rollbackStatusMessage;
493 statusMessages = "ROLLBACK STATUS: " + rollbackStatusMessage;
498 if (statusMessages != null) {
499 status.setStatusMessage(statusMessages);
503 public List<org.onap.so.serviceinstancebeans.RequestProcessingData> mapRequestProcessingData(
504 List<org.onap.so.db.request.beans.RequestProcessingData> processingData) {
505 List<org.onap.so.serviceinstancebeans.RequestProcessingData> addedRequestProcessingData = new ArrayList<>();
506 org.onap.so.serviceinstancebeans.RequestProcessingData finalProcessingData =
507 new org.onap.so.serviceinstancebeans.RequestProcessingData();
508 String currentGroupingId = null;
509 HashMap<String, String> tempMap = new HashMap<>();
510 List<HashMap<String, String>> tempList = new ArrayList<>();
511 for (RequestProcessingData data : processingData) {
512 String groupingId = data.getGroupingId();
513 String tag = data.getTag();
514 if (currentGroupingId == null || !currentGroupingId.equals(groupingId)) {
515 if (!tempMap.isEmpty()) {
516 tempList.add(tempMap);
517 finalProcessingData.setDataPairs(tempList);
518 addedRequestProcessingData.add(finalProcessingData);
520 finalProcessingData = new org.onap.so.serviceinstancebeans.RequestProcessingData();
521 if (groupingId != null) {
522 finalProcessingData.setGroupingId(groupingId);
525 finalProcessingData.setTag(tag);
527 currentGroupingId = groupingId;
528 tempMap = new HashMap<>();
529 tempList = new ArrayList<>();
530 if (data.getName() != null && data.getValue() != null) {
531 tempMap.put(data.getName(), data.getValue());
534 if (data.getName() != null && data.getValue() != null) {
535 tempMap.put(data.getName(), data.getValue());
539 if (tempMap.size() > 0) {
540 tempList.add(tempMap);
541 finalProcessingData.setDataPairs(tempList);
543 addedRequestProcessingData.add(finalProcessingData);
544 return addedRequestProcessingData;