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);
88 private RequestsDbClient requestsDbClient;
91 private MsoRequest msoRequest;
94 private ResponseBuilder builder;
97 private CamundaRequestHandler camundaRequestHandler;
100 @Path("/{version:[vV][4-7]}/{requestId}")
101 @ApiOperation(value = "Find Orchestrated Requests for a given requestId", response = Response.class)
102 @Produces(MediaType.APPLICATION_JSON)
104 public Response getOrchestrationRequest(@PathParam("requestId") String requestId,
105 @PathParam("version") String version, @QueryParam("includeCloudRequest") boolean includeCloudRequest,
106 @QueryParam(value = "format") String format) throws ApiException {
108 String apiVersion = version.substring(1);
109 GetOrchestrationResponse orchestrationResponse = new GetOrchestrationResponse();
111 InfraActiveRequests infraActiveRequest = null;
112 List<org.onap.so.db.request.beans.RequestProcessingData> requestProcessingData = null;
114 if (!UUIDChecker.isValidUUID(requestId)) {
116 ErrorLoggerInfo errorLoggerInfo =
117 new ErrorLoggerInfo.Builder(MessageEnum.APIH_VALIDATION_ERROR, ErrorCode.SchemaError)
118 .errorSource(Constants.MODIFIED_BY_APIHANDLER).build();
119 throw new ValidateException.Builder("Request Id " + requestId + " is not a valid UUID",
120 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).errorInfo(errorLoggerInfo).build();
123 infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
124 requestProcessingData = requestsDbClient.getRequestProcessingDataBySoRequestId(requestId);
126 } catch (Exception e) {
127 logger.error("Exception occurred", e);
128 ErrorLoggerInfo errorLoggerInfo =
129 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.AvailabilityError).build();
131 ValidateException validateException =
132 new ValidateException.Builder("Exception while communciate with Request DB - Infra Request Lookup",
133 HttpStatus.SC_NOT_FOUND, ErrorNumbers.NO_COMMUNICATION_TO_REQUESTS_DB).cause(e)
134 .errorInfo(errorLoggerInfo).build();
136 throw validateException;
140 if (infraActiveRequest == null) {
142 ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR,
143 ErrorCode.BusinessProcesssError).build();
145 ValidateException validateException =
146 new ValidateException.Builder("Orchestration RequestId " + requestId + " is not found in DB",
147 HttpStatus.SC_NO_CONTENT, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR)
148 .errorInfo(errorLoggerInfo).build();
150 throw validateException;
153 Request request = mapInfraActiveRequestToRequest(infraActiveRequest, includeCloudRequest, format);
155 if (!requestProcessingData.isEmpty()) {
156 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
158 request.setRequestId(requestId);
159 orchestrationResponse.setRequest(request);
161 return builder.buildResponse(HttpStatus.SC_OK, requestId, orchestrationResponse, apiVersion);
165 @Path("/{version:[vV][4-7]}")
166 @ApiOperation(value = "Find Orchestrated Requests for a URI Information", response = Response.class)
167 @Produces(MediaType.APPLICATION_JSON)
169 public Response getOrchestrationRequest(@Context UriInfo ui, @PathParam("version") String version,
170 @QueryParam("includeCloudRequest") boolean includeCloudRequest, @QueryParam(value = "format") String format)
171 throws ApiException {
173 MultivaluedMap<String, String> queryParams = ui.getQueryParameters();
175 List<InfraActiveRequests> activeRequests;
177 GetOrchestrationListResponse orchestrationList;
178 Map<String, List<String>> orchestrationMap;
179 String apiVersion = version.substring(1);
182 orchestrationMap = msoRequest.getOrchestrationFilters(queryParams);
183 if (orchestrationMap.isEmpty()) {
184 throw new ValidationException("At least one filter query param must be specified");
186 } catch (ValidationException ex) {
187 logger.error("Exception occurred", ex);
188 ErrorLoggerInfo errorLoggerInfo =
189 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.DataError).build();
190 ValidateException validateException =
191 new ValidateException.Builder(ex.getMessage(), HttpStatus.SC_BAD_REQUEST,
192 ErrorNumbers.SVC_GENERAL_SERVICE_ERROR).cause(ex).errorInfo(errorLoggerInfo).build();
193 throw validateException;
197 activeRequests = requestsDbClient.getOrchestrationFiltersFromInfraActive(orchestrationMap);
199 orchestrationList = new GetOrchestrationListResponse();
200 List<RequestList> requestLists = new ArrayList<>();
202 for (InfraActiveRequests infraActive : activeRequests) {
203 List<RequestProcessingData> requestProcessingData =
204 requestsDbClient.getRequestProcessingDataBySoRequestId(infraActive.getRequestId());
205 RequestList requestList = new RequestList();
206 Request request = mapInfraActiveRequestToRequest(infraActive, includeCloudRequest, format);
208 if (!requestProcessingData.isEmpty()) {
209 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
211 requestList.setRequest(request);
212 requestLists.add(requestList);
215 orchestrationList.setRequestList(requestLists);
216 return builder.buildResponse(HttpStatus.SC_OK, null, orchestrationList, apiVersion);
220 @Path("/{version: [vV][4-7]}/{requestId}/unlock")
221 @Consumes(MediaType.APPLICATION_JSON)
222 @Produces(MediaType.APPLICATION_JSON)
223 @ApiOperation(value = "Unlock Orchestrated Requests for a given requestId", response = Response.class)
225 public Response unlockOrchestrationRequest(String requestJSON, @PathParam("requestId") String requestId,
226 @PathParam("version") String version) throws ApiException {
228 logger.debug("requestId is: {}", requestId);
229 ServiceInstancesRequest sir;
231 InfraActiveRequests infraActiveRequest;
234 ObjectMapper mapper = new ObjectMapper();
235 sir = mapper.readValue(requestJSON, ServiceInstancesRequest.class);
236 } catch (IOException e) {
237 logger.error("Exception occurred", e);
238 ErrorLoggerInfo errorLoggerInfo =
239 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
241 ValidateException validateException =
242 new ValidateException.Builder("Mapping of request to JSON object failed : " + e.getMessage(),
243 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
244 .errorInfo(errorLoggerInfo).build();
246 throw validateException;
250 msoRequest.parseOrchestration(sir);
251 } catch (Exception e) {
252 logger.error("Exception occurred", e);
253 ErrorLoggerInfo errorLoggerInfo =
254 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
256 ValidateException validateException =
257 new ValidateException.Builder("Error parsing request: " + e.getMessage(), HttpStatus.SC_BAD_REQUEST,
258 ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
259 throw validateException;
262 infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
263 if (infraActiveRequest == null) {
264 ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND,
265 ErrorCode.BusinessProcesssError).build();
267 ValidateException validateException =
268 new ValidateException.Builder("Null response from RequestDB when searching by RequestId",
269 HttpStatus.SC_NOT_FOUND, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
272 throw validateException;
275 String status = infraActiveRequest.getRequestStatus();
276 if (Status.IN_PROGRESS.toString().equalsIgnoreCase(status)
277 || Status.PENDING.toString().equalsIgnoreCase(status)
278 || Status.PENDING_MANUAL_TASK.toString().equalsIgnoreCase(status)) {
279 infraActiveRequest.setRequestStatus(Status.UNLOCKED.toString());
280 infraActiveRequest.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
281 infraActiveRequest.setRequestId(requestId);
282 requestsDbClient.save(infraActiveRequest);
285 ErrorLoggerInfo errorLoggerInfo =
286 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND, ErrorCode.DataError)
289 ValidateException validateException = new ValidateException.Builder(
290 "Orchestration RequestId " + requestId + " has a status of " + status
291 + " and can not be unlocked",
292 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
295 throw validateException;
298 return Response.status(HttpStatus.SC_NO_CONTENT).entity("").build();
301 protected Request mapInfraActiveRequestToRequest(InfraActiveRequests iar, boolean includeCloudRequest,
302 String format) throws ApiException {
303 String requestBody = iar.getRequestBody();
304 Request request = new Request();
306 ObjectMapper mapper = new ObjectMapper();
308 request.setRequestId(iar.getRequestId());
309 request.setRequestScope(iar.getRequestScope());
310 request.setRequestType(iar.getRequestAction());
312 String originalRequestId = iar.getOriginalRequestId();
313 if (originalRequestId != null) {
314 request.setOriginalRequestId(originalRequestId);
317 InstanceReferences ir = new InstanceReferences();
318 if (iar.getNetworkId() != null)
319 ir.setNetworkInstanceId(iar.getNetworkId());
320 if (iar.getNetworkName() != null)
321 ir.setNetworkInstanceName(iar.getNetworkName());
322 if (iar.getServiceInstanceId() != null)
323 ir.setServiceInstanceId(iar.getServiceInstanceId());
324 if (iar.getServiceInstanceName() != null)
325 ir.setServiceInstanceName(iar.getServiceInstanceName());
326 if (iar.getVfModuleId() != null)
327 ir.setVfModuleInstanceId(iar.getVfModuleId());
328 if (iar.getVfModuleName() != null)
329 ir.setVfModuleInstanceName(iar.getVfModuleName());
330 if (iar.getVnfId() != null)
331 ir.setVnfInstanceId(iar.getVnfId());
332 if (iar.getVnfName() != null)
333 ir.setVnfInstanceName(iar.getVnfName());
334 if (iar.getVolumeGroupId() != null)
335 ir.setVolumeGroupInstanceId(iar.getVolumeGroupId());
336 if (iar.getVolumeGroupName() != null)
337 ir.setVolumeGroupInstanceName(iar.getVolumeGroupName());
338 if (iar.getRequestorId() != null)
339 ir.setRequestorId(iar.getRequestorId());
340 if (iar.getInstanceGroupId() != null)
341 ir.setInstanceGroupId(iar.getInstanceGroupId());
342 if (iar.getInstanceGroupName() != null)
343 ir.setInstanceGroupName(iar.getInstanceGroupName());
345 request.setInstanceReferences(ir);
347 RequestDetails requestDetails = null;
349 if (StringUtils.isNotBlank(requestBody)) {
351 if (requestBody.contains("\"requestDetails\":")) {
352 ServiceInstancesRequest sir = mapper.readValue(requestBody, ServiceInstancesRequest.class);
353 requestDetails = sir.getRequestDetails();
355 requestDetails = mapper.readValue(requestBody, RequestDetails.class);
357 } catch (IOException e) {
358 logger.error("Exception occurred", e);
359 ErrorLoggerInfo errorLoggerInfo =
360 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
362 ValidateException validateException =
363 new ValidateException.Builder("Mapping of request to JSON object failed : ",
364 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
365 .errorInfo(errorLoggerInfo).build();
367 throw validateException;
370 request.setRequestDetails(requestDetails);
372 if (iar.getStartTime() != null) {
373 String startTimeStamp =
374 new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getStartTime()) + " GMT";
375 request.setStartTime(startTimeStamp);
377 if (iar.getEndTime() != null) {
378 String endTimeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getEndTime()) + " GMT";
379 request.setFinishTime(endTimeStamp);
382 RequestStatus status = new RequestStatus();
384 if (iar.getModifyTime() != null) {
385 String timeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getModifyTime()) + " GMT";
386 status.setTimeStamp(timeStamp);
389 status.setRequestState(mapRequestStatusToRequest(iar, format));
391 if (iar.getProgress() != null) {
392 status.setPercentProgress(iar.getProgress().intValue());
395 if (iar.getCloudApiRequests() != null && !iar.getCloudApiRequests().isEmpty() && includeCloudRequest) {
396 iar.getCloudApiRequests().stream().forEach(cloudRequest -> {
398 request.getCloudRequestData()
399 .add(new CloudRequestData(mapper.readValue(cloudRequest.getRequestBody(), Object.class),
400 cloudRequest.getCloudIdentifier()));
401 } catch (Exception e) {
402 logger.error("Error reading Cloud Request", e);
407 mapRequestStatusAndExtSysErrSrcToRequest(iar, status, format);
409 request.setRequestStatus(status);
413 protected String mapRequestStatusToRequest(InfraActiveRequests iar, String format) {
414 if (iar.getRequestStatus() != null) {
415 boolean requestFormat = false;
416 if (format != null) {
417 requestFormat = EnumUtils.isValidEnum(OrchestrationRequestFormat.class, format.toUpperCase());
420 return iar.getRequestStatus();
422 if (Status.ABORTED.toString().equalsIgnoreCase(iar.getRequestStatus())
423 || Status.ROLLED_BACK.toString().equalsIgnoreCase(iar.getRequestStatus())
424 || Status.ROLLED_BACK_TO_ASSIGNED.toString().equalsIgnoreCase(iar.getRequestStatus())
425 || Status.ROLLED_BACK_TO_CREATED.toString().equalsIgnoreCase(iar.getRequestStatus())) {
426 return Status.FAILED.toString();
428 return iar.getRequestStatus();
435 protected void mapRequestStatusAndExtSysErrSrcToRequest(InfraActiveRequests iar, RequestStatus status,
436 String format) throws ContactCamundaException {
437 String rollbackStatusMessage = iar.getRollbackStatusMessage();
438 String flowStatusMessage = iar.getFlowStatus();
439 String retryStatusMessage = iar.getRetryStatusMessage();
440 String taskName = null;
442 if (flowStatusMessage != null && !flowStatusMessage.equals("Successfully completed all Building Blocks")
443 && !flowStatusMessage.equals("All Rollback flows have completed successfully")) {
444 taskName = camundaRequestHandler.getTaskName(iar.getRequestId());
445 if (taskName != null) {
446 flowStatusMessage = flowStatusMessage + " TASK INFORMATION: " + taskName;
450 String statusMessages = null;
451 if (iar.getStatusMessage() != null) {
452 statusMessages = "STATUS: " + iar.getStatusMessage();
455 if (OrchestrationRequestFormat.STATUSDETAIL.toString().equalsIgnoreCase(format)) {
456 if (flowStatusMessage != null) {
457 status.setFlowStatus(flowStatusMessage);
459 if (retryStatusMessage != null) {
460 status.setRetryStatusMessage(retryStatusMessage);
462 if (rollbackStatusMessage != null) {
463 status.setRollbackStatusMessage(rollbackStatusMessage);
465 status.setExtSystemErrorSource(iar.getExtSystemErrorSource());
466 status.setRollbackExtSystemErrorSource(iar.getRollbackExtSystemErrorSource());
469 if (flowStatusMessage != null) {
470 if (statusMessages != null) {
471 statusMessages = statusMessages + " " + "FLOW STATUS: " + flowStatusMessage;
473 statusMessages = "FLOW STATUS: " + flowStatusMessage;
476 if (retryStatusMessage != null) {
477 if (statusMessages != null) {
478 statusMessages = statusMessages + " " + "RETRY STATUS: " + retryStatusMessage;
480 statusMessages = "RETRY STATUS: " + retryStatusMessage;
483 if (rollbackStatusMessage != null) {
484 if (statusMessages != null) {
485 statusMessages = statusMessages + " " + "ROLLBACK STATUS: " + rollbackStatusMessage;
487 statusMessages = "ROLLBACK STATUS: " + rollbackStatusMessage;
492 if (statusMessages != null) {
493 status.setStatusMessage(statusMessages);
497 public List<org.onap.so.serviceinstancebeans.RequestProcessingData> mapRequestProcessingData(
498 List<org.onap.so.db.request.beans.RequestProcessingData> processingData) {
499 List<org.onap.so.serviceinstancebeans.RequestProcessingData> addedRequestProcessingData = new ArrayList<>();
500 org.onap.so.serviceinstancebeans.RequestProcessingData finalProcessingData =
501 new org.onap.so.serviceinstancebeans.RequestProcessingData();
502 String currentGroupingId = null;
503 HashMap<String, String> tempMap = new HashMap<>();
504 List<HashMap<String, String>> tempList = new ArrayList<>();
505 for (RequestProcessingData data : processingData) {
506 String groupingId = data.getGroupingId();
507 String tag = data.getTag();
508 if (currentGroupingId == null || !currentGroupingId.equals(groupingId)) {
509 if (!tempMap.isEmpty()) {
510 tempList.add(tempMap);
511 finalProcessingData.setDataPairs(tempList);
512 addedRequestProcessingData.add(finalProcessingData);
514 finalProcessingData = new org.onap.so.serviceinstancebeans.RequestProcessingData();
515 if (groupingId != null) {
516 finalProcessingData.setGroupingId(groupingId);
519 finalProcessingData.setTag(tag);
521 currentGroupingId = groupingId;
522 tempMap = new HashMap<>();
523 tempList = new ArrayList<>();
524 if (data.getName() != null && data.getValue() != null) {
525 tempMap.put(data.getName(), data.getValue());
528 if (data.getName() != null && data.getValue() != null) {
529 tempMap.put(data.getName(), data.getValue());
533 if (tempMap.size() > 0) {
534 tempList.add(tempMap);
535 finalProcessingData.setDataPairs(tempList);
537 addedRequestProcessingData.add(finalProcessingData);
538 return addedRequestProcessingData;