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
  59 import fj.data.Either;
  60
  61 @Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
  62 @Path("/v1")
  63 @Singleton
  64 public class DistributionServlet extends BeGenericServlet {
  65
  66         private static Logger log = LoggerFactory.getLogger(DistributionServlet.class.getName());
  67         @Resource
  68         private DistributionBusinessLogic distributionLogic;
  69
  70         @GET
  71         @Path("/distributionUebCluster")
  72         @Consumes(MediaType.APPLICATION_JSON)
  73         @Produces(MediaType.APPLICATION_JSON)
  74         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,
  75                         @HeaderParam(value = Constants.AUTHORIZATION_HEADER) String authorization, @HeaderParam(value = Constants.ACCEPT_HEADER) String accept) {
  76                 init(request);
  77                 String url = request.getMethod() + " " + request.getRequestURI();
  78                 log.debug("Start handle request of {}", url);
  79                 Response response = null;
  80                 ResponseFormat responseFormat = null;
  81                 if (instanceId == null) {
  82                         responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_X_ECOMP_INSTANCE_ID);
  83                         response = buildErrorResponse(responseFormat);
  84                         getComponentsUtils().auditMissingInstanceId(AuditingActionEnum.GET_UEB_CLUSTER, responseFormat.getStatus().toString(), responseFormat.getFormattedMessage());
  85                         return response;
  86                 }
  87                 try {
  88                         Either<ServerListResponse, ResponseFormat> actionResponse = distributionLogic.getUebServerList();
  89
  90                         if (actionResponse.isRight()) {
  91                                 responseFormat = actionResponse.right().value();
  92                                 response = buildErrorResponse(responseFormat);
  93                         } else {
  94                                 responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.OK);
  95                                 response = buildOkResponse(responseFormat, actionResponse.left().value());
  96                         }
  97
  98                         getComponentsUtils().auditGetUebCluster(AuditingActionEnum.GET_UEB_CLUSTER, instanceId, null, responseFormat.getStatus().toString(), responseFormat.getFormattedMessage());
  99                         return response;
 100
 101                 } catch (Exception e) {
 102                         BeEcompErrorManager.getInstance().processEcompError(EcompErrorName.BeRestApiGeneralError, "failed to get ueb serbver list from cofiguration");
 103                         BeEcompErrorManager.getInstance().logBeRestApiGeneralError("failed to get ueb serbver list from cofiguration");
 104                         log.debug("failed to get ueb serbver list from cofiguration", e);
 105                         responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
 106                         getComponentsUtils().auditGetUebCluster(AuditingActionEnum.GET_UEB_CLUSTER, instanceId, null, responseFormat.getStatus().toString(), responseFormat.getFormattedMessage());
 107                         response = buildErrorResponse(responseFormat);
 108                         return response;
 109                 }
 110
 111         }
 112
 113         /**
 114          * Returns list of valid artifact types for validation done in the distribution client.<br>
 115          * The list is the representation of the values of the enum ArtifactTypeEnum.
 116          *
 117          * @param request
 118          * @param instanceId
 119          * @param requestId
 120          * @param authorization
 121          * @param accept
 122          * @return
 123          */
 124         @GET
 125         @Path("/artifactTypes")
 126         @Consumes(MediaType.APPLICATION_JSON)
 127         @Produces(MediaType.APPLICATION_JSON)
 128         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,
 129                         @HeaderParam(value = Constants.AUTHORIZATION_HEADER) String authorization, @HeaderParam(value = Constants.ACCEPT_HEADER) String accept) {
 130                 init(request);
 131                 String url = request.getMethod() + " " + request.getRequestURI();
 132                 log.debug("Start handle request of {}", url);
 133                 Response response = null;
 134
 135                 Wrapper<Response> responseWrapper = new Wrapper<>();
 136
 137                 validateHeaders(responseWrapper, request, AuditingActionEnum.GET_VALID_ARTIFACT_TYPES);
 138                 if (responseWrapper.isEmpty()) {
 139                         response = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), ArtifactTypeEnum.values());
 140                 } else {
 141                         response = responseWrapper.getInnerElement();
 142                 }
 143                 return response;
 144         }
 145
 146         @POST
 147         @Path("/registerForDistribution")
 148         @Consumes(MediaType.APPLICATION_JSON)
 149         @Produces(MediaType.APPLICATION_JSON)
 150         public Response registerForDistribution(@Context final HttpServletRequest request, String requestJson) {
 151                 String url = request.getMethod() + " " + request.getRequestURI();
 152                 log.debug("Start handle request of {}", url);
 153                 init(request);
 154
 155                 Wrapper<Response> responseWrapper = new Wrapper<>();
 156                 Wrapper<RegistrationRequest> registrationRequestWrapper = new Wrapper<>();
 157
 158                 validateHeaders(responseWrapper, request, AuditingActionEnum.ADD_KEY_TO_TOPIC_ACL);
 159
 160                 if (responseWrapper.isEmpty()) {
 161                         validateJson(responseWrapper, registrationRequestWrapper, requestJson);
 162                 }
 163                 if (responseWrapper.isEmpty()) {
 164                         validateEnv(responseWrapper, registrationRequestWrapper.getInnerElement().getDistrEnvName());
 165                 }
 166
 167                 if (responseWrapper.isEmpty()) {
 168                         distributionLogic.handleRegistration(responseWrapper, registrationRequestWrapper.getInnerElement(), buildAuditHandler(request, registrationRequestWrapper.getInnerElement()));
 169                 } else {
 170                         BeEcompErrorManager.getInstance().processEcompError(EcompErrorName.BeDistributionEngineSystemError, DistributionBusinessLogic.REGISTER_IN_DISTRIBUTION_ENGINE, "registration validation failed");
 171                         BeEcompErrorManager.getInstance().logBeDistributionEngineSystemError(DistributionBusinessLogic.REGISTER_IN_DISTRIBUTION_ENGINE, "registration validation failed");
 172                 }
 173
 174                 return responseWrapper.getInnerElement();
 175         }
 176
 177         @POST
 178         @Path("/unRegisterForDistribution")
 179         @Consumes(MediaType.APPLICATION_JSON)
 180         @Produces(MediaType.APPLICATION_JSON)
 181         public Response unRegisterForDistribution(@Context final HttpServletRequest request, String requestJson) {
 182                 String url = request.getMethod() + " " + request.getRequestURI();
 183                 log.debug("Start handle request of {}", url);
 184                 init(request);
 185
 186                 Wrapper<Response> responseWrapper = new Wrapper<>();
 187                 Wrapper<RegistrationRequest> unRegistrationRequestWrapper = new Wrapper<>();
 188
 189                 validateHeaders(responseWrapper, request, AuditingActionEnum.REMOVE_KEY_FROM_TOPIC_ACL);
 190
 191                 if (responseWrapper.isEmpty()) {
 192                         validateJson(responseWrapper, unRegistrationRequestWrapper, requestJson);
 193                 }
 194                 if (responseWrapper.isEmpty()) {
 195                         validateEnv(responseWrapper, unRegistrationRequestWrapper.getInnerElement().getDistrEnvName());
 196                 }
 197                 if (responseWrapper.isEmpty()) {
 198                         distributionLogic.handleUnRegistration(responseWrapper, unRegistrationRequestWrapper.getInnerElement(), buildAuditHandler(request, unRegistrationRequestWrapper.getInnerElement()));
 199                 } else {
 200                         BeEcompErrorManager.getInstance().processEcompError(EcompErrorName.BeDistributionEngineSystemError, DistributionBusinessLogic.UN_REGISTER_IN_DISTRIBUTION_ENGINE, "unregistration validation failed");
 201                         BeEcompErrorManager.getInstance().logBeDistributionEngineSystemError(DistributionBusinessLogic.UN_REGISTER_IN_DISTRIBUTION_ENGINE, "unregistration validation failed");
 202                 }
 203
 204                 return responseWrapper.getInnerElement();
 205         }
 206
 207         private void validateEnv(Wrapper<Response> responseWrapper, String distrEnvName) {
 208
 209                 // DE194021
 210                 StorageOperationStatus environmentStatus = distributionLogic.getDistributionEngine().isEnvironmentAvailable();
 211                 // DE194021
 212                 // StorageOperationStatus environmentStatus =
 213                 // distributionLogic.getDistributionEngine().isEnvironmentAvailable(distrEnvName);
 214                 if (environmentStatus != StorageOperationStatus.OK) {
 215                         if (environmentStatus == StorageOperationStatus.DISTR_ENVIRONMENT_NOT_FOUND) {
 216                                 Response missingHeaderResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.DISTRIBUTION_ENV_DOES_NOT_EXIST));
 217                                 responseWrapper.setInnerElement(missingHeaderResponse);
 218                         } else {
 219                                 Response missingHeaderResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.GENERAL_ERROR));
 220                                 responseWrapper.setInnerElement(missingHeaderResponse);
 221                         }
 222                 }
 223
 224         }
 225
 226         private void init(HttpServletRequest request) {
 227                 if (distributionLogic == null) {
 228                         distributionLogic = getDistributionBL(request.getSession().getServletContext());
 229                 }
 230         }
 231
 232         private void validateHeaders(Wrapper<Response> responseWrapper, HttpServletRequest request, AuditingActionEnum auditingAction) {
 233                 if (request.getHeader(Constants.X_ECOMP_INSTANCE_ID_HEADER) == null) {
 234                         Response missingHeaderResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.MISSING_X_ECOMP_INSTANCE_ID));
 235                         responseWrapper.setInnerElement(missingHeaderResponse);
 236                         // Audit
 237                         ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_X_ECOMP_INSTANCE_ID);
 238                         getComponentsUtils().auditMissingInstanceId(auditingAction, responseFormat.getStatus().toString(), responseFormat.getFormattedMessage());
 239
 240                 }
 241
 242         }
 243
 244         private void validateJson(Wrapper<Response> responseWrapper, Wrapper<RegistrationRequest> registrationRequestWrapper, String requestJson) {
 245                 if (requestJson == null || requestJson.isEmpty()) {
 246                         Response missingBodyResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.MISSING_BODY));
 247                         responseWrapper.setInnerElement(missingBodyResponse);
 248                 } else {
 249                         Either<RegistrationRequest, Exception> eitherRegistration = HttpUtil.convertJsonStringToObject(requestJson, RegistrationRequest.class);
 250                         if (eitherRegistration.isLeft()) {
 251                                 RegistrationRequest registrationRequest = eitherRegistration.left().value();
 252                                 if (registrationRequest.getApiPublicKey() == null) {
 253                                         Response missingBodyResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.MISSING_PUBLIC_KEY));
 254                                         responseWrapper.setInnerElement(missingBodyResponse);
 255
 256                                 } else if (registrationRequest.getDistrEnvName() == null) {
 257                                         Response missingBodyResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.MISSING_ENV_NAME));
 258                                         responseWrapper.setInnerElement(missingBodyResponse);
 259                                 } else {
 260                                         registrationRequestWrapper.setInnerElement(registrationRequest);
 261                                 }
 262                         } else {
 263                                 Response missingBodyResponse = buildErrorResponse(distributionLogic.getResponseFormatManager().getResponseFormat(ActionStatus.MISSING_BODY));
 264                                 responseWrapper.setInnerElement(missingBodyResponse);
 265                         }
 266                 }
 267
 268         }
 269
 270         private DistributionBusinessLogic getDistributionBL(ServletContext context) {
 271                 WebAppContextWrapper webApplicationContextWrapper = (WebAppContextWrapper) context.getAttribute(Constants.WEB_APPLICATION_CONTEXT_WRAPPER_ATTR);
 272                 WebApplicationContext webApplicationContext = webApplicationContextWrapper.getWebAppContext(context);
 273                 return webApplicationContext.getBean(DistributionBusinessLogic.class);
 274         }
 275
 276         private AuditHandler buildAuditHandler(HttpServletRequest request, RegistrationRequest registrationRequest) {
 277                 return new AuditHandler(getComponentsUtils(), request.getHeader(Constants.X_ECOMP_INSTANCE_ID_HEADER), registrationRequest);
 278         }
 279 }