2 * Copyright © 2016-2018 European Support Limited
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
16 package org.openecomp.sdc.be.servlets;
18 import static org.openecomp.sdc.be.tosca.InterfacesOperationsConverter.SELF;
20 import com.google.gson.Gson;
21 import com.google.gson.JsonParseException;
22 import com.jcabi.aspects.Loggable;
23 import fj.data.Either;
24 import io.swagger.v3.oas.annotations.Parameter;
25 import io.swagger.v3.oas.annotations.media.ArraySchema;
26 import io.swagger.v3.oas.annotations.media.Content;
27 import io.swagger.v3.oas.annotations.media.Schema;
28 import io.swagger.v3.oas.annotations.responses.ApiResponse;
29 import io.swagger.v3.oas.annotations.servers.Server;
30 import io.swagger.v3.oas.annotations.servers.Servers;
31 import io.swagger.v3.oas.annotations.tags.Tag;
32 import io.swagger.v3.oas.annotations.tags.Tags;
33 import java.util.ArrayList;
34 import java.util.HashMap;
35 import java.util.Iterator;
36 import java.util.List;
38 import java.util.Map.Entry;
39 import java.util.stream.Collectors;
40 import javax.inject.Inject;
41 import javax.inject.Singleton;
42 import javax.servlet.http.HttpServletRequest;
43 import javax.ws.rs.Consumes;
44 import javax.ws.rs.GET;
45 import javax.ws.rs.HeaderParam;
46 import javax.ws.rs.POST;
47 import javax.ws.rs.Path;
48 import javax.ws.rs.PathParam;
49 import javax.ws.rs.Produces;
50 import javax.ws.rs.core.Context;
51 import javax.ws.rs.core.MediaType;
52 import javax.ws.rs.core.Response;
53 import org.apache.commons.lang3.StringUtils;
54 import org.json.simple.JSONArray;
55 import org.json.simple.parser.JSONParser;
56 import org.json.simple.parser.ParseException;
57 import org.openecomp.sdc.be.components.impl.InterfaceOperationBusinessLogic;
58 import org.openecomp.sdc.be.components.impl.ServiceBusinessLogic;
59 import org.openecomp.sdc.be.config.BeEcompErrorManager;
60 import org.openecomp.sdc.be.dao.api.ActionStatus;
61 import org.openecomp.sdc.be.datatypes.elements.OperationInputDefinition;
62 import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
63 import org.openecomp.sdc.be.impl.ComponentsUtils;
64 import org.openecomp.sdc.be.model.Operation;
65 import org.openecomp.sdc.be.model.OperationInput;
66 import org.openecomp.sdc.be.model.User;
67 import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
68 import org.openecomp.sdc.be.types.ServiceConsumptionData;
69 import org.openecomp.sdc.be.types.ServiceConsumptionSource;
70 import org.openecomp.sdc.common.api.Constants;
71 import org.openecomp.sdc.exception.ResponseFormat;
72 import org.openecomp.sdc.tosca.datatypes.ToscaFunctions;
73 import org.slf4j.Logger;
74 import org.slf4j.LoggerFactory;
76 @Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
78 @Tags({@Tag(name = "SDCE-2 APIs")})
79 @Servers({@Server(url = "/sdc2/rest")})
81 public class ServiceConsumptionServlet extends BeGenericServlet {
83 private static final Logger log = LoggerFactory.getLogger(ServiceConsumptionServlet.class);
84 private final InterfaceOperationBusinessLogic interfaceOperationBusinessLogic;
85 private final ServiceBusinessLogic serviceBusinessLogic;
88 public ServiceConsumptionServlet(ComponentsUtils componentsUtils,
89 InterfaceOperationBusinessLogic interfaceOperationBusinessLogic, ServiceBusinessLogic serviceBusinessLogic) {
90 super(componentsUtils);
91 this.interfaceOperationBusinessLogic = interfaceOperationBusinessLogic;
92 this.serviceBusinessLogic = serviceBusinessLogic;
96 @Path("/services/{serviceId}/consumption/{serviceInstanceId}")
97 @Consumes(MediaType.APPLICATION_JSON)
98 @Produces(MediaType.APPLICATION_JSON)
99 @io.swagger.v3.oas.annotations.Operation(description = "Service consumption on operation", method = "POST", summary = "Returns consumption data", responses = {
100 @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))),
101 @ApiResponse(responseCode = "201", description = "Service property created"),
102 @ApiResponse(responseCode = "403", description = "Restricted operation"),
103 @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"),
104 @ApiResponse(responseCode = "409", description = "Service property already exist")})
105 public Response addInputToServiceOperation(@PathParam("serviceId") final String serviceId,
106 @PathParam("serviceInstanceId") final String serviceInstanceId,
107 @Parameter(description = "Service Consumption Data", required = true) String data,
108 @Context final HttpServletRequest request,
109 @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
110 String url = request.getMethod() + " " + request.getRequestURI();
111 log.debug("Start handle request of {} modifier id is {} data is {}", url, userId, data);
112 User modifier = new User();
113 modifier.setUserId(userId);
115 Either<Map<String, List<ServiceConsumptionData>>, ResponseFormat> dataFromJson = getServiceConsumptionData(data, modifier);
116 if (dataFromJson.isRight()) {
117 return buildErrorResponse(dataFromJson.right().value());
119 Map<String, List<ServiceConsumptionData>> serviceConsumptionDataMap = dataFromJson.left().value();
120 for (Entry<String, List<ServiceConsumptionData>> consumptionEntry : serviceConsumptionDataMap.entrySet()) {
121 List<ServiceConsumptionData> consumptionList = consumptionEntry.getValue();
122 Either<List<Operation>, ResponseFormat> operationEither = serviceBusinessLogic
123 .addServiceConsumptionData(serviceId, serviceInstanceId, consumptionEntry.getKey(), consumptionList, userId);
124 if (operationEither.isRight()) {
125 return buildErrorResponse(operationEither.right().value());
128 return buildOkResponse(serviceConsumptionDataMap);
129 } catch (Exception e) {
130 BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Create Operation Inputs");
131 log.debug("Create Operation Inputs failed with exception", e);
132 ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
133 return buildErrorResponse(responseFormat);
138 @Path("/services/{serviceId}/consumption/{serviceInstanceId}/interfaces/{interfaceId}/operations/{operationId}/inputs")
139 @Consumes(MediaType.APPLICATION_JSON)
140 @Produces(MediaType.APPLICATION_JSON)
141 public Response getInputsListOfOperation(@PathParam("serviceId") final String serviceId,
142 @PathParam("serviceInstanceId") final String serviceInstanceId,
143 @PathParam("interfaceId") final String interfaceId, @PathParam("operationId") final String operationId,
144 @Context final HttpServletRequest request,
145 @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
146 String url = request.getMethod() + " " + request.getRequestURI();
147 log.debug("Start handle request of {} modifier id is {}", url, userId);
148 User user = new User();
149 user.setUserId(userId);
151 Either<List<OperationInputDefinition>, ResponseFormat> inputsEither = interfaceOperationBusinessLogic
152 .getInputsListForOperation(serviceId, serviceInstanceId, interfaceId, operationId, user);
153 if (inputsEither.isRight()) {
154 return buildErrorResponse(inputsEither.right().value());
156 List<OperationInputDefinition> inputs = inputsEither.left().value();
157 return buildOkResponse(updateOperationInputListForUi(inputs, interfaceOperationBusinessLogic));
158 } catch (Exception e) {
159 BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Get Operation Inputs");
160 log.debug("Get Operation Inputs failed with exception", e);
161 ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
162 return buildErrorResponse(responseFormat);
166 private List<OperationInput> updateOperationInputListForUi(List<OperationInputDefinition> inputsList,
167 InterfaceOperationBusinessLogic interfaceOperationBL) {
168 List<OperationInput> operationInputs = new ArrayList<>();
169 for (OperationInputDefinition input : inputsList) {
170 String value = input.getValue();
171 // Additional UI mapping needed for other sources
172 if (StringUtils.isNotBlank(value) && !ServiceConsumptionSource.STATIC.getSource().equals(input.getSource())) {
173 uiMappingForOtherSources(value, input);
175 // Add Constraint for UI
176 OperationInput operationInput = new OperationInput(input);
177 operationInput.setConstraints(interfaceOperationBL.setInputConstraint(input));
178 operationInputs.add(operationInput);
180 return operationInputs;
183 private void uiMappingForOtherSources(String value, OperationInputDefinition input) {
185 Map<String, Object> valueAsMap = (new Gson()).fromJson(value, Map.class);
186 String toscaFunction = valueAsMap.keySet().iterator().next();
187 Object consumptionValueName = valueAsMap.values().iterator().next();
188 if (consumptionValueName instanceof List) {
189 List<Object> toscaFunctionList = (List<Object>) consumptionValueName;
190 String consumptionInputValue = null;
191 if (ToscaFunctions.GET_PROPERTY.getFunctionName().equals(toscaFunction)) {
192 String propertyValue = toscaFunctionList.stream().map(Object::toString).filter(val -> !val.equals(SELF))
193 .collect(Collectors.joining("_"));
194 consumptionInputValue = String.valueOf(propertyValue);
195 } else if (ToscaFunctions.GET_OPERATION_OUTPUT.getFunctionName().equals(toscaFunction)) {
196 //Return full output name
197 consumptionInputValue = toscaFunctionList.get(1) + "." + toscaFunctionList.get(2) + "." + toscaFunctionList.get(3);
199 input.setValue(consumptionInputValue);
201 input.setValue(String.valueOf(consumptionValueName));
203 } catch (JsonParseException ex) {
204 log.info("This means it is static value for which no changes are needed");
208 private Either<Map<String, List<ServiceConsumptionData>>, ResponseFormat> getServiceConsumptionData(String data, User user) {
209 JSONParser parser = new JSONParser();
210 Map<String, List<ServiceConsumptionData>> serviceConsumptionDataMap = new HashMap<>();
212 JSONArray operationsArray = (JSONArray) parser.parse(data);
213 Iterator iterator = operationsArray.iterator();
214 while (iterator.hasNext()) {
215 Map next = (Map) iterator.next();
216 Entry consumptionEntry = (Entry) next.entrySet().iterator().next();
217 String operationId = (String) consumptionEntry.getKey();
218 Object value = consumptionEntry.getValue();
219 JSONArray inputsArray = (JSONArray) parser.parse(value.toString());
220 serviceConsumptionDataMap.putIfAbsent(operationId, new ArrayList<>());
221 for (Object consumptionObject : inputsArray) {
222 Either<ServiceConsumptionData, ResponseFormat> serviceDataEither = getComponentsUtils()
223 .convertJsonToObjectUsingObjectMapper(consumptionObject.toString(), user, ServiceConsumptionData.class,
224 AuditingActionEnum.CREATE_RESOURCE, ComponentTypeEnum.SERVICE);
225 if (serviceDataEither.isRight()) {
226 return Either.right(serviceDataEither.right().value());
228 serviceConsumptionDataMap.get(operationId).add(serviceDataEither.left().value());
231 } catch (ParseException e) {
232 log.info("Conetnt is invalid - {}", data);
233 return Either.right(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
235 return Either.left(serviceConsumptionDataMap);