catalog-be/src/main/java/org/openecomp/sdc/be/distribution/servlet/DistributionServlet.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.distribution.servlet;
  22
  23 import javax.annotation.Resource;
  24 import javax.inject.Singleton;
  25 import javax.servlet.ServletContext;
  26 import javax.servlet.http.HttpServletRequest;
  27 import javax.ws.rs.Consumes;
  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.Produces;
  33 import javax.ws.rs.core.Context;
  34 import javax.ws.rs.core.MediaType;
  35 import javax.ws.rs.core.Response;
  36
  37 import org.openecomp.sdc.be.config.BeEcompErrorManager;
  38 import org.openecomp.sdc.be.dao.api.ActionStatus;
  39 import org.openecomp.sdc.be.distribution.AuditHandler;
  40 import org.openecomp.sdc.be.distribution.DistributionBusinessLogic;
  41 import org.openecomp.sdc.be.distribution.api.client.RegistrationRequest;
  42 import org.openecomp.sdc.be.distribution.api.client.ServerListResponse;
  43 import org.openecomp.sdc.be.impl.WebAppContextWrapper;
  44 import org.openecomp.sdc.be.model.operations.api.StorageOperationStatus;
  45 import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
  46 import org.openecomp.sdc.be.servlets.BeGenericServlet;
  47 import org.openecomp.sdc.common.api.ArtifactTypeEnum;
  48 import org.openecomp.sdc.common.api.Constants;
  49 import org.openecomp.sdc.common.config.EcompErrorName;
  50 import org.openecomp.sdc.common.datastructure.Wrapper;
  51 import org.openecomp.sdc.common.util.HttpUtil;
  52 import org.openecomp.sdc.exception.ResponseFormat;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55 import org.springframework.web.context.WebApplicationContext;
  56
  57 import com.jcabi.aspects.Loggable;
  58 import io.swagger.annotations.Api;
  59 import io.swagger.annotations.ApiOperation;
  60 import io.swagger.annotations.ApiResponse;
  61 import io.swagger.annotations.ApiResponses;
  62
  63 import fj.data.Either;
  64
  65 /**
  66  * This Servlet serves external users for distribution purposes.
  67  *
  68  * @author tgitelman
  69  *
  70  */
  71
  72 @Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
  73 @Path("/v1")
  74 @Api(value = "Distribution Servlet", description = "This Servlet serves external users for distribution purposes.")
  75 @Singleton
  76 public class DistributionServlet extends BeGenericServlet {
  77
  78         private static Logger log = LoggerFactory.getLogger(DistributionServlet.class.getName());
  79         @Resource
  80         private DistributionBusinessLogic distributionLogic;
  81
  82         @GET
  83         @Path("/distributionUebCluster")
  84         @Consumes(MediaType.APPLICATION_JSON)
  85         @Produces(MediaType.APPLICATION_JSON)
  86         @ApiOperation(value = "UEB Server List", httpMethod = "GET", notes = "return the available UEB Server List", response = String.class)
  87         @ApiResponses(value = { @ApiResponse(code = 200, message = "UEB server list fetched successfully"), @ApiResponse(code = 500, message = "One or more BE components (Titan, ES, BE) are down") })
  88         public Response getUebServerList(@Context final HttpServletRequest request, @HeaderParam(value = Constants.X_ECOMP_INSTANCE_ID_HEADER) String instanceId, @HeaderParam(value = Constants.X_ECOMP_REQUEST_ID_HEADER) String requestId,
  89                         @HeaderParam(value = Constants.AUTHORIZATION_HEADER) String authorization, @HeaderParam(value = Constants.ACCEPT_HEADER) String accept) {
  90                 init(request);
  91                 String url = request.getMethod() + " " + request.getRequestURI();
  92                 log.debug("Start handle request of {}", url);
  93                 Response response = null;
  94                 ResponseFormat responseFormat = null;
  95                 if (instanceId == null) {
  96                         responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_X_ECOMP_INSTANCE_ID);
  97                         response = buildErrorResponse(responseFormat);
  98                         getComponentsUtils().auditMissingInstanceId(AuditingActionEnum.GET_UEB_CLUSTER, responseFormat.getStatus().toString(), responseFormat.getFormattedMessage());
  99                         return response;
 100                 }
 101                 try {
 102                         Either<ServerListResponse, ResponseFormat> actionResponse = distributionLogic.getUebServerList();
 103
 104                         if (actionResponse.isRight()) {
 105                                 responseFormat = actionResponse.right().value();
 106                                 response = buildErrorResponse(responseFormat);
 107                         } else {
 108                                 responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.OK);
 109                                 response = buildOkResponse(responseFormat, actionResponse.left().value());
 110                         }
 111
 112                         getComponentsUtils().auditGetUebCluster(AuditingActionEnum.GET_UEB_CLUSTER, instanceId, null, responseFormat.getStatus().toString(), responseFormat.getFormattedMessage());
 113                         return response;
 114
 115                 } catch (Exception e) {
 116                         BeEcompErrorManager.getInstance().processEcompError(EcompErrorName.BeRestApiGeneralError, "failed to get ueb serbver list from cofiguration");
 117                         BeEcompErrorManager.getInstance().logBeRestApiGeneralError("failed to get ueb serbver list from cofiguration");
 118                         log.debug("failed to get ueb serbver list from cofiguration", e);
 119                         responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
 120                         getComponentsUtils().auditGetUebCluster(AuditingActionEnum.GET_UEB_CLUSTER, instanceId, null, responseFormat.getStatus().toString(), responseFormat.getFormattedMessage());
 121                         response = buildErrorResponse(responseFormat);
 122                         return response;
 123                 }
 124
 125         }
 126
 127         /**
 128          * Returns list of valid artifact types for validation done in the distribution client.<br>
 129          * The list is the representation of the values of the enum ArtifactTypeEnum.
 130          *
 131          * @param request
 132          * @param instanceId
 133          * @param requestId
 134          * @param authorization
 135          * @param accept
 136          * @return
 137          */
 138         @GET
 139         @Path("/artifactTypes")
 140         @Consumes(MediaType.APPLICATION_JSON)
 141         @Produces(MediaType.APPLICATION_JSON)
 142         @ApiOperation(value = "Artifact types list", httpMethod = "GET", notes = "Fetches available artifact types list", response = String.class)
 143         @ApiResponses(value = { @ApiResponse(code = 200, message = "Artifact types list fetched successfully"), @ApiResponse(code = 500, message = "One or more BE components (Titan, ES, BE) are down") })
 144         public Response getValidArtifactTypes(@Context final HttpServletRequest request, @HeaderParam(value = Constants.X_ECOMP_INSTANCE_ID_HEADER) String instanceId, @HeaderParam(value = Constants.X_ECOMP_REQUEST_ID_HEADER) String requestId,
 145                         @HeaderParam(value = Constants.AUTHORIZATION_HEADER) String authorization, @HeaderParam(value = Constants.ACCEPT_HEADER) String accept) {
 146                 init(request);
 147                 String url = request.getMethod() + " " + request.getRequestURI();
 148                 log.debug("Start handle request of {}", url);
 149                 Response response = null;
 150
 151                 Wrapper<Response> responseWrapper = new Wrapper<>();
 152
 153                 validateHeaders(responseWrapper, request, AuditingActionEnum.GET_VALID_ARTIFACT_TYPES);
 154                 if (responseWrapper.isEmpty()) {
 155                         response = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), ArtifactTypeEnum.values());
 156                 } else {
 157                         response = responseWrapper.getInnerElement();
 158                 }
 159                 return response;
 160         }
 161
 162         @POST
 163         @Path("/registerForDistribution")
 164         @Consumes(MediaType.APPLICATION_JSON)
 165         @Produces(MediaType.APPLICATION_JSON)
 166         @ApiOperation(value = "Subscription status", httpMethod = "POST", notes = "Subscribes for distribution notifications", response = String.class)
 167         @ApiResponses(value = { @ApiResponse(code = 200, message = "Subscribed for distribution notifications successfull"), @ApiResponse(code = 500, message = "One or more BE components (Titan, ES, BE) are down") })
 168         public Response registerForDistribution(@Context final HttpServletRequest request, String requestJson) {
 169                 String url = request.getMethod() + " " + request.getRequestURI();
 170                 log.debug("Start handle request of {}", url);
 171                 init(request);
 172
 173                 Wrapper<Response> responseWrapper = new Wrapper<>();
 174                 Wrapper<RegistrationRequest> registrationRequestWrapper = new Wrapper<>();
 175
 176                 validateHeaders(responseWrapper, request, AuditingActionEnum.ADD_KEY_TO_TOPIC_ACL);
 177
 178                 if (responseWrapper.isEmpty()) {
 179                         validateJson(responseWrapper, registrationRequestWrapper, requestJson);
 180                 }
 181                 if (responseWrapper.isEmpty()) {
 182                         validateEnv(responseWrapper, registrationRequestWrapper.getInnerElement().getDistrEnvName());
 183                 }
 184
 185                 if (responseWrapper.isEmpty()) {
 186                         distributionLogic.handleRegistration(responseWrapper, registrationRequestWrapper.getInnerElement(), buildAuditHandler(request, registrationRequestWrapper.getInnerElement()));
 187                 } else {
 188                         BeEcompErrorManager.getInstance().processEcompError(EcompErrorName.BeDistributionEngineSystemError, DistributionBusinessLogic.REGISTER_IN_DISTRIBUTION_ENGINE, "registration validation failed");
 189                         BeEcompErrorManager.getInstance().logBeDistributionEngineSystemError(DistributionBusinessLogic.REGISTER_IN_DISTRIBUTION_ENGINE, "registration validation failed");
 190                 }
 191
 192                 return responseWrapper.getInnerElement();
 193         }
 194
 195         @POST
 196         @Path("/unRegisterForDistribution")
 197         @Consumes(MediaType.APPLICATION_JSON)
 198         @Produces(MediaType.APPLICATION_JSON)
 199         @ApiOperation(value = "Subscription status", httpMethod = "POST", notes = "Removes from subscription for distribution notifications", response = String.class)
 200         @ApiResponses(value = { @ApiResponse(code = 200, message = "Successfully removed from subscription for distribution notifications"), @ApiResponse(code = 500, message = "One or more BE components (Titan, ES, BE) are down") })
 201         public Response unRegisterForDistribution(@Context final HttpServletRequest request, String requestJson) {
 202                 String url = request.getMethod() + " " + request.getRequestURI();
 203                 log.debug("Start handle request of {}", url);
 204                 init(request);
 205
 206                 Wrapper<Response> responseWrapper = new Wrapper<>();
 207                 Wrapper<RegistrationRequest> unRegistrationRequestWrapper = new Wrapper<>();
 208
 209                 validateHeaders(responseWrapper, request, AuditingActionEnum.REMOVE_KEY_FROM_TOPIC_ACL);
 210
 211                 if (responseWrapper.isEmpty()) {
 212                         validateJson(responseWrapper, unRegistrationRequestWrapper, requestJson);
 213                 }
 214                 if (responseWrapper.isEmpty()) {
 215                         validateEnv(responseWrapper, unRegistrationRequestWrapper.getInnerElement().getDistrEnvName());
 216                 }
 217                 if (responseWrapper.isEmpty()) {
 218                         distributionLogic.handleUnRegistration(responseWrapper, unRegistrationRequestWrapper.getInnerElement(), buildAuditHandler(request, unRegistrationRequestWrapper.getInnerElement()));
 219                 } else {
 220                         BeEcompErrorManager.getInstance().processEcompError(EcompErrorName.BeDistributionEngineSystemError, DistributionBusinessLogic.UN_REGISTER_IN_DISTRIBUTION_ENGINE, "unregistration validation failed");
 221                         BeEcompErrorManager.getInstance().logBeDistributionEngineSystemError(DistributionBusinessLogic.UN_REGISTER_IN_DISTRIBUTION_ENGINE, "unregistration validation failed");
 222                 }
 223
 224                 return responseWrapper.getInnerElement();
 225         }
 226
 227         private void validateEnv(Wrapper<Response> responseWrapper, String distrEnvName) {
 228
 229                 // DE194021
 230                 StorageOperationStatus environmentStatus = distributionLogic.getDistributionEngine().isEnvironmentAvailable();
 231                 // DE194021
 232                 // StorageOperationStatus environmentStatus =
 233                 // distributionLogic.getDistributionEngine().isEnvironmentAvailable(distrEnvName);
 234                 if (environmentStatus != StorageOperationStatus.OK) {
 235                         if (environmentStatus == StorageOperationStatus.DISTR_ENVIRONMENT_NOT_FOUND) {
 236                                 Response missingHeaderResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.DISTRIBUTION_ENV_DOES_NOT_EXIST));
 237                                 responseWrapper.setInnerElement(missingHeaderResponse);
 238                         } else {
 239                                 Response missingHeaderResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.GENERAL_ERROR));
 240                                 responseWrapper.setInnerElement(missingHeaderResponse);
 241                         }
 242                 }
 243
 244         }
 245
 246         private void init(HttpServletRequest request) {
 247                 if (distributionLogic == null) {
 248                         distributionLogic = getDistributionBL(request.getSession().getServletContext());
 249                 }
 250         }
 251
 252         private void validateHeaders(Wrapper<Response> responseWrapper, HttpServletRequest request, AuditingActionEnum auditingAction) {
 253                 if (request.getHeader(Constants.X_ECOMP_INSTANCE_ID_HEADER) == null) {
 254                         Response missingHeaderResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.MISSING_X_ECOMP_INSTANCE_ID));
 255                         responseWrapper.setInnerElement(missingHeaderResponse);
 256                         // Audit
 257                         ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_X_ECOMP_INSTANCE_ID);
 258                         getComponentsUtils().auditMissingInstanceId(auditingAction, responseFormat.getStatus().toString(), responseFormat.getFormattedMessage());
 259
 260                 }
 261
 262         }
 263
 264         private void validateJson(Wrapper<Response> responseWrapper, Wrapper<RegistrationRequest> registrationRequestWrapper, String requestJson) {
 265                 if (requestJson == null || requestJson.isEmpty()) {
 266                         Response missingBodyResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.MISSING_BODY));
 267                         responseWrapper.setInnerElement(missingBodyResponse);
 268                 } else {
 269                         Either<RegistrationRequest, Exception> eitherRegistration = HttpUtil.convertJsonStringToObject(requestJson, RegistrationRequest.class);
 270                         if (eitherRegistration.isLeft()) {
 271                                 RegistrationRequest registrationRequest = eitherRegistration.left().value();
 272                                 if (registrationRequest.getApiPublicKey() == null) {
 273                                         Response missingBodyResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.MISSING_PUBLIC_KEY));
 274                                         responseWrapper.setInnerElement(missingBodyResponse);
 275
 276                                 } else if (registrationRequest.getDistrEnvName() == null) {
 277                                         Response missingBodyResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.MISSING_ENV_NAME));
 278                                         responseWrapper.setInnerElement(missingBodyResponse);
 279                                 } else {
 280                                         registrationRequestWrapper.setInnerElement(registrationRequest);
 281                                 }
 282                         } else {
 283                                 Response missingBodyResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.MISSING_BODY));
 284                                 responseWrapper.setInnerElement(missingBodyResponse);
 285                         }
 286                 }
 287
 288         }
 289
 290         private DistributionBusinessLogic getDistributionBL(ServletContext context) {
 291                 WebAppContextWrapper webApplicationContextWrapper = (WebAppContextWrapper) context.getAttribute(Constants.WEB_APPLICATION_CONTEXT_WRAPPER_ATTR);
 292                 WebApplicationContext webApplicationContext = webApplicationContextWrapper.getWebAppContext(context);
 293                 return webApplicationContext.getBean(DistributionBusinessLogic.class);
 294         }
 295
 296         private AuditHandler buildAuditHandler(HttpServletRequest request, RegistrationRequest registrationRequest) {
 297                 return new AuditHandler(getComponentsUtils(), request.getHeader(Constants.X_ECOMP_INSTANCE_ID_HEADER), registrationRequest);
 298         }
 299 }