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