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