catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConsumerServlet.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. 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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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=========================================================
  19  */
  20
  21 package org.openecomp.sdc.be.servlets;
  22
  23 import javax.inject.Singleton;
  24 import javax.servlet.ServletContext;
  25 import javax.servlet.http.HttpServletRequest;
  26 import javax.ws.rs.Consumes;
  27 import javax.ws.rs.DELETE;
  28 import javax.ws.rs.GET;
  29 import javax.ws.rs.HeaderParam;
  30 import javax.ws.rs.POST;
  31 import javax.ws.rs.Path;
  32 import javax.ws.rs.PathParam;
  33 import javax.ws.rs.Produces;
  34 import javax.ws.rs.core.Context;
  35 import javax.ws.rs.core.MediaType;
  36 import javax.ws.rs.core.Response;
  37
  38 import org.openecomp.sdc.be.components.impl.ConsumerBusinessLogic;
  39 import org.openecomp.sdc.be.config.BeEcompErrorManager;
  40 import org.openecomp.sdc.be.dao.api.ActionStatus;
  41 import org.openecomp.sdc.be.impl.WebAppContextWrapper;
  42 import org.openecomp.sdc.be.model.ConsumerDefinition;
  43 import org.openecomp.sdc.be.model.User;
  44 import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
  45 import org.openecomp.sdc.common.api.Constants;
  46 import org.openecomp.sdc.exception.ResponseFormat;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49 import org.springframework.web.context.WebApplicationContext;
  50
  51 import com.google.gson.Gson;
  52 import com.jcabi.aspects.Loggable;
  53
  54 import fj.data.Either;
  55 import io.swagger.annotations.Api;
  56 import io.swagger.annotations.ApiOperation;
  57 import io.swagger.annotations.ApiParam;
  58 import io.swagger.annotations.ApiResponse;
  59 import io.swagger.annotations.ApiResponses;
  60 @Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
  61 @Path("/v1/consumers")
  62 @Api(value = "Consumer Servlet", description = "Consumer Servlet")
  63 @Singleton
  64 public class ConsumerServlet extends BeGenericServlet {
  65
  66     private static final Logger log = LoggerFactory.getLogger(ConsumerServlet.class);
  67
  68     @POST
  69     @Consumes(MediaType.APPLICATION_JSON)
  70     @Produces(MediaType.APPLICATION_JSON)
  71     @ApiOperation(value = "Consumer credentials", httpMethod = "POST", notes = "Returns created ECOMP consumer credentials", response = Response.class)
  72     @ApiResponses(value = { @ApiResponse(code = 201, message = "Consumer credentials created"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content") })
  73     public Response createConsumer(@ApiParam(value = "Consumer Object to be created", required = true) String data, @Context final HttpServletRequest request, @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
  74
  75         ServletContext context = request.getSession().getServletContext();
  76
  77         String url = request.getMethod() + " " + request.getRequestURI();
  78         log.debug("Start handle request of {}", url);
  79
  80         User modifier = new User();
  81         modifier.setUserId(userId);
  82         log.debug("modifier id is {}", userId);
  83
  84         try {
  85             ConsumerBusinessLogic businessLogic = getConsumerBL(context);
  86
  87             Either<ConsumerDefinition, ResponseFormat> convertionResponse = convertJsonToObject(data, modifier, AuditingActionEnum.ADD_ECOMP_USER_CREDENTIALS);
  88
  89             if (convertionResponse.isRight()) {
  90                 log.debug("failed to create Consumer");
  91                 return buildErrorResponse(convertionResponse.right().value());
  92             }
  93
  94             ConsumerDefinition consumer = convertionResponse.left().value();
  95
  96             Either<ConsumerDefinition, ResponseFormat> actionResult = businessLogic.createConsumer(modifier, consumer);
  97
  98             if (actionResult.isRight()) {
  99                 log.debug("failed to create Consumer");
 100                 return buildErrorResponse(actionResult.right().value());
 101             }
 102
 103             return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.CREATED), actionResult.left().value());
 104
 105         } catch (Exception e) {
 106             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Create consumer");
 107             log.debug("create consumer failed with exception", e);
 108             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
 109             return buildErrorResponse(responseFormat);
 110
 111         }
 112     }
 113
 114     @GET
 115     @Path("/{consumerId}")
 116     @Consumes(MediaType.APPLICATION_JSON)
 117     @Produces(MediaType.APPLICATION_JSON)
 118     @ApiOperation(value = "Retrieve Consumer", httpMethod = "GET", notes = "Returns consumer according to ConsumerID", response = ConsumerDefinition.class)
 119     @ApiResponses(value = { @ApiResponse(code = 200, message = "Consumer found"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 404, message = "Consumer not found") })
 120     public Response getConsumer(@PathParam("consumerId") final String consumerId, @Context final HttpServletRequest request, @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
 121
 122         ServletContext context = request.getSession().getServletContext();
 123
 124         String url = request.getMethod() + " " + request.getRequestURI();
 125         log.debug("Start handle request of {}", url);
 126
 127         User modifier = new User();
 128         modifier.setUserId(userId);
 129         log.debug("modifier id is {}", userId);
 130
 131         Response response = null;
 132         try {
 133             ConsumerBusinessLogic businessLogic = getConsumerBL(context);
 134
 135             Either<ConsumerDefinition, ResponseFormat> actionResponse = businessLogic.getConsumer(consumerId, modifier);
 136
 137             if (actionResponse.isRight()) {
 138                 log.debug("failed to get consumer");
 139                 response = buildErrorResponse(actionResponse.right().value());
 140                 return response;
 141             }
 142             return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), actionResponse.left().value());
 143
 144         } catch (Exception e) {
 145             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Get Consumer");
 146             log.debug("get consumer failed with exception", e);
 147             return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
 148
 149         }
 150     }
 151
 152     @DELETE
 153     @Path("/{consumerId}")
 154     @Consumes(MediaType.APPLICATION_JSON)
 155     @Produces(MediaType.APPLICATION_JSON)
 156     @ApiOperation(value = "Deletes Consumer", httpMethod = "DELETE", notes = "Returns deleted consumer according to ConsumerID", response = ConsumerDefinition.class)
 157     @ApiResponses(value = { @ApiResponse(code = 204, message = "Consumer deleted"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 404, message = "Consumer not found") })
 158     public Response deleteConsumer(@PathParam("consumerId") final String consumerId, @Context final HttpServletRequest request, @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
 159
 160         ServletContext context = request.getSession().getServletContext();
 161
 162         String url = request.getMethod() + " " + request.getRequestURI();
 163         log.debug("Start handle request of {}", url);
 164
 165         User modifier = new User();
 166         modifier.setUserId(userId);
 167         log.debug("modifier id is {}", userId);
 168
 169         Response response = null;
 170         try {
 171             ConsumerBusinessLogic businessLogic = getConsumerBL(context);
 172
 173             Either<ConsumerDefinition, ResponseFormat> actionResponse = businessLogic.deleteConsumer(consumerId, modifier);
 174
 175             if (actionResponse.isRight()) {
 176                 log.debug("failed to delete consumer");
 177                 response = buildErrorResponse(actionResponse.right().value());
 178                 return response;
 179             }
 180             return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), actionResponse.left().value());
 181
 182         } catch (Exception e) {
 183             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Get Consumer");
 184             log.debug("delete consumer failed with exception", e);
 185             return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
 186
 187         }
 188     }
 189
 190     private ConsumerBusinessLogic getConsumerBL(ServletContext context) {
 191         WebAppContextWrapper webApplicationContextWrapper = (WebAppContextWrapper) context.getAttribute(Constants.WEB_APPLICATION_CONTEXT_WRAPPER_ATTR);
 192         WebApplicationContext webApplicationContext = webApplicationContextWrapper.getWebAppContext(context);
 193         ConsumerBusinessLogic consumerBL = webApplicationContext.getBean(ConsumerBusinessLogic.class);
 194
 195         return consumerBL;
 196     }
 197
 198     public Either<ConsumerDefinition, ResponseFormat> convertJsonToObject(String data, User user, AuditingActionEnum actionEnum) {
 199         ConsumerDefinition consumer = null;
 200         Gson gson = new Gson();
 201         try {
 202             log.trace("convert json to object. json=\n {}", data);
 203             consumer = gson.fromJson(data, ConsumerDefinition.class);
 204             if (consumer == null) {
 205                 BeEcompErrorManager.getInstance().logBeInvalidJsonInput("convertJsonToObject");
 206                 log.debug("object is null after converting from json");
 207                 //TODO call correct audit event method!!! - consumer!!!
 208                 ResponseFormat responseFormat = getComponentsUtils().getInvalidContentErrorAndAudit(user, "", actionEnum);
 209                 return Either.right(responseFormat);
 210             }
 211         } catch (Exception e) {
 212             // INVALID JSON
 213             BeEcompErrorManager.getInstance().logBeInvalidJsonInput("convertJsonToObject");
 214             log.debug("failed to convert from json {}", data, e);
 215             //TODO call correct audit event method!!! - consumer!!!
 216             ResponseFormat responseFormat = getComponentsUtils().getInvalidContentErrorAndAudit(user, "", actionEnum);
 217             return Either.right(responseFormat);
 218         }
 219         return Either.left(consumer);
 220     }
 221
 222 }