2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 Huawei Technologies Co., Ltd. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.openecomp.mso.apihandlerinfra;
23 import java.io.IOException;
24 import java.util.ArrayList;
25 import java.util.HashMap;
26 import java.util.List;
29 import javax.ws.rs.Consumes;
30 import javax.ws.rs.DELETE;
31 import javax.ws.rs.GET;
32 import javax.ws.rs.POST;
33 import javax.ws.rs.Path;
34 import javax.ws.rs.PathParam;
35 import javax.ws.rs.Produces;
36 import javax.ws.rs.core.MediaType;
37 import javax.ws.rs.core.Response;
39 import org.apache.http.HttpResponse;
40 import org.apache.http.HttpStatus;
41 import org.codehaus.jackson.map.ObjectMapper;
42 import org.openecomp.mso.apihandler.common.ErrorNumbers;
43 import org.openecomp.mso.apihandler.common.RequestClient;
44 import org.openecomp.mso.apihandler.common.RequestClientFactory;
45 import org.openecomp.mso.apihandler.common.ResponseHandler;
46 import org.openecomp.mso.apihandlerinfra.e2eserviceinstancebeans.E2EServiceInstanceRequest;
47 import org.openecomp.mso.apihandlerinfra.e2eserviceinstancebeans.E2EUserParam;
48 import org.openecomp.mso.apihandlerinfra.serviceinstancebeans.ModelInfo;
49 import org.openecomp.mso.apihandlerinfra.serviceinstancebeans.RequestDetails;
50 import org.openecomp.mso.apihandlerinfra.serviceinstancebeans.RequestInfo;
51 import org.openecomp.mso.apihandlerinfra.serviceinstancebeans.RequestParameters;
52 import org.openecomp.mso.apihandlerinfra.serviceinstancebeans.ServiceInstancesRequest;
53 import org.openecomp.mso.apihandlerinfra.serviceinstancebeans.SubscriberInfo;
54 import org.openecomp.mso.db.catalog.CatalogDatabase;
55 import org.openecomp.mso.db.catalog.beans.Service;
56 import org.openecomp.mso.db.catalog.beans.ServiceRecipe;
57 import org.openecomp.mso.logger.MessageEnum;
58 import org.openecomp.mso.logger.MsoAlarmLogger;
59 import org.openecomp.mso.logger.MsoLogger;
60 import org.openecomp.mso.requestsdb.InfraActiveRequests;
61 import org.openecomp.mso.requestsdb.RequestsDatabase;
62 import org.openecomp.mso.utils.UUIDChecker;
64 import com.wordnik.swagger.annotations.Api;
65 import com.wordnik.swagger.annotations.ApiOperation;
67 @Path("/e2eServiceInstances")
68 @Api(value="/e2eServiceInstances",description="API Requests for E2E Service Instances")
69 public class E2EServiceInstances {
71 private HashMap<String, String> instanceIdMap = new HashMap<String,String>();
72 private static MsoLogger msoLogger = MsoLogger.getMsoLogger (MsoLogger.Catalog.APIH);
73 private static MsoAlarmLogger alarmLogger = new MsoAlarmLogger ();
74 public final static String MSO_PROP_APIHANDLER_INFRA = "MSO_PROP_APIHANDLER_INFRA";
76 public E2EServiceInstances() {
80 *POST Requests for E2E Service create Instance on a version provided
84 @Path("/{version:[vV][3-5]}")
85 @Consumes(MediaType.APPLICATION_JSON)
86 @Produces(MediaType.APPLICATION_JSON)
87 @ApiOperation(value="Create a E2E Service Instance on a version provided",response=Response.class)
88 public Response createE2EServiceInstance(String request, @PathParam("version") String version) {
90 return E2EserviceInstances(request, Action.createInstance, null, version);
94 *DELETE Requests for E2E Service delete Instance on a specified version and serviceId
98 @Path("/{version:[vV][3-5]}/{serviceId}")
99 @Consumes(MediaType.APPLICATION_JSON)
100 @Produces(MediaType.APPLICATION_JSON)
101 @ApiOperation(value="Delete E2E Service Instance on a specified version and serviceId",response=Response.class)
102 public Response deleteE2EServiceInstance(String request, @PathParam("version") String version, @PathParam("serviceId") String serviceId) {
104 instanceIdMap.put("serviceId", serviceId);
106 return E2EserviceInstances(request, Action.deleteInstance, null, version);
109 private Response E2EserviceInstances(String requestJSON, Action action,
110 HashMap<String, String> instanceIdMap, String version) {
112 String requestId = UUIDChecker.generateUUID(msoLogger);
113 long startTime = System.currentTimeMillis();
114 msoLogger.debug("requestId is: " + requestId);
115 E2EServiceInstanceRequest sir = null;
117 MsoRequest msoRequest = new MsoRequest(requestId);
118 ObjectMapper mapper = new ObjectMapper();
121 .readValue(requestJSON, E2EServiceInstanceRequest.class);
123 } catch (Exception e) {
125 msoLogger.debug("Mapping of request to JSON object failed : ", e);
126 Response response = msoRequest.buildServiceErrorResponse(
127 HttpStatus.SC_BAD_REQUEST,
128 MsoException.ServiceException,
129 "Mapping of request to JSON object failed. "
130 + e.getMessage(), ErrorNumbers.SVC_BAD_PARAMETER,
132 msoLogger.error(MessageEnum.APIH_REQUEST_VALIDATION_ERROR,
133 MSO_PROP_APIHANDLER_INFRA, "", "",
134 MsoLogger.ErrorCode.SchemaError, requestJSON, e);
135 msoLogger.recordAuditEvent(startTime, MsoLogger.StatusCode.ERROR,
136 MsoLogger.ResponseCode.SchemaError,
137 "Mapping of request to JSON object failed");
138 msoLogger.debug("End of the transaction, the final response is: "
139 + (String) response.getEntity());
143 InfraActiveRequests dup = null;
144 String instanceName = sir.getService().getName();
145 String requestScope = sir.getService().getParameters().getNodeType();
148 if(!(instanceName==null && "service".equals(requestScope) && (action == Action.createInstance || action
149 == Action.activateInstance))){
150 dup = (RequestsDatabase.getInstance()).checkInstanceNameDuplicate (instanceIdMap, instanceName, requestScope);
152 } catch (Exception e) {
153 msoLogger.error (MessageEnum.APIH_DUPLICATE_CHECK_EXC, MSO_PROP_APIHANDLER_INFRA, "", "", MsoLogger.ErrorCode.DataError, "Error during duplicate check ", e);
155 Response response = msoRequest.buildServiceErrorResponse(HttpStatus.SC_INTERNAL_SERVER_ERROR, MsoException.ServiceException,
157 ErrorNumbers.SVC_DETAILED_SERVICE_ERROR,
161 msoLogger.recordAuditEvent (startTime, MsoLogger.StatusCode.ERROR, MsoLogger.ResponseCode.DBAccessError, "Error during duplicate check");
162 msoLogger.debug ("End of the transaction, the final response is: " + (String) response.getEntity ());
167 // Found the duplicate record. Return the appropriate error.
168 String instance = null;
169 if(instanceName != null){
170 instance = instanceName;
172 instance = instanceIdMap.get(requestScope + "InstanceId");
174 String dupMessage = "Error: Locked instance - This " + requestScope + " (" + instance + ") " + "already has a request being worked with a status of " + dup.getRequestStatus() + " (RequestId - " + dup.getRequestId() + "). The existing request must finish or be cleaned up before proceeding.";
176 Response response = msoRequest.buildServiceErrorResponse(HttpStatus.SC_CONFLICT, MsoException.ServiceException,
178 ErrorNumbers.SVC_DETAILED_SERVICE_ERROR,
182 msoLogger.warn (MessageEnum.APIH_DUPLICATE_FOUND, dupMessage, "", "", MsoLogger.ErrorCode.SchemaError, "Duplicate request - Subscriber already has a request for this service");
183 msoRequest.createRequestRecord (Status.FAILED, action);
184 msoLogger.recordAuditEvent (startTime, MsoLogger.StatusCode.ERROR, MsoLogger.ResponseCode.Conflict, dupMessage);
185 msoLogger.debug ("End of the transaction, the final response is: " + (String) response.getEntity ());
189 CatalogDatabase db = null;
190 RecipeLookupResult recipeLookupResult = null;
192 db = CatalogDatabase.getInstance();
193 recipeLookupResult = getServiceInstanceOrchestrationURI(db, sir, action);
194 } catch (Exception e) {
195 msoLogger.error (MessageEnum.APIH_DB_ACCESS_EXC, MSO_PROP_APIHANDLER_INFRA, "", "", MsoLogger.ErrorCode.AvailabilityError, "Exception while communciate with Catalog DB", e);
196 msoRequest.setStatus (org.openecomp.mso.apihandlerinfra.vnfbeans.RequestStatusType.FAILED);
197 Response response = msoRequest.buildServiceErrorResponse (HttpStatus.SC_NOT_FOUND,
198 MsoException.ServiceException,
199 "No communication to catalog DB " + e.getMessage (),
200 ErrorNumbers.SVC_NO_SERVER_RESOURCES,
202 alarmLogger.sendAlarm ("MsoDatabaseAccessError",
203 MsoAlarmLogger.CRITICAL,
204 Messages.errors.get (ErrorNumbers.NO_COMMUNICATION_TO_CATALOG_DB));
205 msoRequest.createRequestRecord (Status.FAILED,action);
206 msoLogger.recordAuditEvent (startTime, MsoLogger.StatusCode.ERROR, MsoLogger.ResponseCode.DBAccessError, "Exception while communciate with DB");
207 msoLogger.debug ("End of the transaction, the final response is: " + (String) response.getEntity ());
215 if (recipeLookupResult == null) {
216 msoLogger.error (MessageEnum.APIH_DB_ATTRIBUTE_NOT_FOUND, MSO_PROP_APIHANDLER_INFRA, "", "", MsoLogger.ErrorCode.DataError, "No recipe found in DB");
217 msoRequest.setStatus (org.openecomp.mso.apihandlerinfra.vnfbeans.RequestStatusType.FAILED);
218 Response response = msoRequest.buildServiceErrorResponse (HttpStatus.SC_NOT_FOUND,
219 MsoException.ServiceException,
220 "Recipe does not exist in catalog DB",
221 ErrorNumbers.SVC_GENERAL_SERVICE_ERROR,
223 msoRequest.createRequestRecord (Status.FAILED, action);
224 msoLogger.recordAuditEvent (startTime, MsoLogger.StatusCode.ERROR, MsoLogger.ResponseCode.DataNotFound, "No recipe found in DB");
225 msoLogger.debug ("End of the transaction, the final response is: " + (String) response.getEntity ());
231 String modelInfo = sir.getService().getParameters().getNodeTemplateName();
232 String[] arrayOfInfo = modelInfo.split(":");
233 String serviceInstanceType = arrayOfInfo[0];
237 String serviceId = "";
239 RequestClient requestClient = null;
240 HttpResponse response = null;
242 long subStartTime = System.currentTimeMillis();
243 String sirRequestJson = mappingObtainedRequestJSONToServiceInstanceRequest(sir);
246 requestClient = RequestClientFactory.getRequestClient (recipeLookupResult.getOrchestrationURI (), MsoPropertiesUtils.loadMsoProperties ());
248 // Capture audit event
249 msoLogger.debug ("MSO API Handler Posting call to BPEL engine for url: " + requestClient.getUrl ());
251 response = requestClient.post(requestId, false,
252 recipeLookupResult.getRecipeTimeout(),
253 action.name(), serviceId, null, null, null, null, serviceInstanceType,
254 null, null, null, sirRequestJson);
256 msoLogger.recordMetricEvent(subStartTime,
257 MsoLogger.StatusCode.COMPLETE, MsoLogger.ResponseCode.Suc,
258 "Successfully received response from BPMN engine", "BPMN",
259 recipeLookupResult.getOrchestrationURI(), null);
260 } catch (Exception e) {
261 msoLogger.recordMetricEvent(subStartTime,
262 MsoLogger.StatusCode.ERROR,
263 MsoLogger.ResponseCode.CommunicationError,
264 "Exception while communicate with BPMN engine", "BPMN",
265 recipeLookupResult.getOrchestrationURI(), null);
266 Response resp = msoRequest.buildServiceErrorResponse(
267 HttpStatus.SC_BAD_GATEWAY, MsoException.ServiceException,
268 "Failed calling bpmn " + e.getMessage(),
269 ErrorNumbers.SVC_NO_SERVER_RESOURCES, null);
270 alarmLogger.sendAlarm("MsoConfigurationError",
271 MsoAlarmLogger.CRITICAL,
272 Messages.errors.get(ErrorNumbers.NO_COMMUNICATION_TO_BPEL));
273 msoLogger.error(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR,
274 MSO_PROP_APIHANDLER_INFRA, "", "",
275 MsoLogger.ErrorCode.AvailabilityError,
276 "Exception while communicate with BPMN engine");
277 msoLogger.recordAuditEvent(startTime, MsoLogger.StatusCode.ERROR,
278 MsoLogger.ResponseCode.CommunicationError,
279 "Exception while communicate with BPMN engine");
280 msoLogger.debug("End of the transaction, the final response is: "
281 + (String) resp.getEntity());
285 if (response == null) {
286 Response resp = msoRequest.buildServiceErrorResponse(
287 HttpStatus.SC_BAD_GATEWAY, MsoException.ServiceException,
288 "bpelResponse is null",
289 ErrorNumbers.SVC_NO_SERVER_RESOURCES, null);
290 msoLogger.error(MessageEnum.APIH_BPEL_COMMUNICATE_ERROR,
291 MSO_PROP_APIHANDLER_INFRA, "", "",
292 MsoLogger.ErrorCode.BusinessProcesssError,
293 "Null response from BPEL");
294 msoLogger.recordAuditEvent(startTime, MsoLogger.StatusCode.ERROR,
295 MsoLogger.ResponseCode.InternalError,
296 "Null response from BPMN");
297 msoLogger.debug("End of the transaction, the final response is: "
298 + (String) resp.getEntity());
302 ResponseHandler respHandler = new ResponseHandler(response,
303 requestClient.getType());
304 int bpelStatus = respHandler.getStatus();
306 // BPEL accepted the request, the request is in progress
307 if (bpelStatus == HttpStatus.SC_ACCEPTED) {
308 String camundaJSONResponseBody = respHandler.getResponseBody();
310 .debug("Received from Camunda: " + camundaJSONResponseBody);
311 (RequestsDatabase.getInstance()).updateInfraStatus(requestId,
312 Status.IN_PROGRESS.toString(),
313 Constants.PROGRESS_REQUEST_IN_PROGRESS,
314 Constants.MODIFIED_BY_APIHANDLER);
316 msoLogger.recordAuditEvent(startTime,
317 MsoLogger.StatusCode.COMPLETE, MsoLogger.ResponseCode.Suc,
318 "BPMN accepted the request, the request is in progress");
319 msoLogger.debug("End of the transaction, the final response is: "
320 + (String) camundaJSONResponseBody);
321 return Response.status(HttpStatus.SC_ACCEPTED)
322 .entity(camundaJSONResponseBody).build();
324 List<String> variables = new ArrayList<String>();
325 variables.add(bpelStatus + "");
326 String camundaJSONResponseBody = respHandler.getResponseBody();
327 if (camundaJSONResponseBody != null
328 && !camundaJSONResponseBody.isEmpty()) {
329 Response resp = msoRequest.buildServiceErrorResponse(
330 bpelStatus, MsoException.ServiceException,
331 "Request Failed due to BPEL error with HTTP Status= %1 "
332 + '\n' + camundaJSONResponseBody,
333 ErrorNumbers.SVC_DETAILED_SERVICE_ERROR, variables);
334 msoLogger.error(MessageEnum.APIH_BPEL_RESPONSE_ERROR,
335 requestClient.getUrl(), "", "",
336 MsoLogger.ErrorCode.BusinessProcesssError,
337 "Response from BPEL engine is failed with HTTP Status="
339 msoLogger.recordAuditEvent(startTime,
340 MsoLogger.StatusCode.ERROR,
341 MsoLogger.ResponseCode.InternalError,
342 "Response from BPMN engine is failed");
344 .debug("End of the transaction, the final response is: "
345 + (String) resp.getEntity());
348 Response resp = msoRequest
349 .buildServiceErrorResponse(
351 MsoException.ServiceException,
352 "Request Failed due to BPEL error with HTTP Status= %1",
353 ErrorNumbers.SVC_DETAILED_SERVICE_ERROR,
355 msoLogger.error(MessageEnum.APIH_BPEL_RESPONSE_ERROR,
356 requestClient.getUrl(), "", "",
357 MsoLogger.ErrorCode.BusinessProcesssError,
358 "Response from BPEL engine is empty");
359 msoLogger.recordAuditEvent(startTime,
360 MsoLogger.StatusCode.ERROR,
361 MsoLogger.ResponseCode.InternalError,
362 "Response from BPEL engine is empty");
364 .debug("End of the transaction, the final response is: "
365 + (String) resp.getEntity());
371 private RecipeLookupResult getServiceInstanceOrchestrationURI(
372 CatalogDatabase db, E2EServiceInstanceRequest sir, Action action) {
374 RecipeLookupResult recipeLookupResult = null;
376 recipeLookupResult = getServiceURI(db, sir, action);
378 if (recipeLookupResult != null) {
379 msoLogger.debug ("Orchestration URI is: " + recipeLookupResult.getOrchestrationURI() + ", recipe Timeout is: " + Integer.toString(recipeLookupResult.getRecipeTimeout ()));
382 msoLogger.debug("No matching recipe record found");
384 return recipeLookupResult;
387 private RecipeLookupResult getServiceURI(CatalogDatabase db,
388 E2EServiceInstanceRequest sir, Action action) {
390 String defaultServiceModelName = "UUI_DEFAULT";
392 Service serviceRecord = null;
393 ServiceRecipe recipe = null;
395 serviceRecord = db.getServiceByModelName(defaultServiceModelName);
396 recipe = db.getServiceRecipeByModelUUID(serviceRecord.getModelUUID(), action.name());
398 if (recipe == null) {
401 return new RecipeLookupResult(recipe.getOrchestrationUri(),
402 recipe.getRecipeTimeout());
406 private String mappingObtainedRequestJSONToServiceInstanceRequest(E2EServiceInstanceRequest e2eSir){
408 ServiceInstancesRequest sir = new ServiceInstancesRequest();
410 String returnString = null;
411 RequestDetails requestDetails = new RequestDetails();
412 ModelInfo modelInfo = new ModelInfo();
415 modelInfo.setModelInvariantId(e2eSir.getService().getServiceDefId());
418 modelInfo.setModelNameVersionId(e2eSir.getService().getTemplateId());
420 String modelInfoValue = e2eSir.getService().getParameters().getNodeTemplateName();
421 String[] arrayOfInfo = modelInfoValue.split(":");
422 String modelName = arrayOfInfo[0];
423 String modelVersion = arrayOfInfo[1];
426 modelInfo.setModelName(modelName);
429 modelInfo.setModelVersion(modelVersion);
432 //if(ModelType.service.equals(e2eSir.getService().getParameters().getNodeType())){
433 modelInfo.setModelType(ModelType.service);
436 //setting modelInfo to requestDetails
437 requestDetails.setModelInfo(modelInfo);
439 SubscriberInfo subscriberInfo = new SubscriberInfo();
442 subscriberInfo.setGlobalSubscriberId(e2eSir.getService().getParameters().getGlobalSubscriberId());
445 subscriberInfo.setSubscriberName(e2eSir.getService().getParameters().getSubscriberName());
447 //setting subscriberInfo to requestDetails
448 requestDetails.setSubscriberInfo(subscriberInfo);
450 RequestInfo requestInfo = new RequestInfo();
453 requestInfo.setInstanceName(e2eSir.getService().getName());
456 requestInfo.setSource("UUI");
459 requestInfo.setSuppressRollback(true);
461 //setting requestInfo to requestDetails
462 requestDetails.setRequestInfo(requestInfo);
464 RequestParameters requestParameters = new RequestParameters();
466 //subscriptionServiceType
467 requestParameters.setSubscriptionServiceType("MOG");
470 List<E2EUserParam> userParams;
471 userParams = e2eSir.getService().getParameters().getRequestParameters().getUserParams();
472 List<Map<String, String>> userParamList = new ArrayList<>();
473 Map<String,String> userParamMap= new HashMap<>();
474 for(E2EUserParam userp: userParams){
475 userParamMap.put(userp.getName(), userp.getValue());
476 userParamList.add(userParamMap);
479 requestParameters.setUserParams(userParamList);
481 //setting requestParameters to requestDetails
482 requestDetails.setRequestParameters(requestParameters);
484 sir.setRequestDetails(requestDetails);
486 //converting to string
487 ObjectMapper mapper = new ObjectMapper();
489 returnString = mapper.writeValueAsString(sir);
490 } catch (IOException e) {
491 msoLogger.debug("Exception while converting ServiceInstancesRequest object to string", e);