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.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.ContactCamundaException;
50 import org.onap.so.apihandlerinfra.exceptions.ValidateException;
51 import org.onap.so.apihandlerinfra.logging.ErrorLoggerInfo;
52 import org.onap.so.constants.OrchestrationRequestFormat;
53 import org.onap.so.constants.Status;
54 import org.onap.so.db.request.beans.InfraActiveRequests;
55 import org.onap.so.db.request.beans.RequestProcessingData;
56 import org.onap.so.db.request.client.RequestsDbClient;
57 import org.onap.so.exceptions.ValidationException;
58 import org.onap.so.logger.ErrorCode;
59 import org.onap.so.logger.MessageEnum;
60 import org.onap.so.serviceinstancebeans.CloudRequestData;
61 import org.onap.so.serviceinstancebeans.GetOrchestrationListResponse;
62 import org.onap.so.serviceinstancebeans.GetOrchestrationResponse;
63 import org.onap.so.serviceinstancebeans.InstanceReferences;
64 import org.onap.so.serviceinstancebeans.Request;
65 import org.onap.so.serviceinstancebeans.RequestDetails;
66 import org.onap.so.serviceinstancebeans.RequestList;
67 import org.onap.so.serviceinstancebeans.RequestStatus;
68 import org.onap.so.serviceinstancebeans.ServiceInstancesRequest;
69 import org.onap.so.utils.UUIDChecker;
70 import org.slf4j.Logger;
71 import org.slf4j.LoggerFactory;
72 import org.springframework.beans.factory.annotation.Autowired;
73 import org.springframework.stereotype.Component;
74 import com.fasterxml.jackson.databind.ObjectMapper;
75 import io.swagger.annotations.Api;
76 import io.swagger.annotations.ApiOperation;
79 @Path("onap/so/infra/orchestrationRequests")
80 @Api(value = "onap/so/infra/orchestrationRequests", description = "API Requests for Orchestration requests")
82 public class OrchestrationRequests {
84 private static Logger logger = LoggerFactory.getLogger(OrchestrationRequests.class);
87 private RequestsDbClient requestsDbClient;
90 private MsoRequest msoRequest;
93 private ResponseBuilder builder;
96 private CamundaRequestHandler camundaRequestHandler;
99 @Path("/{version:[vV][4-7]}/{requestId}")
100 @ApiOperation(value = "Find Orchestrated Requests for a given requestId", response = Response.class)
101 @Produces(MediaType.APPLICATION_JSON)
103 public Response getOrchestrationRequest(@PathParam("requestId") String requestId,
104 @PathParam("version") String version, @QueryParam("includeCloudRequest") boolean includeCloudRequest,
105 @QueryParam(value = "format") String format) throws ApiException {
107 String apiVersion = version.substring(1);
108 GetOrchestrationResponse orchestrationResponse = new GetOrchestrationResponse();
110 InfraActiveRequests infraActiveRequest = null;
111 List<org.onap.so.db.request.beans.RequestProcessingData> requestProcessingData = null;
113 if (!UUIDChecker.isValidUUID(requestId)) {
115 ErrorLoggerInfo errorLoggerInfo =
116 new ErrorLoggerInfo.Builder(MessageEnum.APIH_VALIDATION_ERROR, ErrorCode.SchemaError)
117 .errorSource(Constants.MODIFIED_BY_APIHANDLER).build();
118 throw new ValidateException.Builder("Request Id " + requestId + " is not a valid UUID",
119 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).errorInfo(errorLoggerInfo).build();
122 infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
123 requestProcessingData = requestsDbClient.getRequestProcessingDataBySoRequestId(requestId);
125 } catch (Exception e) {
126 logger.error("Exception occurred", e);
127 ErrorLoggerInfo errorLoggerInfo =
128 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.AvailabilityError).build();
130 ValidateException validateException =
131 new ValidateException.Builder("Exception while communciate with Request DB - Infra Request Lookup",
132 HttpStatus.SC_NOT_FOUND, ErrorNumbers.NO_COMMUNICATION_TO_REQUESTS_DB).cause(e)
133 .errorInfo(errorLoggerInfo).build();
135 throw validateException;
139 if (infraActiveRequest == null) {
141 ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR,
142 ErrorCode.BusinessProcesssError).build();
144 ValidateException validateException =
145 new ValidateException.Builder("Orchestration RequestId " + requestId + " is not found in DB",
146 HttpStatus.SC_NO_CONTENT, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR)
147 .errorInfo(errorLoggerInfo).build();
149 throw validateException;
152 Request request = mapInfraActiveRequestToRequest(infraActiveRequest, includeCloudRequest, format);
154 if (!requestProcessingData.isEmpty()) {
155 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
157 request.setRequestId(requestId);
158 orchestrationResponse.setRequest(request);
160 return builder.buildResponse(HttpStatus.SC_OK, requestId, orchestrationResponse, apiVersion);
164 @Path("/{version:[vV][4-7]}")
165 @ApiOperation(value = "Find Orchestrated Requests for a URI Information", response = Response.class)
166 @Produces(MediaType.APPLICATION_JSON)
168 public Response getOrchestrationRequest(@Context UriInfo ui, @PathParam("version") String version,
169 @QueryParam("includeCloudRequest") boolean includeCloudRequest, @QueryParam(value = "format") String format)
170 throws ApiException {
172 MultivaluedMap<String, String> queryParams = ui.getQueryParameters();
174 List<InfraActiveRequests> activeRequests;
176 GetOrchestrationListResponse orchestrationList;
177 Map<String, List<String>> orchestrationMap;
178 String apiVersion = version.substring(1);
181 orchestrationMap = msoRequest.getOrchestrationFilters(queryParams);
182 if (orchestrationMap.isEmpty()) {
183 throw new ValidationException("At least one filter query param must be specified");
185 } catch (ValidationException ex) {
186 logger.error("Exception occurred", ex);
187 ErrorLoggerInfo errorLoggerInfo =
188 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.DataError).build();
189 ValidateException validateException =
190 new ValidateException.Builder(ex.getMessage(), HttpStatus.SC_BAD_REQUEST,
191 ErrorNumbers.SVC_GENERAL_SERVICE_ERROR).cause(ex).errorInfo(errorLoggerInfo).build();
192 throw validateException;
196 activeRequests = requestsDbClient.getOrchestrationFiltersFromInfraActive(orchestrationMap);
198 orchestrationList = new GetOrchestrationListResponse();
199 List<RequestList> requestLists = new ArrayList<>();
201 for (InfraActiveRequests infraActive : activeRequests) {
202 List<RequestProcessingData> requestProcessingData =
203 requestsDbClient.getRequestProcessingDataBySoRequestId(infraActive.getRequestId());
204 RequestList requestList = new RequestList();
205 Request request = mapInfraActiveRequestToRequest(infraActive, includeCloudRequest, format);
207 if (!requestProcessingData.isEmpty()) {
208 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
210 requestList.setRequest(request);
211 requestLists.add(requestList);
214 orchestrationList.setRequestList(requestLists);
215 return builder.buildResponse(HttpStatus.SC_OK, null, orchestrationList, apiVersion);
219 @Path("/{version: [vV][4-7]}/{requestId}/unlock")
220 @Consumes(MediaType.APPLICATION_JSON)
221 @Produces(MediaType.APPLICATION_JSON)
222 @ApiOperation(value = "Unlock Orchestrated Requests for a given requestId", response = Response.class)
224 public Response unlockOrchestrationRequest(String requestJSON, @PathParam("requestId") String requestId,
225 @PathParam("version") String version) throws ApiException {
227 logger.debug("requestId is: {}", requestId);
228 ServiceInstancesRequest sir;
230 InfraActiveRequests infraActiveRequest;
233 ObjectMapper mapper = new ObjectMapper();
234 sir = mapper.readValue(requestJSON, ServiceInstancesRequest.class);
235 } catch (IOException e) {
236 logger.error("Exception occurred", e);
237 ErrorLoggerInfo errorLoggerInfo =
238 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
240 ValidateException validateException =
241 new ValidateException.Builder("Mapping of request to JSON object failed : " + e.getMessage(),
242 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
243 .errorInfo(errorLoggerInfo).build();
245 throw validateException;
249 msoRequest.parseOrchestration(sir);
250 } catch (Exception e) {
251 logger.error("Exception occurred", e);
252 ErrorLoggerInfo errorLoggerInfo =
253 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
255 ValidateException validateException =
256 new ValidateException.Builder("Error parsing request: " + e.getMessage(), HttpStatus.SC_BAD_REQUEST,
257 ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
258 throw validateException;
261 infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
262 if (infraActiveRequest == null) {
263 ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND,
264 ErrorCode.BusinessProcesssError).build();
266 ValidateException validateException =
267 new ValidateException.Builder("Null response from RequestDB when searching by RequestId",
268 HttpStatus.SC_NOT_FOUND, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
271 throw validateException;
274 String status = infraActiveRequest.getRequestStatus();
275 if (Status.IN_PROGRESS.toString().equalsIgnoreCase(status)
276 || Status.PENDING.toString().equalsIgnoreCase(status)
277 || Status.PENDING_MANUAL_TASK.toString().equalsIgnoreCase(status)) {
278 infraActiveRequest.setRequestStatus(Status.UNLOCKED.toString());
279 infraActiveRequest.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
280 infraActiveRequest.setRequestId(requestId);
281 requestsDbClient.save(infraActiveRequest);
284 ErrorLoggerInfo errorLoggerInfo =
285 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND, ErrorCode.DataError)
288 ValidateException validateException = new ValidateException.Builder(
289 "Orchestration RequestId " + requestId + " has a status of " + status
290 + " and can not be unlocked",
291 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
294 throw validateException;
297 return Response.status(HttpStatus.SC_NO_CONTENT).entity("").build();
300 protected Request mapInfraActiveRequestToRequest(InfraActiveRequests iar, boolean includeCloudRequest,
301 String format) throws ApiException {
302 String requestBody = iar.getRequestBody();
303 Request request = new Request();
305 ObjectMapper mapper = new ObjectMapper();
307 request.setRequestId(iar.getRequestId());
308 request.setRequestScope(iar.getRequestScope());
309 request.setRequestType(iar.getRequestAction());
311 String originalRequestId = iar.getOriginalRequestId();
312 if (originalRequestId != null) {
313 request.setOriginalRequestId(originalRequestId);
316 InstanceReferences ir = new InstanceReferences();
317 if (iar.getNetworkId() != null)
318 ir.setNetworkInstanceId(iar.getNetworkId());
319 if (iar.getNetworkName() != null)
320 ir.setNetworkInstanceName(iar.getNetworkName());
321 if (iar.getServiceInstanceId() != null)
322 ir.setServiceInstanceId(iar.getServiceInstanceId());
323 if (iar.getServiceInstanceName() != null)
324 ir.setServiceInstanceName(iar.getServiceInstanceName());
325 if (iar.getVfModuleId() != null)
326 ir.setVfModuleInstanceId(iar.getVfModuleId());
327 if (iar.getVfModuleName() != null)
328 ir.setVfModuleInstanceName(iar.getVfModuleName());
329 if (iar.getVnfId() != null)
330 ir.setVnfInstanceId(iar.getVnfId());
331 if (iar.getVnfName() != null)
332 ir.setVnfInstanceName(iar.getVnfName());
333 if (iar.getVolumeGroupId() != null)
334 ir.setVolumeGroupInstanceId(iar.getVolumeGroupId());
335 if (iar.getVolumeGroupName() != null)
336 ir.setVolumeGroupInstanceName(iar.getVolumeGroupName());
337 if (iar.getRequestorId() != null)
338 ir.setRequestorId(iar.getRequestorId());
339 if (iar.getInstanceGroupId() != null)
340 ir.setInstanceGroupId(iar.getInstanceGroupId());
341 if (iar.getInstanceGroupName() != null)
342 ir.setInstanceGroupName(iar.getInstanceGroupName());
344 request.setInstanceReferences(ir);
346 RequestDetails requestDetails = null;
348 if (StringUtils.isNotBlank(requestBody)) {
350 if (requestBody.contains("\"requestDetails\":")) {
351 ServiceInstancesRequest sir = mapper.readValue(requestBody, ServiceInstancesRequest.class);
352 requestDetails = sir.getRequestDetails();
354 requestDetails = mapper.readValue(requestBody, RequestDetails.class);
356 } catch (IOException e) {
357 logger.error("Exception occurred", e);
358 ErrorLoggerInfo errorLoggerInfo =
359 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
361 ValidateException validateException =
362 new ValidateException.Builder("Mapping of request to JSON object failed : ",
363 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
364 .errorInfo(errorLoggerInfo).build();
366 throw validateException;
369 request.setRequestDetails(requestDetails);
371 if (iar.getStartTime() != null) {
372 String startTimeStamp =
373 new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getStartTime()) + " GMT";
374 request.setStartTime(startTimeStamp);
376 if (iar.getEndTime() != null) {
377 String endTimeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getEndTime()) + " GMT";
378 request.setFinishTime(endTimeStamp);
381 RequestStatus status = new RequestStatus();
383 if (iar.getModifyTime() != null) {
384 String timeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getModifyTime()) + " GMT";
385 status.setTimeStamp(timeStamp);
388 status.setRequestState(mapRequestStatusToRequest(iar, format));
390 if (iar.getProgress() != null) {
391 status.setPercentProgress(iar.getProgress().intValue());
394 if (iar.getCloudApiRequests() != null && !iar.getCloudApiRequests().isEmpty() && includeCloudRequest) {
395 iar.getCloudApiRequests().stream().forEach(cloudRequest -> {
397 request.getCloudRequestData()
398 .add(new CloudRequestData(mapper.readValue(cloudRequest.getRequestBody(), Object.class),
399 cloudRequest.getCloudIdentifier()));
400 } catch (Exception e) {
401 logger.error("Error reading Cloud Request", e);
406 mapRequestStatusAndExtSysErrSrcToRequest(iar, status, format);
408 request.setRequestStatus(status);
412 protected String mapRequestStatusToRequest(InfraActiveRequests iar, String format) {
413 if (iar.getRequestStatus() != null) {
414 if (!StringUtils.isBlank(format) && OrchestrationRequestFormat.DETAIL.toString().equalsIgnoreCase(format)) {
415 return iar.getRequestStatus();
417 if (Status.ABORTED.toString().equalsIgnoreCase(iar.getRequestStatus())
418 || Status.ROLLED_BACK.toString().equalsIgnoreCase(iar.getRequestStatus())
419 || Status.ROLLED_BACK_TO_ASSIGNED.toString().equalsIgnoreCase(iar.getRequestStatus())
420 || Status.ROLLED_BACK_TO_CREATED.toString().equalsIgnoreCase(iar.getRequestStatus())) {
421 return Status.FAILED.toString();
423 return iar.getRequestStatus();
430 protected void mapRequestStatusAndExtSysErrSrcToRequest(InfraActiveRequests iar, RequestStatus status,
431 String format) throws ContactCamundaException {
432 String rollbackStatusMessage = iar.getRollbackStatusMessage();
433 String flowStatusMessage = iar.getFlowStatus();
434 String retryStatusMessage = iar.getRetryStatusMessage();
435 String taskName = null;
437 if (flowStatusMessage != null && !flowStatusMessage.equals("Successfully completed all Building Blocks")
438 && !flowStatusMessage.equals("All Rollback flows have completed successfully")) {
439 taskName = camundaRequestHandler.getTaskName(iar.getRequestId());
440 if (taskName != null) {
441 flowStatusMessage = flowStatusMessage + " TASK INFORMATION: " + taskName;
445 String statusMessages = null;
446 if (iar.getStatusMessage() != null) {
447 statusMessages = "STATUS: " + iar.getStatusMessage();
450 if (OrchestrationRequestFormat.STATUSDETAIL.toString().equalsIgnoreCase(format)) {
451 if (flowStatusMessage != null) {
452 status.setFlowStatus(flowStatusMessage);
454 if (retryStatusMessage != null) {
455 status.setRetryStatusMessage(retryStatusMessage);
457 if (rollbackStatusMessage != null) {
458 status.setRollbackStatusMessage(rollbackStatusMessage);
460 status.setExtSystemErrorSource(iar.getExtSystemErrorSource());
461 status.setRollbackExtSystemErrorSource(iar.getRollbackExtSystemErrorSource());
464 if (flowStatusMessage != null) {
465 if (statusMessages != null) {
466 statusMessages = statusMessages + " " + "FLOW STATUS: " + flowStatusMessage;
468 statusMessages = "FLOW STATUS: " + flowStatusMessage;
471 if (retryStatusMessage != null) {
472 if (statusMessages != null) {
473 statusMessages = statusMessages + " " + "RETRY STATUS: " + retryStatusMessage;
475 statusMessages = "RETRY STATUS: " + retryStatusMessage;
478 if (rollbackStatusMessage != null) {
479 if (statusMessages != null) {
480 statusMessages = statusMessages + " " + "ROLLBACK STATUS: " + rollbackStatusMessage;
482 statusMessages = "ROLLBACK STATUS: " + rollbackStatusMessage;
487 if (statusMessages != null) {
488 status.setStatusMessage(statusMessages);
492 public List<org.onap.so.serviceinstancebeans.RequestProcessingData> mapRequestProcessingData(
493 List<org.onap.so.db.request.beans.RequestProcessingData> processingData) {
494 List<org.onap.so.serviceinstancebeans.RequestProcessingData> addedRequestProcessingData = new ArrayList<>();
495 org.onap.so.serviceinstancebeans.RequestProcessingData finalProcessingData =
496 new org.onap.so.serviceinstancebeans.RequestProcessingData();
497 String currentGroupingId = null;
498 HashMap<String, String> tempMap = new HashMap<>();
499 List<HashMap<String, String>> tempList = new ArrayList<>();
500 for (RequestProcessingData data : processingData) {
501 String groupingId = data.getGroupingId();
502 String tag = data.getTag();
503 if (currentGroupingId == null || !currentGroupingId.equals(groupingId)) {
504 if (!tempMap.isEmpty()) {
505 tempList.add(tempMap);
506 finalProcessingData.setDataPairs(tempList);
507 addedRequestProcessingData.add(finalProcessingData);
509 finalProcessingData = new org.onap.so.serviceinstancebeans.RequestProcessingData();
510 if (groupingId != null) {
511 finalProcessingData.setGroupingId(groupingId);
514 finalProcessingData.setTag(tag);
516 currentGroupingId = groupingId;
517 tempMap = new HashMap<>();
518 tempList = new ArrayList<>();
519 if (data.getName() != null && data.getValue() != null) {
520 tempMap.put(data.getName(), data.getValue());
523 if (data.getName() != null && data.getValue() != null) {
524 tempMap.put(data.getName(), data.getValue());
528 if (tempMap.size() > 0) {
529 tempList.add(tempMap);
530 finalProcessingData.setDataPairs(tempList);
532 addedRequestProcessingData.add(finalProcessingData);
533 return addedRequestProcessingData;