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.ValidateException;
50 import org.onap.so.apihandlerinfra.logging.ErrorLoggerInfo;
51 import org.onap.so.db.request.beans.InfraActiveRequests;
52 import org.onap.so.db.request.beans.RequestProcessingData;
53 import org.onap.so.db.request.client.RequestsDbClient;
54 import org.onap.so.exceptions.ValidationException;
55 import org.onap.so.logger.ErrorCode;
56 import org.onap.so.logger.MessageEnum;
57 import org.onap.so.serviceinstancebeans.CloudRequestData;
58 import org.onap.so.serviceinstancebeans.GetOrchestrationListResponse;
59 import org.onap.so.serviceinstancebeans.GetOrchestrationResponse;
60 import org.onap.so.serviceinstancebeans.InstanceReferences;
61 import org.onap.so.serviceinstancebeans.Request;
62 import org.onap.so.serviceinstancebeans.RequestDetails;
63 import org.onap.so.serviceinstancebeans.RequestList;
64 import org.onap.so.serviceinstancebeans.RequestStatus;
65 import org.onap.so.serviceinstancebeans.ServiceInstancesRequest;
66 import org.onap.so.utils.UUIDChecker;
67 import org.slf4j.Logger;
68 import org.slf4j.LoggerFactory;
69 import org.springframework.beans.factory.annotation.Autowired;
70 import org.springframework.stereotype.Component;
71 import com.fasterxml.jackson.databind.ObjectMapper;
72 import io.swagger.annotations.Api;
73 import io.swagger.annotations.ApiOperation;
75 @Path("onap/so/infra/orchestrationRequests")
76 @Api(value = "onap/so/infra/orchestrationRequests", description = "API Requests for Orchestration requests")
78 public class OrchestrationRequests {
80 private static Logger logger = LoggerFactory.getLogger(OrchestrationRequests.class);
83 private RequestsDbClient requestsDbClient;
86 private MsoRequest msoRequest;
89 private ResponseBuilder builder;
92 @Path("/{version:[vV][4-7]}/{requestId}")
93 @ApiOperation(value = "Find Orchestrated Requests for a given requestId", response = Response.class)
94 @Produces(MediaType.APPLICATION_JSON)
96 public Response getOrchestrationRequest(@PathParam("requestId") String requestId,
97 @PathParam("version") String version, @QueryParam("includeCloudRequest") boolean includeCloudRequest)
100 String apiVersion = version.substring(1);
101 GetOrchestrationResponse orchestrationResponse = new GetOrchestrationResponse();
103 InfraActiveRequests infraActiveRequest = null;
104 List<org.onap.so.db.request.beans.RequestProcessingData> requestProcessingData = null;
106 if (!UUIDChecker.isValidUUID(requestId)) {
108 ErrorLoggerInfo errorLoggerInfo =
109 new ErrorLoggerInfo.Builder(MessageEnum.APIH_VALIDATION_ERROR, ErrorCode.SchemaError)
110 .errorSource(Constants.MODIFIED_BY_APIHANDLER).build();
111 throw new ValidateException.Builder("Request Id " + requestId + " is not a valid UUID",
112 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).errorInfo(errorLoggerInfo).build();
115 infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
116 requestProcessingData = requestsDbClient.getRequestProcessingDataBySoRequestId(requestId);
118 } catch (Exception e) {
119 logger.error("Exception occurred", e);
120 ErrorLoggerInfo errorLoggerInfo =
121 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ACCESS_EXC, ErrorCode.AvailabilityError).build();
123 ValidateException validateException =
124 new ValidateException.Builder("Exception while communciate with Request DB - Infra Request Lookup",
125 HttpStatus.SC_NOT_FOUND, ErrorNumbers.NO_COMMUNICATION_TO_REQUESTS_DB).cause(e)
126 .errorInfo(errorLoggerInfo).build();
128 throw validateException;
132 if (infraActiveRequest == null) {
134 ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR,
135 ErrorCode.BusinessProcesssError).build();
137 ValidateException validateException =
138 new ValidateException.Builder("Orchestration RequestId " + requestId + " is not found in DB",
139 HttpStatus.SC_NO_CONTENT, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR)
140 .errorInfo(errorLoggerInfo).build();
142 throw validateException;
145 Request request = mapInfraActiveRequestToRequest(infraActiveRequest, includeCloudRequest);
146 if (!requestProcessingData.isEmpty()) {
147 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
149 request.setRequestId(requestId);
150 orchestrationResponse.setRequest(request);
152 return builder.buildResponse(HttpStatus.SC_OK, requestId, orchestrationResponse, apiVersion);
156 @Path("/{version:[vV][4-7]}")
157 @ApiOperation(value = "Find Orchestrated Requests for a URI Information", response = Response.class)
158 @Produces(MediaType.APPLICATION_JSON)
160 public Response getOrchestrationRequest(@Context UriInfo ui, @PathParam("version") String version,
161 @QueryParam("includeCloudRequest") boolean includeCloudRequest) throws ApiException {
163 long startTime = System.currentTimeMillis();
165 MultivaluedMap<String, String> queryParams = ui.getQueryParameters();
167 List<InfraActiveRequests> activeRequests = null;
169 GetOrchestrationListResponse orchestrationList = null;
170 Map<String, List<String>> orchestrationMap;
171 String apiVersion = version.substring(1);
174 orchestrationMap = msoRequest.getOrchestrationFilters(queryParams);
175 if (orchestrationMap.isEmpty()) {
176 throw new ValidationException("At least one filter query param must be specified");
178 } catch (ValidationException ex) {
179 logger.error("Exception occurred", ex);
180 ErrorLoggerInfo errorLoggerInfo =
181 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.DataError).build();
182 ValidateException validateException =
183 new ValidateException.Builder(ex.getMessage(), HttpStatus.SC_BAD_REQUEST,
184 ErrorNumbers.SVC_GENERAL_SERVICE_ERROR).cause(ex).errorInfo(errorLoggerInfo).build();
185 throw validateException;
189 activeRequests = requestsDbClient.getOrchestrationFiltersFromInfraActive(orchestrationMap);
191 orchestrationList = new GetOrchestrationListResponse();
192 List<RequestList> requestLists = new ArrayList<>();
194 for (InfraActiveRequests infraActive : activeRequests) {
195 List<RequestProcessingData> requestProcessingData =
196 requestsDbClient.getRequestProcessingDataBySoRequestId(infraActive.getRequestId());
197 RequestList requestList = new RequestList();
198 Request request = mapInfraActiveRequestToRequest(infraActive, includeCloudRequest);
199 if (!requestProcessingData.isEmpty()) {
200 request.setRequestProcessingData(mapRequestProcessingData(requestProcessingData));
202 requestList.setRequest(request);
203 requestLists.add(requestList);
206 orchestrationList.setRequestList(requestLists);
207 return builder.buildResponse(HttpStatus.SC_OK, null, orchestrationList, apiVersion);
211 @Path("/{version: [vV][4-7]}/{requestId}/unlock")
212 @Consumes(MediaType.APPLICATION_JSON)
213 @Produces(MediaType.APPLICATION_JSON)
214 @ApiOperation(value = "Unlock Orchestrated Requests for a given requestId", response = Response.class)
216 public Response unlockOrchestrationRequest(String requestJSON, @PathParam("requestId") String requestId,
217 @PathParam("version") String version) throws ApiException {
219 long startTime = System.currentTimeMillis();
220 logger.debug("requestId is: {}", requestId);
221 ServiceInstancesRequest sir = null;
223 InfraActiveRequests infraActiveRequest = null;
224 Request request = null;
227 ObjectMapper mapper = new ObjectMapper();
228 sir = mapper.readValue(requestJSON, ServiceInstancesRequest.class);
229 } catch (IOException e) {
230 logger.error("Exception occurred", e);
231 ErrorLoggerInfo errorLoggerInfo =
232 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
234 ValidateException validateException =
235 new ValidateException.Builder("Mapping of request to JSON object failed : " + e.getMessage(),
236 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
237 .errorInfo(errorLoggerInfo).build();
239 throw validateException;
243 msoRequest.parseOrchestration(sir);
244 } catch (Exception e) {
245 logger.error("Exception occurred", e);
246 ErrorLoggerInfo errorLoggerInfo =
247 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
249 ValidateException validateException =
250 new ValidateException.Builder("Error parsing request: " + e.getMessage(), HttpStatus.SC_BAD_REQUEST,
251 ErrorNumbers.SVC_BAD_PARAMETER).cause(e).errorInfo(errorLoggerInfo).build();
252 throw validateException;
255 infraActiveRequest = requestsDbClient.getInfraActiveRequestbyRequestId(requestId);
256 if (infraActiveRequest == null) {
257 ErrorLoggerInfo errorLoggerInfo = new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND,
258 ErrorCode.BusinessProcesssError).build();
260 ValidateException validateException =
261 new ValidateException.Builder("Null response from RequestDB when searching by RequestId",
262 HttpStatus.SC_NOT_FOUND, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
265 throw validateException;
268 String status = infraActiveRequest.getRequestStatus();
269 if (status.equalsIgnoreCase("IN_PROGRESS") || status.equalsIgnoreCase("PENDING")
270 || status.equalsIgnoreCase("PENDING_MANUAL_TASK")) {
271 infraActiveRequest.setRequestStatus("UNLOCKED");
272 infraActiveRequest.setLastModifiedBy(Constants.MODIFIED_BY_APIHANDLER);
273 infraActiveRequest.setRequestId(requestId);
274 requestsDbClient.save(infraActiveRequest);
277 ErrorLoggerInfo errorLoggerInfo =
278 new ErrorLoggerInfo.Builder(MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND, ErrorCode.DataError)
281 ValidateException validateException = new ValidateException.Builder(
282 "Orchestration RequestId " + requestId + " has a status of " + status
283 + " and can not be unlocked",
284 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_DETAILED_SERVICE_ERROR).errorInfo(errorLoggerInfo)
287 throw validateException;
290 return Response.status(HttpStatus.SC_NO_CONTENT).entity("").build();
293 private Request mapInfraActiveRequestToRequest(InfraActiveRequests iar, boolean includeCloudRequest)
294 throws ApiException {
295 String requestBody = iar.getRequestBody();
296 Request request = new Request();
298 ObjectMapper mapper = new ObjectMapper();
300 request.setRequestId(iar.getRequestId());
301 request.setRequestScope(iar.getRequestScope());
302 request.setRequestType(iar.getRequestAction());
303 String rollbackStatusMessage = iar.getRollbackStatusMessage();
304 String flowStatusMessage = iar.getFlowStatus();
305 String retryStatusMessage = iar.getRetryStatusMessage();
307 InstanceReferences ir = new InstanceReferences();
308 if (iar.getNetworkId() != null)
309 ir.setNetworkInstanceId(iar.getNetworkId());
310 if (iar.getNetworkName() != null)
311 ir.setNetworkInstanceName(iar.getNetworkName());
312 if (iar.getServiceInstanceId() != null)
313 ir.setServiceInstanceId(iar.getServiceInstanceId());
314 if (iar.getServiceInstanceName() != null)
315 ir.setServiceInstanceName(iar.getServiceInstanceName());
316 if (iar.getVfModuleId() != null)
317 ir.setVfModuleInstanceId(iar.getVfModuleId());
318 if (iar.getVfModuleName() != null)
319 ir.setVfModuleInstanceName(iar.getVfModuleName());
320 if (iar.getVnfId() != null)
321 ir.setVnfInstanceId(iar.getVnfId());
322 if (iar.getVnfName() != null)
323 ir.setVnfInstanceName(iar.getVnfName());
324 if (iar.getVolumeGroupId() != null)
325 ir.setVolumeGroupInstanceId(iar.getVolumeGroupId());
326 if (iar.getVolumeGroupName() != null)
327 ir.setVolumeGroupInstanceName(iar.getVolumeGroupName());
328 if (iar.getRequestorId() != null)
329 ir.setRequestorId(iar.getRequestorId());
330 if (iar.getInstanceGroupId() != null)
331 ir.setInstanceGroupId(iar.getInstanceGroupId());
332 if (iar.getInstanceGroupName() != null)
333 ir.setInstanceGroupName(iar.getInstanceGroupName());
335 request.setInstanceReferences(ir);
337 RequestDetails requestDetails = null;
339 if (StringUtils.isNotBlank(requestBody)) {
341 if (requestBody.contains("\"requestDetails\":")) {
342 ServiceInstancesRequest sir = mapper.readValue(requestBody, ServiceInstancesRequest.class);
343 requestDetails = sir.getRequestDetails();
345 requestDetails = mapper.readValue(requestBody, RequestDetails.class);
347 } catch (IOException e) {
348 logger.error("Exception occurred", e);
349 ErrorLoggerInfo errorLoggerInfo =
350 new ErrorLoggerInfo.Builder(MessageEnum.APIH_REQUEST_VALIDATION_ERROR, ErrorCode.SchemaError)
352 ValidateException validateException =
353 new ValidateException.Builder("Mapping of request to JSON object failed : ",
354 HttpStatus.SC_BAD_REQUEST, ErrorNumbers.SVC_BAD_PARAMETER).cause(e)
355 .errorInfo(errorLoggerInfo).build();
357 throw validateException;
360 request.setRequestDetails(requestDetails);
362 if (iar.getStartTime() != null) {
363 String startTimeStamp =
364 new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getStartTime()) + " GMT";
365 request.setStartTime(startTimeStamp);
367 if (iar.getEndTime() != null) {
368 String endTimeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getEndTime()) + " GMT";
369 request.setFinishTime(endTimeStamp);
371 String statusMessages = null;
372 RequestStatus status = new RequestStatus();
373 if (iar.getStatusMessage() != null) {
374 statusMessages = "STATUS: " + iar.getStatusMessage();
376 if (flowStatusMessage != null) {
377 if (statusMessages != null) {
378 statusMessages = statusMessages + " " + "FLOW STATUS: " + flowStatusMessage;
380 statusMessages = "FLOW STATUS: " + flowStatusMessage;
383 if (retryStatusMessage != null) {
384 if (statusMessages != null) {
385 statusMessages = statusMessages + " " + "RETRY STATUS: " + retryStatusMessage;
387 statusMessages = "RETRY STATUS: " + retryStatusMessage;
390 if (rollbackStatusMessage != null) {
391 if (statusMessages != null) {
392 statusMessages = statusMessages + " " + "ROLLBACK STATUS: " + rollbackStatusMessage;
394 statusMessages = "ROLLBACK STATUS: " + rollbackStatusMessage;
397 if (statusMessages != null) {
398 status.setStatusMessage(statusMessages);
400 if (iar.getModifyTime() != null) {
401 String timeStamp = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss").format(iar.getModifyTime()) + " GMT";
402 status.setTimeStamp(timeStamp);
405 if (iar.getRequestStatus() != null) {
406 status.setRequestState(iar.getRequestStatus());
409 if (iar.getProgress() != null) {
410 status.setPercentProgress(iar.getProgress().intValue());
413 if (iar.getCloudApiRequests() != null && !iar.getCloudApiRequests().isEmpty() && includeCloudRequest) {
414 iar.getCloudApiRequests().stream().forEach(cloudRequest -> {
416 request.getCloudRequestData()
417 .add(new CloudRequestData(mapper.readValue(cloudRequest.getRequestBody(), Object.class),
418 cloudRequest.getCloudIdentifier()));
419 } catch (Exception e) {
420 logger.error("Error reading Cloud Request", e);
425 request.setRequestStatus(status);
429 public List<org.onap.so.serviceinstancebeans.RequestProcessingData> mapRequestProcessingData(
430 List<org.onap.so.db.request.beans.RequestProcessingData> processingData) {
431 List<org.onap.so.serviceinstancebeans.RequestProcessingData> addedRequestProcessingData = new ArrayList<>();
432 org.onap.so.serviceinstancebeans.RequestProcessingData finalProcessingData =
433 new org.onap.so.serviceinstancebeans.RequestProcessingData();
434 String currentGroupingId = null;
435 HashMap<String, String> tempMap = new HashMap<>();
436 List<HashMap<String, String>> tempList = new ArrayList<>();
437 for (RequestProcessingData data : processingData) {
438 String groupingId = data.getGroupingId();
439 String tag = data.getTag();
440 if (currentGroupingId == null || !currentGroupingId.equals(groupingId)) {
441 if (!tempMap.isEmpty()) {
442 tempList.add(tempMap);
443 finalProcessingData.setDataPairs(tempList);
444 addedRequestProcessingData.add(finalProcessingData);
446 finalProcessingData = new org.onap.so.serviceinstancebeans.RequestProcessingData();
447 if (groupingId != null) {
448 finalProcessingData.setGroupingId(groupingId);
451 finalProcessingData.setTag(tag);
453 currentGroupingId = groupingId;
454 tempMap = new HashMap<>();
455 tempList = new ArrayList<>();
456 if (data.getName() != null && data.getValue() != null) {
457 tempMap.put(data.getName(), data.getValue());
460 if (data.getName() != null && data.getValue() != null) {
461 tempMap.put(data.getName(), data.getValue());
465 if (tempMap.size() > 0) {
466 tempList.add(tempMap);
467 finalProcessingData.setDataPairs(tempList);
469 addedRequestProcessingData.add(finalProcessingData);
470 return addedRequestProcessingData;