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.
17 package org.openecomp.sdc.be.servlets;
19 import static org.openecomp.sdc.be.tosca.utils.InterfacesOperationsToscaUtil.SELF;
21 import com.google.gson.Gson;
22 import com.google.gson.JsonParseException;
23 import com.jcabi.aspects.Loggable;
25 import java.util.ArrayList;
26 import java.util.HashMap;
27 import java.util.Iterator;
28 import java.util.List;
30 import java.util.Map.Entry;
31 import java.util.stream.Collectors;
33 import fj.data.Either;
34 import io.swagger.annotations.Api;
35 import io.swagger.annotations.ApiOperation;
36 import io.swagger.annotations.ApiParam;
37 import io.swagger.annotations.ApiResponse;
38 import io.swagger.annotations.ApiResponses;
39 import javax.inject.Inject;
40 import org.apache.commons.lang3.StringUtils;
41 import org.json.simple.JSONArray;
42 import org.json.simple.parser.JSONParser;
43 import org.json.simple.parser.ParseException;
44 import org.openecomp.sdc.be.components.impl.ComponentInstanceBusinessLogic;
45 import org.openecomp.sdc.be.components.impl.GroupBusinessLogic;
46 import org.openecomp.sdc.be.components.impl.InterfaceOperationBusinessLogic;
47 import org.openecomp.sdc.be.components.impl.ServiceBusinessLogic;
48 import org.openecomp.sdc.be.config.BeEcompErrorManager;
49 import org.openecomp.sdc.be.dao.api.ActionStatus;
50 import org.openecomp.sdc.be.datatypes.elements.OperationInputDefinition;
51 import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
52 import org.openecomp.sdc.be.impl.ComponentsUtils;
53 import org.openecomp.sdc.be.model.Operation;
54 import org.openecomp.sdc.be.model.OperationInput;
55 import org.openecomp.sdc.be.model.User;
56 import org.openecomp.sdc.be.model.tosca.ToscaFunctions;
57 import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
58 import org.openecomp.sdc.be.types.ServiceConsumptionData;
59 import org.openecomp.sdc.be.types.ServiceConsumptionSource;
60 import org.openecomp.sdc.be.user.UserBusinessLogic;
61 import org.openecomp.sdc.common.api.Constants;
62 import org.openecomp.sdc.exception.ResponseFormat;
63 import org.slf4j.Logger;
64 import org.slf4j.LoggerFactory;
66 import javax.inject.Singleton;
67 import javax.servlet.ServletContext;
68 import javax.servlet.http.HttpServletRequest;
69 import javax.ws.rs.Consumes;
70 import javax.ws.rs.GET;
71 import javax.ws.rs.HeaderParam;
72 import javax.ws.rs.POST;
73 import javax.ws.rs.Path;
74 import javax.ws.rs.PathParam;
75 import javax.ws.rs.Produces;
76 import javax.ws.rs.core.Context;
77 import javax.ws.rs.core.MediaType;
78 import javax.ws.rs.core.Response;
80 @Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
82 @Api(value = "Service Consumption Servlet", description = "Service Consumption Servlet")
84 public class ServiceConsumptionServlet extends BeGenericServlet {
86 private static final Logger log = LoggerFactory.getLogger(ServiceConsumptionServlet.class);
87 private final InterfaceOperationBusinessLogic interfaceOperationBusinessLogic;
88 private final ServiceBusinessLogic serviceBusinessLogic;
91 public ServiceConsumptionServlet(UserBusinessLogic userBusinessLogic,
92 ComponentsUtils componentsUtils,
93 InterfaceOperationBusinessLogic interfaceOperationBusinessLogic,
94 ServiceBusinessLogic serviceBusinessLogic) {
95 super(userBusinessLogic, componentsUtils);
96 this.interfaceOperationBusinessLogic = interfaceOperationBusinessLogic;
97 this.serviceBusinessLogic = serviceBusinessLogic;
101 @Path("/services/{serviceId}/consumption/{serviceInstanceId}")
102 @Consumes(MediaType.APPLICATION_JSON)
103 @Produces(MediaType.APPLICATION_JSON)
104 @ApiOperation(value = "Service consumption on operation", httpMethod = "POST",
105 notes = "Returns consumption data", response = Response.class)
106 @ApiResponses(value = { @ApiResponse(code = 201, message = "Service property created"),
107 @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content"),
108 @ApiResponse(code = 409, message = "Service property already exist") })
109 public Response addInputToServiceOperation(@PathParam("serviceId")final String serviceId,
110 @PathParam("serviceInstanceId")final String serviceInstanceId,
111 @ApiParam(value = "Service Consumption Data", required = true) String data,
112 @Context final HttpServletRequest request,
113 @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
114 ServletContext context = request.getSession().getServletContext();
116 String url = request.getMethod() + " " + request.getRequestURI();
117 log.debug("Start handle request of {} modifier id is {} data is {}", url, userId, data);
118 User modifier = new User();
119 modifier.setUserId(userId);
123 Either<Map<String, List<ServiceConsumptionData>>, ResponseFormat> dataFromJson =
124 getServiceConsumptionData(data, modifier);
125 if(dataFromJson.isRight()) {
126 return buildErrorResponse(dataFromJson.right().value());
129 Map<String, List<ServiceConsumptionData>> serviceConsumptionDataMap = dataFromJson.left().value();
131 for(Entry<String, List<ServiceConsumptionData>> consumptionEntry : serviceConsumptionDataMap.entrySet()) {
132 List<ServiceConsumptionData> consumptionList = consumptionEntry.getValue();
133 Either<List<Operation>, ResponseFormat> operationEither =
134 serviceBusinessLogic.addServiceConsumptionData(serviceId, serviceInstanceId,
135 consumptionEntry.getKey(), consumptionList, userId);
136 if (operationEither.isRight()) {
137 return buildErrorResponse(operationEither.right().value());
141 return buildOkResponse(serviceConsumptionDataMap);
144 catch (Exception e) {
145 BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Create Operation Inputs");
146 log.debug("Create Operation Inputs failed with exception", e);
147 ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
148 return buildErrorResponse(responseFormat);
154 @Path("/services/{serviceId}/consumption/{serviceInstanceId}/interfaces/{interfaceId}/operations/{operationId}/inputs")
155 @Consumes(MediaType.APPLICATION_JSON)
156 @Produces(MediaType.APPLICATION_JSON)
157 public Response getInputsListOfOperation(@PathParam("serviceId")final String serviceId,
158 @PathParam("serviceInstanceId")final String serviceInstanceId,
159 @PathParam("interfaceId")final String interfaceId,
160 @PathParam("operationId")final String operationId,
161 @Context final HttpServletRequest request,
162 @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
164 String url = request.getMethod() + " " + request.getRequestURI();
165 log.debug("Start handle request of {} modifier id is {}", url, userId);
166 User user = new User();
167 user.setUserId(userId);
170 Either<List<OperationInputDefinition>, ResponseFormat> inputsEither =
171 interfaceOperationBusinessLogic.getInputsListForOperation(serviceId, serviceInstanceId, interfaceId, operationId, user);
173 if(inputsEither.isRight()) {
174 return buildErrorResponse(inputsEither.right().value());
177 List<OperationInputDefinition> inputs = inputsEither.left().value();
178 return buildOkResponse(updateOperationInputListForUi(inputs, interfaceOperationBusinessLogic));
180 catch (Exception e) {
181 BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Get Operation Inputs");
182 log.debug("Get Operation Inputs failed with exception", e);
183 ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
184 return buildErrorResponse(responseFormat);
188 private List<OperationInput> updateOperationInputListForUi(List<OperationInputDefinition> inputsList,
189 InterfaceOperationBusinessLogic interfaceOperationBL) {
190 List<OperationInput> operationInputs = new ArrayList<>();
191 for(OperationInputDefinition input : inputsList) {
193 String value = input.getValue();
195 // Additional UI mapping needed for other sources
196 if (StringUtils.isNotBlank(value)
197 && !ServiceConsumptionSource.STATIC.getSource().equals(input.getSource())) {
198 uiMappingForOtherSources(value, input);
201 // Add Constraint for UI
202 OperationInput operationInput = new OperationInput(input);
203 operationInput.setConstraints(interfaceOperationBL.setInputConstraint(input));
204 operationInputs.add(operationInput);
207 return operationInputs;
210 private void uiMappingForOtherSources(String value, OperationInputDefinition input) {
212 Map<String, Object> valueAsMap = (new Gson()).fromJson(value, Map.class);
213 String toscaFunction = valueAsMap.keySet().iterator().next();
214 Object consumptionValueName = valueAsMap.values().iterator().next();
215 if(consumptionValueName instanceof List) {
216 List<Object> toscaFunctionList = (List<Object>) consumptionValueName;
217 String consumptionInputValue = null;
218 if (ToscaFunctions.GET_PROPERTY.getFunctionName().equals(toscaFunction)) {
219 String propertyValue = toscaFunctionList.stream()
220 .map(Object::toString)
221 .filter(val -> !val.equals(SELF))
222 .collect(Collectors.joining("_"));
223 consumptionInputValue = String.valueOf(propertyValue);
224 } else if (ToscaFunctions.GET_OPERATION_OUTPUT.getFunctionName().equals(toscaFunction)) {
225 //Return full output name
226 consumptionInputValue =
227 toscaFunctionList.get(1) + "." + toscaFunctionList.get(2) + "." +toscaFunctionList.get(3);
229 input.setValue(consumptionInputValue);
231 input.setValue(String.valueOf(consumptionValueName));
234 catch(JsonParseException ex){
235 log.info("This means it is static value for which no changes are needed");
239 private Either<Map<String, List<ServiceConsumptionData>>, ResponseFormat> getServiceConsumptionData(String data,
241 JSONParser parser = new JSONParser();
242 Map<String, List<ServiceConsumptionData>> serviceConsumptionDataMap = new HashMap<>();
245 JSONArray operationsArray = (JSONArray) parser.parse(data);
246 Iterator iterator = operationsArray.iterator();
247 while (iterator.hasNext()) {
248 Map next = (Map) iterator.next();
249 Entry consumptionEntry = (Entry) next.entrySet().iterator().next();
250 String operationId = (String) consumptionEntry.getKey();
251 Object value = consumptionEntry.getValue();
253 JSONArray inputsArray = (JSONArray) parser.parse(value.toString());
254 serviceConsumptionDataMap.putIfAbsent(operationId, new ArrayList<>());
255 for(Object consumptionObject : inputsArray) {
256 Either<ServiceConsumptionData, ResponseFormat> serviceDataEither =
258 .convertJsonToObjectUsingObjectMapper(consumptionObject.toString(), user, ServiceConsumptionData
259 .class, AuditingActionEnum.CREATE_RESOURCE, ComponentTypeEnum.SERVICE);
260 if(serviceDataEither.isRight()) {
261 return Either.right(serviceDataEither.right().value());
264 serviceConsumptionDataMap.get(operationId).add(serviceDataEither.left().value());
268 catch (ParseException e) {
269 log.info("Conetnt is invalid - {}", data);
270 return Either.right(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
272 return Either.left(serviceConsumptionDataMap);