catalog-be/src/main/java/org/openecomp/sdc/be/servlets/AbstractValidationsServlet.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  * Modifications copyright (c) 2019 Nokia
  20  * ================================================================================
  21  */
  22 package org.openecomp.sdc.be.servlets;
  23
  24 import com.fasterxml.jackson.databind.ObjectMapper;
  25 import com.google.gson.Gson;
  26 import com.google.gson.JsonSyntaxException;
  27 import fj.data.Either;
  28 import java.io.File;
  29 import java.io.FileInputStream;
  30 import java.io.FileNotFoundException;
  31 import java.io.IOException;
  32 import java.io.InputStream;
  33 import java.lang.reflect.Type;
  34 import java.nio.charset.StandardCharsets;
  35 import java.util.Arrays;
  36 import java.util.HashMap;
  37 import java.util.List;
  38 import java.util.Map;
  39 import java.util.Optional;
  40 import java.util.function.Supplier;
  41 import javax.servlet.ServletContext;
  42 import javax.servlet.http.HttpServletRequest;
  43 import javax.ws.rs.core.Response;
  44 import org.apache.commons.codec.binary.Base64;
  45 import org.apache.commons.io.IOUtils;
  46 import org.apache.commons.lang3.StringUtils;
  47 import org.apache.commons.lang3.tuple.ImmutablePair;
  48 import org.openecomp.sdc.be.components.impl.ComponentInstanceBusinessLogic;
  49 import org.openecomp.sdc.be.components.impl.CsarValidationUtils;
  50 import org.openecomp.sdc.be.components.impl.ImportUtils;
  51 import org.openecomp.sdc.be.components.impl.ImportUtils.ResultStatusEnum;
  52 import org.openecomp.sdc.be.components.impl.ImportUtils.ToscaElementTypeEnum;
  53 import org.openecomp.sdc.be.components.impl.ResourceImportManager;
  54 import org.openecomp.sdc.be.components.impl.ServiceImportManager;
  55 import org.openecomp.sdc.be.components.impl.exceptions.ByActionStatusComponentException;
  56 import org.openecomp.sdc.be.components.impl.exceptions.ByResponseFormatComponentException;
  57 import org.openecomp.sdc.be.components.impl.exceptions.ComponentException;
  58 import org.openecomp.sdc.be.config.BeEcompErrorManager;
  59 import org.openecomp.sdc.be.config.ConfigurationManager;
  60 import org.openecomp.sdc.be.dao.api.ActionStatus;
  61 import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
  62 import org.openecomp.sdc.be.datatypes.enums.ResourceTypeEnum;
  63 import org.openecomp.sdc.be.impl.ComponentsUtils;
  64 import org.openecomp.sdc.be.impl.ServletUtils;
  65 import org.openecomp.sdc.be.impl.WebAppContextWrapper;
  66 import org.openecomp.sdc.be.model.ArtifactDefinition;
  67 import org.openecomp.sdc.be.model.Component;
  68 import org.openecomp.sdc.be.model.Resource;
  69 import org.openecomp.sdc.be.model.Service;
  70 import org.openecomp.sdc.be.model.UploadResourceInfo;
  71 import org.openecomp.sdc.be.model.UploadServiceInfo;
  72 import org.openecomp.sdc.be.model.User;
  73 import org.openecomp.sdc.be.resources.data.auditing.AuditingActionEnum;
  74 import org.openecomp.sdc.be.servlets.ResourceUploadServlet.ResourceAuthorityTypeEnum;
  75 import org.openecomp.sdc.be.servlets.ServiceUploadServlet.ServiceAuthorityTypeEnum;
  76 import org.openecomp.sdc.be.user.Role;
  77 import org.openecomp.sdc.be.user.UserBusinessLogic;
  78 import org.openecomp.sdc.be.utils.TypeUtils;
  79 import org.openecomp.sdc.common.api.Constants;
  80 import org.openecomp.sdc.common.api.UploadArtifactInfo;
  81 import org.openecomp.sdc.common.datastructure.Wrapper;
  82 import org.openecomp.sdc.common.log.wrappers.Logger;
  83 import org.openecomp.sdc.common.util.GeneralUtility;
  84 import org.openecomp.sdc.common.util.YamlToObjectConverter;
  85 import org.openecomp.sdc.common.zip.ZipUtils;
  86 import org.openecomp.sdc.common.zip.exception.ZipException;
  87 import org.openecomp.sdc.exception.ResponseFormat;
  88 import org.springframework.web.context.WebApplicationContext;
  89 import org.yaml.snakeyaml.Yaml;
  90
  91 public abstract class AbstractValidationsServlet extends BeGenericServlet {
  92
  93     private static final Logger log = Logger.getLogger(AbstractValidationsServlet.class);
  94     private static final String TOSCA_SIMPLE_YAML_PREFIX = "tosca_simple_yaml_";
  95     private static final List<String> TOSCA_DEFINITION_VERSIONS = Arrays
  96         .asList(TOSCA_SIMPLE_YAML_PREFIX + "1_0_0", TOSCA_SIMPLE_YAML_PREFIX + "1_1_0", "tosca_simple_profile_for_nfv_1_0_0",
  97             TOSCA_SIMPLE_YAML_PREFIX + "1_0", TOSCA_SIMPLE_YAML_PREFIX + "1_1", TOSCA_SIMPLE_YAML_PREFIX + "1_2", TOSCA_SIMPLE_YAML_PREFIX + "1_3");
  98     private static final List<String> TOSCA_YML_CSAR_VALID_SUFFIX = Arrays.asList(".yml", ".yaml", ".csar", ".meta");
  99     protected final ComponentInstanceBusinessLogic componentInstanceBusinessLogic;
 100     protected ServletUtils servletUtils;
 101     protected ResourceImportManager resourceImportManager;
 102     protected ServiceImportManager serviceImportManager;
 103
 104     public AbstractValidationsServlet(UserBusinessLogic userBusinessLogic, ComponentInstanceBusinessLogic componentInstanceBL,
 105                                       ComponentsUtils componentsUtils, ServletUtils servletUtils, ResourceImportManager resourceImportManager) {
 106         super(userBusinessLogic, componentsUtils);
 107         this.servletUtils = servletUtils;
 108         this.resourceImportManager = resourceImportManager;
 109         this.componentInstanceBusinessLogic = componentInstanceBL;
 110     }
 111
 112     public static void extractZipContents(Wrapper<String> yamlStringWrapper, File file) throws ZipException {
 113         final Map<String, byte[]> unzippedFolder = ZipUtils.readZip(file, false);
 114         String ymlName = unzippedFolder.keySet().iterator().next();
 115         fillToscaTemplateFromZip(yamlStringWrapper, ymlName, file);
 116     }
 117
 118     private static void fillToscaTemplateFromZip(final Wrapper<String> yamlStringWrapper, final String payloadName, final File file)
 119         throws ZipException {
 120         final Map<String, byte[]> unzippedFolder = ZipUtils.readZip(file, false);
 121         final byte[] yamlFileInBytes = unzippedFolder.get(payloadName);
 122         final String yamlAsString = new String(yamlFileInBytes, StandardCharsets.UTF_8);
 123         log.debug("received yaml: {}", yamlAsString);
 124         yamlStringWrapper.setInnerElement(yamlAsString);
 125     }
 126
 127     protected void init() {
 128     }
 129
 130     protected synchronized void initSpringFromContext() {
 131         if (serviceImportManager == null) {
 132             ServletContext context = servletRequest.getSession().getServletContext();
 133             WebAppContextWrapper webApplicationContextWrapper = (WebAppContextWrapper) context
 134                 .getAttribute(Constants.WEB_APPLICATION_CONTEXT_WRAPPER_ATTR);
 135             WebApplicationContext webApplicationContext = webApplicationContextWrapper.getWebAppContext(context);
 136             serviceImportManager = webApplicationContext.getBean(ServiceImportManager.class);
 137         }
 138     }
 139
 140     protected void validateResourceDoesNotExist(Wrapper<Response> responseWrapper, User user, String resourceName) {
 141         if (resourceImportManager.isResourceExist(resourceName)) {
 142             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.RESOURCE_ALREADY_EXISTS);
 143             Response errorResponse = buildErrorResponse(responseFormat);
 144             getComponentsUtils().auditResource(responseFormat, user, resourceName, AuditingActionEnum.IMPORT_RESOURCE);
 145             responseWrapper.setInnerElement(errorResponse);
 146         }
 147     }
 148
 149     protected void validateUserExist(Wrapper<Response> responseWrapper, Wrapper<User> userWrapper, String userUserId) {
 150         log.debug("get user {} from DB", userUserId);
 151         // get user details
 152         if (userUserId == null) {
 153             log.info("user userId is null");
 154             Response response = returnMissingInformation(new User());
 155             responseWrapper.setInnerElement(response);
 156         } else {
 157             UserBusinessLogic userAdmin = getServletUtils().getUserAdmin();
 158             try {
 159                 User user = userAdmin.getUser(userUserId);
 160                 userWrapper.setInnerElement(user);
 161             } catch (ComponentException ce) {
 162                 log.info("user is not listed. userId={}", userUserId);
 163                 User user = new User();
 164                 user.setUserId(userUserId);
 165                 Response response = returnMissingInformation(user);
 166                 responseWrapper.setInnerElement(response);
 167             }
 168         }
 169     }
 170
 171     protected Response returnMissingInformation(User user) {
 172         ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_INFORMATION);
 173         getComponentsUtils().auditResource(responseFormat, user, "", AuditingActionEnum.IMPORT_RESOURCE);
 174         return buildErrorResponse(responseFormat);
 175     }
 176
 177     protected void validateDataNotNull(Wrapper<Response> responseWrapper, Object... dataParams) {
 178         for (Object dataElement : dataParams) {
 179             if (dataElement == null) {
 180                 log.info("Invalid body was received.");
 181                 Response response = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
 182                 responseWrapper.setInnerElement(response);
 183                 break;
 184             }
 185         }
 186     }
 187
 188     protected void validateUserRole(Wrapper<Response> errorResponseWrapper, User user) {
 189         log.debug("validate user role");
 190         if (!user.getRole().equals(Role.ADMIN.name()) && !user.getRole().equals(Role.DESIGNER.name())) {
 191             log.info("user is not in appropriate role to perform action");
 192             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.RESTRICTED_OPERATION);
 193             log.debug("audit before sending response");
 194             getComponentsUtils().auditResource(responseFormat, user, "", AuditingActionEnum.IMPORT_RESOURCE);
 195             Response response = buildErrorResponse(responseFormat);
 196             errorResponseWrapper.setInnerElement(response);
 197         }
 198     }
 199
 200     protected void validateZip(final Wrapper<Response> responseWrapper, final File zipFile, final String payloadName) {
 201         if (StringUtils.isEmpty(payloadName)) {
 202             log.info("Invalid JSON was received. Payload name is empty");
 203             final Response errorResponse = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
 204             responseWrapper.setInnerElement(errorResponse);
 205             return;
 206         }
 207         final Map<String, byte[]> unzippedFolder;
 208         try {
 209             unzippedFolder = ZipUtils.readZip(zipFile, false);
 210         } catch (final ZipException e) {
 211             log.error("Could not read ZIP file '{}' for validation", zipFile.getName(), e);
 212             final Response errorResponse = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
 213             responseWrapper.setInnerElement(errorResponse);
 214             return;
 215         }
 216         if (!unzippedFolder.containsKey(payloadName)) {
 217             log.info("Could no find payload '{}' in ZIP file '{}'", payloadName, zipFile.getName());
 218             final Response errorResponse = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
 219             responseWrapper.setInnerElement(errorResponse);
 220         }
 221     }
 222
 223     protected void validateCsar(final Wrapper<Response> responseWrapper, final File csarFile, final String payloadName) {
 224         if (StringUtils.isEmpty(payloadName)) {
 225             log.info("Invalid JSON was received. Payload name is empty");
 226             Response errorResponse = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
 227             responseWrapper.setInnerElement(errorResponse);
 228             return;
 229         }
 230         final Map<String, byte[]> unzippedFolder;
 231         try {
 232             unzippedFolder = ZipUtils.readZip(csarFile, false);
 233         } catch (final ZipException e) {
 234             log.error("Could not read CSAR file '{}' for validation", csarFile.getName(), e);
 235             final Response errorResponse = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
 236             responseWrapper.setInnerElement(errorResponse);
 237             return;
 238         }
 239         if (unzippedFolder.isEmpty()) {
 240             log.info("The CSAR file is empty");
 241             Response errorResponse = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
 242             responseWrapper.setInnerElement(errorResponse);
 243         }
 244     }
 245
 246     protected void fillZipContents(Wrapper<String> yamlStringWrapper, File file) throws ZipException {
 247         extractZipContents(yamlStringWrapper, file);
 248     }
 249
 250     protected void fillPayloadDataFromFile(Wrapper<Response> responseWrapper, UploadResourceInfo uploadResourceInfoWrapper, File file) {
 251         try (InputStream fileInputStream = new FileInputStream(file)) {
 252             byte[] data = new byte[(int) file.length()];
 253             if (fileInputStream.read(data) == -1) {
 254                 log.info("Invalid json was received.");
 255                 ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
 256                 Response errorResp = buildErrorResponse(responseFormat);
 257                 responseWrapper.setInnerElement(errorResp);
 258             }
 259             String payloadData = Base64.encodeBase64String(data);
 260             uploadResourceInfoWrapper.setPayloadData(payloadData);
 261         } catch (IOException e) {
 262             log.info("Invalid json was received or Error while closing input Stream.");
 263             log.debug("Invalid json was received or Error while closing input Stream. {}", e.getMessage(), e);
 264             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
 265             Response errorResp = buildErrorResponse(responseFormat);
 266             responseWrapper.setInnerElement(errorResp);
 267         }
 268     }
 269
 270     protected void validateUserRole(Wrapper<Response> errorResponseWrapper, User user, ResourceAuthorityTypeEnum resourceAuthority) {
 271         log.debug("validate user role");
 272         if (resourceAuthority == ResourceAuthorityTypeEnum.NORMATIVE_TYPE_BE) {
 273             if (!user.getRole().equals(Role.ADMIN.name())) {
 274                 log.info("user is not in appropriate role to perform action");
 275                 ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.RESTRICTED_OPERATION);
 276                 log.debug("audit before sending response");
 277                 getComponentsUtils().auditResource(responseFormat, user, "", AuditingActionEnum.IMPORT_RESOURCE);
 278                 Response response = buildErrorResponse(responseFormat);
 279                 errorResponseWrapper.setInnerElement(response);
 280             }
 281         } else {
 282             validateUserRole(errorResponseWrapper, user);
 283         }
 284     }
 285
 286     protected void validateAndFillResourceJson(Wrapper<Response> responseWrapper, Wrapper<UploadResourceInfo> uploadResourceInfoWrapper, User user,
 287                                                ResourceAuthorityTypeEnum resourceAuthorityEnum, String resourceInfo) {
 288         boolean isValid;
 289         try {
 290             log.debug("The received json is {}", resourceInfo);
 291             UploadResourceInfo resourceInfoObject = gson.fromJson(resourceInfo, UploadResourceInfo.class);
 292             if (resourceInfoObject == null) {
 293                 isValid = false;
 294             } else {
 295                 resourceInfoObject.setNormative(!resourceAuthorityEnum.isUserTypeResource());
 296                 if (!resourceAuthorityEnum.isBackEndImport()) {
 297                     isValid = resourceInfoObject.getPayloadName() != null && !resourceInfoObject.getPayloadName().isEmpty();
 298                     //only resource name is checked
 299                 } else {
 300                     isValid = true;
 301                 }
 302                 uploadResourceInfoWrapper.setInnerElement(resourceInfoObject);
 303             }
 304         } catch (JsonSyntaxException e) {
 305             log.debug("Invalid json was received. {}", e.getMessage(), e);
 306             isValid = false;
 307         }
 308         if (!isValid) {
 309             log.info("Invalid json was received.");
 310             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
 311             getComponentsUtils().auditResource(responseFormat, user, "", AuditingActionEnum.IMPORT_RESOURCE);
 312             Response errorResp = buildErrorResponse(responseFormat);
 313             responseWrapper.setInnerElement(errorResp);
 314         }
 315     }
 316
 317     protected void validateAuthorityType(Wrapper<Response> responseWrapper, String authorityType) {
 318         log.debug("The received authority type is {}", authorityType);
 319         ResourceAuthorityTypeEnum authorityTypeEnum = ResourceAuthorityTypeEnum.findByUrlPath(authorityType);
 320         if (authorityTypeEnum == null) {
 321             log.info("Invalid authority type was received.");
 322             Response errorResp = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
 323             responseWrapper.setInnerElement(errorResp);
 324         }
 325     }
 326
 327     public ServletUtils getServletUtils() {
 328         return servletUtils;
 329     }
 330
 331     public Gson getGson() {
 332         return getServletUtils().getGson();
 333     }
 334
 335     public ComponentsUtils getComponentsUtils() {
 336         return getServletUtils().getComponentsUtils();
 337     }
 338
 339     protected void validatePayloadIsTosca(Wrapper<Response> responseWrapper, UploadResourceInfo uploadResourceInfo, User user, String toscaPayload) {
 340         log.debug("checking payload is valid tosca");
 341         boolean isValid;
 342         Map<String, Object> mappedToscaTemplate = (Map<String, Object>) new Yaml().load(toscaPayload);
 343         Either<String, ResultStatusEnum> findFirstToscaStringElement = ImportUtils
 344             .findFirstToscaStringElement(mappedToscaTemplate, TypeUtils.ToscaTagNamesEnum.TOSCA_VERSION);
 345         if (findFirstToscaStringElement.isRight()) {
 346             isValid = false;
 347         } else {
 348             String defenitionVersionFound = findFirstToscaStringElement.left().value();
 349             if (defenitionVersionFound == null || defenitionVersionFound.isEmpty()) {
 350                 isValid = false;
 351             } else {
 352                 isValid = TOSCA_DEFINITION_VERSIONS.contains(defenitionVersionFound);
 353             }
 354         }
 355         if (!isValid) {
 356             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_TOSCA_TEMPLATE);
 357             Response errorResponse = buildErrorResponse(responseFormat);
 358             getComponentsUtils().auditResource(responseFormat, user, uploadResourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
 359             responseWrapper.setInnerElement(errorResponse);
 360         }
 361     }
 362
 363     protected void validatePayloadIsYml(Wrapper<Response> responseWrapper, User user, UploadResourceInfo uploadResourceInfo,
 364                                         String toscaTamplatePayload) {
 365         log.debug("checking tosca template is valid yml");
 366         YamlToObjectConverter yamlConvertor = new YamlToObjectConverter();
 367         boolean isYamlValid = yamlConvertor.isValidYaml(toscaTamplatePayload.getBytes());
 368         if (!isYamlValid) {
 369             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_YAML_FILE);
 370             Response errorResponse = buildErrorResponse(responseFormat);
 371             getComponentsUtils().auditResource(responseFormat, user, uploadResourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
 372             responseWrapper.setInnerElement(errorResponse);
 373         }
 374     }
 375
 376     /**
 377      * Gets the Resource type from the given node type name.
 378      *
 379      * @param nodeTypeFullName - Node type Name
 380      * @return Resource Type name
 381      */
 382     private String getResourceType(final String nodeTypeFullName) {
 383         final Optional<String> nodeTypeNamePrefix = getNodeTypeNamePrefix(nodeTypeFullName);
 384         if (nodeTypeNamePrefix.isPresent()) {
 385             final String nameWithouNamespacePrefix = nodeTypeFullName.substring(nodeTypeNamePrefix.get().length());
 386             final String[] findTypes = nameWithouNamespacePrefix.split("\\.");
 387             if (findTypes.length > 0) {
 388                 final ResourceTypeEnum resourceType = ResourceTypeEnum.getType(findTypes[0].toUpperCase());
 389                 if (resourceType != null) {
 390                     return resourceType.name();
 391                 }
 392             }
 393         }
 394         return ResourceTypeEnum.VFC.name();
 395     }
 396
 397     /**
 398      * Extracts the Node Type Name prefix from the given Node Type Name.
 399      *
 400      * @param nodeName - Node Type Name
 401      * @return Node Type Name prefix
 402      */
 403     private Optional<String> getNodeTypeNamePrefix(final String nodeName) {
 404         final List<String> definedNodeTypeNamespaceList = ConfigurationManager.getConfigurationManager().getConfiguration()
 405             .getDefinedResourceNamespace();
 406         for (final String validNamespace : definedNodeTypeNamespaceList) {
 407             if (nodeName.startsWith(validNamespace)) {
 408                 return Optional.of(validNamespace);
 409             }
 410         }
 411         return Optional.empty();
 412     }
 413
 414     protected void validatePayloadNameSpace(final Wrapper<Response> responseWrapper, final UploadResourceInfo resourceInfo, final User user,
 415                                             final String toscaPayload) {
 416         boolean isValid;
 417         String namespace = "";
 418         final Map<String, Object> mappedToscaTemplate = (Map<String, Object>) new Yaml().load(toscaPayload);
 419         final Either<Map<String, Object>, ResultStatusEnum> toscaElement = ImportUtils
 420             .findFirstToscaMapElement(mappedToscaTemplate, TypeUtils.ToscaTagNamesEnum.NODE_TYPES);
 421         if (toscaElement.isRight() || toscaElement.left().value().size() != 1) {
 422             isValid = false;
 423         } else {
 424             namespace = toscaElement.left().value().keySet().iterator().next();
 425             isValid = getNodeTypeNamePrefix(namespace).isPresent();
 426         }
 427         if (!isValid) {
 428             final ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_RESOURCE_NAMESPACE);
 429             final Response errorResponse = buildErrorResponse(responseFormat);
 430             getComponentsUtils().auditResource(responseFormat, user, resourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
 431             responseWrapper.setInnerElement(errorResponse);
 432         } else {
 433             resourceInfo.setResourceType(getResourceType(namespace));
 434         }
 435     }
 436
 437     private void validatePayloadIsSingleResource(Wrapper<Response> responseWrapper, UploadResourceInfo uploadResourceInfo, User user,
 438                                                  String toscaPayload) {
 439         log.debug("checking payload contains single resource");
 440         boolean isValid;
 441         Map<String, Object> mappedToscaTemplate = (Map<String, Object>) new Yaml().load(toscaPayload);
 442         Either<Map<String, Object>, ResultStatusEnum> toscaElement = ImportUtils
 443             .findFirstToscaMapElement(mappedToscaTemplate, TypeUtils.ToscaTagNamesEnum.NODE_TYPES);
 444         if (toscaElement.isRight()) {
 445             isValid = false;
 446         } else {
 447             isValid = toscaElement.left().value().size() == 1;
 448         }
 449         if (!isValid) {
 450             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.NOT_SINGLE_RESOURCE);
 451             Response errorResponse = buildErrorResponse(responseFormat);
 452             getComponentsUtils().auditResource(responseFormat, user, uploadResourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
 453             responseWrapper.setInnerElement(errorResponse);
 454         }
 455     }
 456
 457     private void validatePayloadIsNotService(Wrapper<Response> responseWrapper, User user, UploadResourceInfo uploadResourceInfo,
 458                                              String toscaPayload) {
 459         log.debug("checking payload is not a tosca service");
 460         Map<String, Object> mappedToscaTemplate = (Map<String, Object>) new Yaml().load(toscaPayload);
 461         Either<Object, ResultStatusEnum> toscaElement = ImportUtils
 462             .findToscaElement(mappedToscaTemplate, TypeUtils.ToscaTagNamesEnum.TOPOLOGY_TEMPLATE, ToscaElementTypeEnum.ALL);
 463         if (toscaElement.isLeft()) {
 464             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.NOT_RESOURCE_TOSCA_TEMPLATE);
 465             Response errorResponse = buildErrorResponse(responseFormat);
 466             getComponentsUtils().auditResource(responseFormat, user, uploadResourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
 467             responseWrapper.setInnerElement(errorResponse);
 468         }
 469     }
 470
 471     private void validateToscaTemplatePayloadName(Wrapper<Response> responseWrapper, UploadResourceInfo uploadResourceInfo, User user) {
 472         String toscaTemplatePayloadName = uploadResourceInfo.getPayloadName();
 473         boolean isValidSuffix = isToscaTemplatePayloadNameValid(responseWrapper, toscaTemplatePayloadName);
 474         if (!isValidSuffix) {
 475             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_TOSCA_FILE_EXTENSION);
 476             Response errorResponse = buildErrorResponse(responseFormat);
 477             getComponentsUtils().auditResource(responseFormat, user, uploadResourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
 478             responseWrapper.setInnerElement(errorResponse);
 479         }
 480     }
 481
 482     private boolean isToscaTemplatePayloadNameValid(Wrapper<Response> responseWrapper, String toscaTemplatePayloadName) {
 483         boolean isValidSuffix = false;
 484         if (toscaTemplatePayloadName != null && !toscaTemplatePayloadName.isEmpty()) {
 485             for (String validSuffix : TOSCA_YML_CSAR_VALID_SUFFIX) {
 486                 isValidSuffix = isValidSuffix || toscaTemplatePayloadName.toLowerCase().endsWith(validSuffix);
 487             }
 488         }
 489         return isValidSuffix;
 490     }
 491
 492     private void validateMD5(Wrapper<Response> responseWrapper, User user, UploadResourceInfo resourceInfo, HttpServletRequest request,
 493                              String resourceInfoJsonString) {
 494         boolean isValid;
 495         String recievedMD5 = request.getHeader(Constants.MD5_HEADER);
 496         if (recievedMD5 == null) {
 497             isValid = false;
 498         } else {
 499             String calculateMD5 = GeneralUtility.calculateMD5Base64EncodedByString(resourceInfoJsonString);
 500             isValid = calculateMD5.equals(recievedMD5);
 501         }
 502         if (!isValid) {
 503             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_RESOURCE_CHECKSUM);
 504             Response errorResponse = buildErrorResponse(responseFormat);
 505             getComponentsUtils().auditResource(responseFormat, user, resourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
 506             responseWrapper.setInnerElement(errorResponse);
 507         }
 508     }
 509
 510     ComponentTypeEnum validateComponentType(String componentType) {
 511         if (componentType == null) {
 512             throw new ByActionStatusComponentException(ActionStatus.UNSUPPORTED_ERROR);
 513         }
 514         if (ComponentTypeEnum.RESOURCE_PARAM_NAME.equalsIgnoreCase(componentType)) {
 515             return ComponentTypeEnum.RESOURCE;
 516         }
 517         if (ComponentTypeEnum.SERVICE_PARAM_NAME.equalsIgnoreCase(componentType)) {
 518             return ComponentTypeEnum.SERVICE;
 519         }
 520         log.debug("Invalid componentType:{}", componentType);
 521         throw new ByActionStatusComponentException(ActionStatus.UNSUPPORTED_ERROR, componentType);
 522     }
 523
 524     ComponentTypeEnum convertToComponentType(String componentType) {
 525         return validateComponentType(componentType);
 526     }
 527
 528     private void fillToscaTemplateFromJson(Wrapper<Response> responseWrapper, Wrapper<String> yamlStringWrapper, User user,
 529                                            UploadResourceInfo resourceInfo) {
 530         if (resourceInfo.getPayloadData() == null || resourceInfo.getPayloadData().isEmpty()) {
 531             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_RESOURCE_PAYLOAD);
 532             Response errorResponse = buildErrorResponse(responseFormat);
 533             getComponentsUtils().auditResource(responseFormat, user, resourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
 534             responseWrapper.setInnerElement(errorResponse);
 535         } else {
 536             String toscaPayload = resourceInfo.getPayloadData();
 537             String decodedPayload = new String(Base64.decodeBase64(toscaPayload));
 538             yamlStringWrapper.setInnerElement(decodedPayload);
 539         }
 540     }
 541
 542     void fillPayload(Wrapper<Response> responseWrapper, Wrapper<UploadResourceInfo> uploadResourceInfoWrapper, Wrapper<String> yamlStringWrapper,
 543                      User user, String resourceInfoJsonString, ResourceAuthorityTypeEnum resourceAuthorityEnum, File file) throws ZipException {
 544         if (responseWrapper.isEmpty()) {
 545             if (resourceAuthorityEnum.isBackEndImport()) {
 546                 // PrePayload Validations
 547                 if (responseWrapper.isEmpty()) {
 548                     validateDataNotNull(responseWrapper, file, resourceInfoJsonString);
 549                 }
 550                 if (!resourceAuthorityEnum.equals(ResourceAuthorityTypeEnum.CSAR_TYPE_BE)) {
 551                     if (responseWrapper.isEmpty()) {
 552                         validateZip(responseWrapper, file, uploadResourceInfoWrapper.getInnerElement().getPayloadName());
 553                     }
 554                     // Fill PayLoad From File
 555                     if (responseWrapper.isEmpty()) {
 556                         fillToscaTemplateFromZip(yamlStringWrapper, uploadResourceInfoWrapper.getInnerElement().getPayloadName(), file);
 557                     }
 558                 } else {
 559                     if (responseWrapper.isEmpty()) {
 560                         validateCsar(responseWrapper, file, uploadResourceInfoWrapper.getInnerElement().getPayloadName());
 561                     }
 562                     // Fill PayLoad From File
 563                     if (responseWrapper.isEmpty()) {
 564                         fillPayloadDataFromFile(responseWrapper, uploadResourceInfoWrapper.getInnerElement(), file);
 565                     }
 566                 }
 567             } else {
 568                 // Fill PayLoad From JSON
 569                 if (responseWrapper.isEmpty()) {
 570                     fillToscaTemplateFromJson(responseWrapper, yamlStringWrapper, user, uploadResourceInfoWrapper.getInnerElement());
 571                 }
 572             }
 573         }
 574     }
 575
 576     protected void specificResourceAuthorityValidations(final Wrapper<Response> responseWrapper,
 577                                                         final Wrapper<UploadResourceInfo> uploadResourceInfoWrapper,
 578                                                         final Wrapper<String> yamlStringWrapper, final User user, final HttpServletRequest request,
 579                                                         final String resourceInfoJsonString, final ResourceAuthorityTypeEnum resourceAuthorityEnum) {
 580         if (responseWrapper.isEmpty()) {
 581             // UI Only Validation
 582             if (!resourceAuthorityEnum.isBackEndImport()) {
 583                 importUIValidations(responseWrapper, uploadResourceInfoWrapper.getInnerElement(), user, request, resourceInfoJsonString);
 584             }
 585             // User Defined Type Resources
 586             if (resourceAuthorityEnum.isUserTypeResource() && !CsarValidationUtils
 587                 .isCsarPayloadName(uploadResourceInfoWrapper.getInnerElement().getPayloadName()) && responseWrapper.isEmpty()) {
 588                 validatePayloadNameSpace(responseWrapper, uploadResourceInfoWrapper.getInnerElement(), user, yamlStringWrapper.getInnerElement());
 589             }
 590         }
 591     }
 592
 593     void commonGeneralValidations(Wrapper<Response> responseWrapper, Wrapper<User> userWrapper, Wrapper<UploadResourceInfo> uploadResourceInfoWrapper,
 594                                   ResourceAuthorityTypeEnum resourceAuthorityEnum, String userId, String resourceInfoJsonString) {
 595         if (responseWrapper.isEmpty()) {
 596             validateUserExist(responseWrapper, userWrapper, userId);
 597         }
 598         if (responseWrapper.isEmpty()) {
 599             validateUserRole(responseWrapper, userWrapper.getInnerElement(), resourceAuthorityEnum);
 600         }
 601         if (responseWrapper.isEmpty()) {
 602             validateAndFillResourceJson(responseWrapper, uploadResourceInfoWrapper, userWrapper.getInnerElement(), resourceAuthorityEnum,
 603                 resourceInfoJsonString);
 604         }
 605         if (responseWrapper.isEmpty()) {
 606             validateToscaTemplatePayloadName(responseWrapper, uploadResourceInfoWrapper.getInnerElement(), userWrapper.getInnerElement());
 607         }
 608         if (responseWrapper.isEmpty()) {
 609             validateResourceType(responseWrapper, uploadResourceInfoWrapper.getInnerElement(), userWrapper.getInnerElement());
 610         }
 611     }
 612
 613     private void validateResourceType(Wrapper<Response> responseWrapper, UploadResourceInfo uploadResourceInfo, User user) {
 614         String resourceType = uploadResourceInfo.getResourceType();
 615         if (resourceType == null || !ResourceTypeEnum.containsName(resourceType)) {
 616             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
 617             Response errorResponse = buildErrorResponse(responseFormat);
 618             getComponentsUtils().auditResource(responseFormat, user, uploadResourceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
 619             responseWrapper.setInnerElement(errorResponse);
 620         }
 621     }
 622
 623     private void importUIValidations(Wrapper<Response> responseWrapper, UploadResourceInfo resourceInfo, User user, HttpServletRequest request,
 624                                      String resourceInfoJsonString) {
 625         if (responseWrapper.isEmpty()) {
 626             validateMD5(responseWrapper, user, resourceInfo, request, resourceInfoJsonString);
 627         }
 628         if (responseWrapper.isEmpty() && request != null && request.getMethod() != null && request.getMethod().equals("POST")) {
 629             validateResourceDoesNotExist(responseWrapper, user, resourceInfo.getName());
 630         }
 631     }
 632
 633     void commonPayloadValidations(Wrapper<Response> responseWrapper, Wrapper<String> yamlStringWrapper, User user,
 634                                   UploadResourceInfo uploadResourceInfo) {
 635         if (responseWrapper.isEmpty()) {
 636             validatePayloadIsYml(responseWrapper, user, uploadResourceInfo, yamlStringWrapper.getInnerElement());
 637         }
 638         if (responseWrapper.isEmpty()) {
 639             validatePayloadIsTosca(responseWrapper, uploadResourceInfo, user, yamlStringWrapper.getInnerElement());
 640         }
 641         if (responseWrapper.isEmpty()) {
 642             validatePayloadIsNotService(responseWrapper, user, uploadResourceInfo, yamlStringWrapper.getInnerElement());
 643         }
 644         if (responseWrapper.isEmpty()) {
 645             validatePayloadIsSingleResource(responseWrapper, uploadResourceInfo, user, yamlStringWrapper.getInnerElement());
 646         }
 647     }
 648
 649     void handleImport(Wrapper<Response> responseWrapper, User user, UploadResourceInfo resourceInfoObject, String yamlAsString,
 650                       ResourceAuthorityTypeEnum authority, boolean createNewVersion, String resourceUniqueId) {
 651         ImmutablePair<Resource, ActionStatus> createOrUpdateResponse = null;
 652         Response response = null;
 653         Object representation = null;
 654         ImmutablePair<Resource, ActionStatus> importedResourceStatus = null;
 655         if (CsarValidationUtils.isCsarPayloadName(resourceInfoObject.getPayloadName())) {
 656             log.debug("import resource from csar");
 657             importedResourceStatus = importResourceFromUICsar(resourceInfoObject, user, resourceUniqueId);
 658         } else if (!authority.isUserTypeResource()) {
 659             log.debug("import normative type resource");
 660             createOrUpdateResponse =
 661                 resourceImportManager.importNormativeResource(yamlAsString, resourceInfoObject, user, createNewVersion, true, false);
 662         } else {
 663             log.debug("import user resource (not normative type)");
 664             createOrUpdateResponse = resourceImportManager.importUserDefinedResource(yamlAsString, resourceInfoObject, user, false);
 665         }
 666         if (createOrUpdateResponse != null) {
 667             importedResourceStatus = createOrUpdateResponse;
 668         }
 669         if (importedResourceStatus != null) {
 670             try {
 671                 representation = RepresentationUtils.toRepresentation(importedResourceStatus.left);
 672             } catch (IOException e) {
 673                 log.debug("Error while building resource representation : {}", e.getMessage(), e);
 674             }
 675             response = buildOkResponse(getComponentsUtils().getResponseFormat(importedResourceStatus.right), representation);
 676         }
 677         responseWrapper.setInnerElement(response);
 678     }
 679
 680     private ImmutablePair<Resource, ActionStatus> importResourceFromUICsar(UploadResourceInfo resourceInfoObject, User user,
 681                                                                            String resourceUniqueId) {
 682         Resource newResource;
 683         ActionStatus actionStatus;
 684         Resource resource = new Resource();
 685         String payloadName = resourceInfoObject.getPayloadName();
 686         fillResourceFromResourceInfoObject(resource, resourceInfoObject);
 687         Map<String, byte[]> csarUIPayload = getCsarFromPayload(resourceInfoObject);
 688         getAndValidateCsarYaml(csarUIPayload, resource, user, payloadName);
 689         if (resourceUniqueId == null || resourceUniqueId.isEmpty()) {
 690             newResource = resourceImportManager.getResourceBusinessLogic()
 691                 .createResource(resource, AuditingActionEnum.CREATE_RESOURCE, user, csarUIPayload, payloadName);
 692             actionStatus = ActionStatus.CREATED;
 693         } else {
 694             newResource = resourceImportManager.getResourceBusinessLogic()
 695                 .validateAndUpdateResourceFromCsar(resource, user, csarUIPayload, payloadName, resourceUniqueId);
 696             actionStatus = ActionStatus.OK;
 697         }
 698         return new ImmutablePair<>(newResource, actionStatus);
 699     }
 700
 701     protected Resource throwComponentException(ResponseFormat responseFormat) {
 702         throw new ByResponseFormatComponentException(responseFormat);
 703     }
 704
 705     private void getAndValidateCsarYaml(Map<String, byte[]> csarUIPayload, Resource resource, User user, String csarUUID) {
 706         getAndValidateComponentCsarYaml(csarUIPayload, resource, user, csarUUID);
 707     }
 708
 709     private void getAndValidateComponentCsarYaml(Map<String, byte[]> csarUIPayload, Component component, User user, String csarUUID) {
 710         Either<ImmutablePair<String, String>, ResponseFormat> getToscaYamlRes = CsarValidationUtils
 711             .getToscaYaml(csarUIPayload, csarUUID, getComponentsUtils());
 712         if (getToscaYamlRes.isRight()) {
 713             ResponseFormat responseFormat = getToscaYamlRes.right().value();
 714             log.debug("Error when try to get csar toscayamlFile with csar ID {}, error: {}", csarUUID, responseFormat);
 715             if (component instanceof Resource) {
 716                 BeEcompErrorManager.getInstance().logBeDaoSystemError("Creating resource from CSAR: fetching CSAR with id " + csarUUID + " failed");
 717                 getComponentsUtils().auditResource(responseFormat, user, (Resource) component, AuditingActionEnum.CREATE_RESOURCE);
 718             } else {
 719                 BeEcompErrorManager.getInstance().logBeDaoSystemError("Creating service from CSAR: fetching CSAR with id " + csarUUID + " failed");
 720             }
 721             throwComponentException(responseFormat);
 722         }
 723         String toscaYaml = getToscaYamlRes.left().value().getValue();
 724         log.debug("checking tosca template is valid yml");
 725         YamlToObjectConverter yamlConvertor = new YamlToObjectConverter();
 726         boolean isValid = yamlConvertor.isValidYaml(toscaYaml.getBytes());
 727         if (!isValid) {
 728             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_YAML_FILE);
 729             if (component instanceof Resource) {
 730                 getComponentsUtils().auditResource(responseFormat, user, (Resource) component, AuditingActionEnum.IMPORT_RESOURCE);
 731             }
 732             throwComponentException(responseFormat);
 733         }
 734         log.debug("checking payload is valid tosca");
 735         Map<String, Object> mappedToscaTemplate = (Map<String, Object>) new Yaml().load(toscaYaml);
 736         Either<String, ResultStatusEnum> findFirstToscaStringElement = ImportUtils
 737             .findFirstToscaStringElement(mappedToscaTemplate, TypeUtils.ToscaTagNamesEnum.TOSCA_VERSION);
 738         if (findFirstToscaStringElement.isRight()) {
 739             isValid = false;
 740         } else {
 741             String defenitionVersionFound = findFirstToscaStringElement.left().value();
 742             if (defenitionVersionFound == null || defenitionVersionFound.isEmpty()) {
 743                 isValid = false;
 744             } else {
 745                 isValid = TOSCA_DEFINITION_VERSIONS.contains(defenitionVersionFound);
 746             }
 747         }
 748         if (!isValid) {
 749             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_TOSCA_TEMPLATE);
 750             if (component instanceof Resource) {
 751                 log.debug("enter getAndValidateComponentCsarYaml,component instanceof Resource");
 752                 getComponentsUtils().auditResource(responseFormat, user, (Resource) component, AuditingActionEnum.IMPORT_RESOURCE);
 753             }
 754             throwComponentException(responseFormat);
 755         }
 756     }
 757
 758     private void fillResourceFromResourceInfoObject(Resource resource, UploadResourceInfo resourceInfoObject) {
 759         resourceImportManager.populateResourceMetadata(resourceInfoObject, resource);
 760         fillArtifacts(resource, resourceInfoObject);
 761     }
 762
 763     private void fillArtifacts(Resource resource, UploadResourceInfo resourceInfoObject) {
 764         if (resource != null && resourceInfoObject != null) {
 765             List<UploadArtifactInfo> artifactList = resourceInfoObject.getArtifactList();
 766             if (artifactList != null) {
 767                 Map<String, ArtifactDefinition> artifactsHM = new HashMap<>();
 768                 buildArtifactsHM(artifactList, artifactsHM);
 769                 resource.setArtifacts(artifactsHM);
 770             }
 771         }
 772     }
 773
 774     private void buildArtifactsHM(List<UploadArtifactInfo> artifactList, Map<String, ArtifactDefinition> artifactsHM) {
 775         for (UploadArtifactInfo artifact : artifactList) {
 776             ArtifactDefinition artifactDef = new ArtifactDefinition();
 777             artifactDef.setArtifactName(artifact.getArtifactName());
 778             artifactDef.setArtifactType(artifact.getArtifactType().getType());
 779             artifactDef.setDescription(artifact.getArtifactDescription());
 780             artifactDef.setPayloadData(artifact.getArtifactData());
 781             artifactDef.setArtifactRef(artifact.getArtifactPath());
 782             artifactsHM.put(artifactDef.getArtifactName(), artifactDef);
 783         }
 784     }
 785
 786     private Map<String, byte[]> getCsarFromPayload(UploadResourceInfo innerElement) {
 787         String csarUUID = innerElement.getPayloadName();
 788         String payloadData = innerElement.getPayloadData();
 789         return getComponentCsarFromPayload(csarUUID, payloadData);
 790     }
 791
 792     private Map<String, byte[]> getComponentCsarFromPayload(String csarUUID, String payloadData) {
 793         if (payloadData == null) {
 794             log.info("Failed to decode received csar {}", csarUUID);
 795             throw new ByActionStatusComponentException(ActionStatus.CSAR_NOT_FOUND, csarUUID);
 796         }
 797         byte[] decodedPayload = Base64.decodeBase64(payloadData.getBytes(StandardCharsets.UTF_8));
 798         if (decodedPayload == null) {
 799             log.info("Failed to decode received csar {}", csarUUID);
 800             throw new ByActionStatusComponentException(ActionStatus.CSAR_NOT_FOUND, csarUUID);
 801         }
 802         Map<String, byte[]> csar = null;
 803         try {
 804             csar = ZipUtils.readZip(decodedPayload, false);
 805         } catch (final ZipException e) {
 806             log.info("Failed to unzip received csar {}", csarUUID, e);
 807         }
 808         return csar;
 809     }
 810
 811     void validateInputStream(final HttpServletRequest request, Wrapper<String> dataWrapper, Wrapper<ResponseFormat> errorWrapper) throws IOException {
 812         InputStream inputStream = request.getInputStream();
 813         byte[] bytes = IOUtils.toByteArray(inputStream);
 814         if (bytes == null || bytes.length == 0) {
 815             log.info("Empty body was sent.");
 816             errorWrapper.setInnerElement(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
 817         } else {
 818             dataWrapper.setInnerElement(new String(bytes, StandardCharsets.UTF_8));
 819         }
 820     }
 821
 822     <T> void validateClassParse(String data, Wrapper<T> parsedClassWrapper, Supplier<Class<T>> classGen, Wrapper<ResponseFormat> errorWrapper) {
 823         try {
 824             T parsedClass = gson.fromJson(data, classGen.get());
 825             if (parsedClass == null) {
 826                 errorWrapper.setInnerElement(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
 827             } else {
 828                 parsedClassWrapper.setInnerElement(parsedClass);
 829             }
 830         } catch (JsonSyntaxException e) {
 831             log.debug("Failed to decode received {} {} to object.", classGen.get().getName(), data, e);
 832             errorWrapper.setInnerElement(getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT));
 833         }
 834     }
 835
 836     void validateComponentInstanceBusinessLogic(HttpServletRequest request, String containerComponentType,
 837                                                 Wrapper<ComponentInstanceBusinessLogic> blWrapper, Wrapper<ResponseFormat> errorWrapper) {
 838         ServletContext context = request.getSession().getServletContext();
 839         ComponentInstanceBusinessLogic componentInstanceLogic = getComponentInstanceBL(context);
 840         if (componentInstanceLogic == null) {
 841             log.debug("Unsupported component type {}", containerComponentType);
 842             errorWrapper.setInnerElement(getComponentsUtils().getResponseFormat(ActionStatus.UNSUPPORTED_ERROR, containerComponentType));
 843         } else {
 844             blWrapper.setInnerElement(componentInstanceLogic);
 845         }
 846     }
 847
 848     <T> Response buildResponseFromElement(Wrapper<ResponseFormat> errorWrapper, Wrapper<T> attributeWrapper) throws IOException {
 849         Response response;
 850         if (errorWrapper.isEmpty()) {
 851             ObjectMapper mapper = new ObjectMapper();
 852             String result = mapper.writeValueAsString(attributeWrapper.getInnerElement());
 853             response = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), result);
 854         } else {
 855             response = buildErrorResponse(errorWrapper.getInnerElement());
 856         }
 857         return response;
 858     }
 859
 860     protected void validateXECOMPInstanceIDHeader(String instanceIdHeader, Wrapper<ResponseFormat> responseWrapper) {
 861         ResponseFormat responseFormat;
 862         if (StringUtils.isEmpty(instanceIdHeader)) {
 863             log.debug("Missing X-ECOMP-InstanceID header");
 864             responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_X_ECOMP_INSTANCE_ID);
 865             responseWrapper.setInnerElement(responseFormat);
 866         }
 867     }
 868
 869     protected void validateHttpCspUserIdHeader(String header, Wrapper<ResponseFormat> responseWrapper) {
 870         ResponseFormat responseFormat;
 871         if (StringUtils.isEmpty(header)) {
 872             log.debug("MissingUSER_ID");
 873             responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.MISSING_USER_ID);
 874             responseWrapper.setInnerElement(responseFormat);
 875         }
 876     }
 877
 878     <T> Either<T, ResponseFormat> parseToObject(String json, Supplier<Class<T>> classSupplier) {
 879         try {
 880             T object = RepresentationUtils.fromRepresentation(json, classSupplier.get());
 881             return Either.left(object);
 882         } catch (Exception e) {
 883             log.debug("Failed to parse json to {} object", classSupplier.get().getName(), e);
 884             ResponseFormat responseFormat = componentsUtils.getResponseFormat(ActionStatus.INVALID_CONTENT);
 885             return Either.right(responseFormat);
 886         }
 887     }
 888
 889     public <T> Either<List<T>, ResponseFormat> parseListOfObjects(String json, Type type) {
 890         try {
 891             List<T> listOfObjects = gson.fromJson(json, type);
 892             return Either.left(listOfObjects);
 893         } catch (Exception e) {
 894             log.debug("Failed to parse json to {} object", type.getClass().getName(), e);
 895             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
 896             return Either.right(responseFormat);
 897         }
 898     }
 899
 900     protected void validateNotEmptyBody(String data) {
 901         if (StringUtils.isEmpty(data)) {
 902             throw new ByActionStatusComponentException(ActionStatus.MISSING_BODY);
 903         }
 904     }
 905
 906     protected void commonServiceGeneralValidations(Wrapper<Response> responseWrapper, Wrapper<User> userWrapper,
 907                                                    Wrapper<UploadServiceInfo> uploadServiceInfoWrapper, ServiceAuthorityTypeEnum serviceAuthorityEnum,
 908                                                    String userUserId, String serviceInfoJsonString) {
 909         if (responseWrapper.isEmpty()) {
 910             validateUserExist(responseWrapper, userWrapper, userUserId);
 911         }
 912         if (responseWrapper.isEmpty()) {
 913             validateUserRole(responseWrapper, userWrapper.getInnerElement(), serviceAuthorityEnum);
 914         }
 915         if (responseWrapper.isEmpty()) {
 916             validateAndFillServiceJson(responseWrapper, uploadServiceInfoWrapper, userWrapper.getInnerElement(), serviceAuthorityEnum,
 917                 serviceInfoJsonString);
 918         }
 919         if (responseWrapper.isEmpty()) {
 920             validateToscaTemplatePayloadName(responseWrapper, uploadServiceInfoWrapper.getInnerElement(), userWrapper.getInnerElement());
 921         }
 922     }
 923
 924     protected void validateUserRole(Wrapper<Response> errorResponseWrapper, User user, ServiceAuthorityTypeEnum serviceAuthority) {
 925         log.debug("validate user role");
 926         if (serviceAuthority == ServiceAuthorityTypeEnum.NORMATIVE_TYPE_BE) {
 927             if (!user.getRole().equals(Role.ADMIN.name())) {
 928                 log.info("user is not in appropriate role to perform action");
 929                 ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.RESTRICTED_OPERATION);
 930                 log.debug("audit before sending response");
 931                 Response response = buildErrorResponse(responseFormat);
 932                 errorResponseWrapper.setInnerElement(response);
 933             }
 934         } else {
 935             validateUserRole(errorResponseWrapper, user);
 936         }
 937     }
 938
 939     protected void validateAndFillServiceJson(Wrapper<Response> responseWrapper, Wrapper<UploadServiceInfo> uploadServiceInfoWrapper, User user,
 940                                               ServiceAuthorityTypeEnum serviceAuthorityEnum, String serviceInfo) {
 941         boolean isValid;
 942         try {
 943             log.debug("The received json is {}", serviceInfo);
 944             UploadServiceInfo serviceInfoObject = gson.fromJson(serviceInfo, UploadServiceInfo.class);
 945             if (serviceInfoObject == null) {
 946                 isValid = false;
 947             } else {
 948                 if (!serviceAuthorityEnum.isBackEndImport()) {
 949                     isValid = serviceInfoObject.getPayloadName() != null && !serviceInfoObject.getPayloadName().isEmpty();
 950                     //only service name is checked
 951                 } else {
 952                     isValid = true;
 953                 }
 954                 uploadServiceInfoWrapper.setInnerElement(serviceInfoObject);
 955                 log.debug("get isValid:{},serviceInfoObject get name:{},get tags:{},getContactId:{}," + " getPayloadName:{}", isValid,
 956                     uploadServiceInfoWrapper.getInnerElement().getName(), uploadServiceInfoWrapper.getInnerElement().getTags(),
 957                     uploadServiceInfoWrapper.getInnerElement().getContactId(), uploadServiceInfoWrapper.getInnerElement().getPayloadName());
 958             }
 959         } catch (JsonSyntaxException e) {
 960             log.debug("enter validateAndFillServiceJson,Invalid json was received. {}", e.getMessage(), e);
 961             isValid = false;
 962         }
 963         if (!isValid) {
 964             log.info("Invalid json was received.");
 965             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
 966             Response errorResp = buildErrorResponse(responseFormat);
 967             responseWrapper.setInnerElement(errorResp);
 968         }
 969     }
 970
 971     protected void validateToscaTemplatePayloadName(Wrapper<Response> responseWrapper, UploadServiceInfo uploadServiceInfo, User user) {
 972         String toscaTemplatePayloadName = uploadServiceInfo.getPayloadName();
 973         boolean isValidSuffix = isToscaTemplatePayloadNameValid(responseWrapper, toscaTemplatePayloadName);
 974         if (!isValidSuffix) {
 975             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_TOSCA_FILE_EXTENSION);
 976             Response errorResponse = buildErrorResponse(responseFormat);
 977             responseWrapper.setInnerElement(errorResponse);
 978         }
 979     }
 980
 981     protected void specificServiceAuthorityValidations(Wrapper<Response> responseWrapper, Wrapper<UploadServiceInfo> uploadServiceInfoWrapper,
 982                                                        Wrapper<String> yamlStringWrapper, User user, HttpServletRequest request,
 983                                                        String serviceInfoJsonString, ServiceAuthorityTypeEnum serviceAuthorityEnum)
 984         throws FileNotFoundException {
 985         if (responseWrapper.isEmpty()) {
 986             // UI Only Validation
 987             if (!serviceAuthorityEnum.isBackEndImport()) {
 988                 importUIValidations(responseWrapper, uploadServiceInfoWrapper.getInnerElement(), user, request, serviceInfoJsonString);
 989             }
 990             // User Defined Type Services
 991             if (serviceAuthorityEnum.isUserTypeService() && !CsarValidationUtils
 992                 .isCsarPayloadName(uploadServiceInfoWrapper.getInnerElement().getPayloadName())) {
 993                 if (responseWrapper.isEmpty()) {
 994                     validatePayloadNameSpace(responseWrapper, uploadServiceInfoWrapper.getInnerElement(), user, yamlStringWrapper.getInnerElement());
 995                 }
 996             }
 997         }
 998     }
 999
1000     protected void importUIValidations(Wrapper<Response> responseWrapper, UploadServiceInfo serviceInfo, User user, HttpServletRequest request,
1001                                        String serviceInfoJsonString) {
1002         if (responseWrapper.isEmpty()) {
1003             validateMD5(responseWrapper, user, serviceInfo, request, serviceInfoJsonString);
1004         }
1005         if (responseWrapper.isEmpty() && request != null && request.getMethod() != null && request.getMethod().equals("POST")) {
1006             validateServiceDoesNotExist(responseWrapper, user, serviceInfo.getName());
1007         }
1008     }
1009
1010     protected void validatePayloadNameSpace(Wrapper<Response> responseWrapper, UploadServiceInfo serviceInfo, User user, String toscaPayload) {
1011         boolean isValid;
1012         String nameSpace = "";
1013         Map<String, Object> mappedToscaTemplate = (Map<String, Object>) new Yaml().load(toscaPayload);
1014         Either<Map<String, Object>, ResultStatusEnum> toscaElement = ImportUtils
1015             .findFirstToscaMapElement(mappedToscaTemplate, TypeUtils.ToscaTagNamesEnum.NODE_TYPES);
1016         if (toscaElement.isRight() || toscaElement.left().value().size() != 1) {
1017             isValid = false;
1018         } else {
1019             nameSpace = toscaElement.left().value().keySet().iterator().next();
1020             isValid = nameSpace.startsWith(Constants.USER_DEFINED_SERVICE_NAMESPACE_PREFIX);
1021             log.debug("enter validatePayloadNameSpace,get nameSpace:{},get Valid is:{}", nameSpace, isValid);
1022         }
1023         if (!isValid) {
1024             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_SERVICE_NAMESPACE);
1025             Response errorResponse = buildErrorResponse(responseFormat);
1026             responseWrapper.setInnerElement(errorResponse);
1027         } else {
1028             String str1 = nameSpace.substring(Constants.USER_DEFINED_SERVICE_NAMESPACE_PREFIX.length());
1029             String[] findTypes = str1.split("\\.");
1030             if (ResourceTypeEnum.containsName(findTypes[0].toUpperCase())) {
1031                 String type = findTypes[0].toUpperCase();
1032                 serviceInfo.setServiceType(type);
1033             } else {
1034                 serviceInfo.setServiceType(ResourceTypeEnum.SERVICE.name());
1035             }
1036         }
1037     }
1038
1039     protected void validateMD5(Wrapper<Response> responseWrapper, User user, UploadServiceInfo serviceInfo, HttpServletRequest request,
1040                                String serviceInfoJsonString) {
1041         boolean isValid;
1042         String recievedMD5 = request.getHeader(Constants.MD5_HEADER);
1043         if (recievedMD5 == null) {
1044             isValid = false;
1045         } else {
1046             String calculateMD5 = GeneralUtility.calculateMD5Base64EncodedByString(serviceInfoJsonString);
1047             isValid = calculateMD5.equals(recievedMD5);
1048         }
1049         if (!isValid) {
1050             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_SERVICE_CHECKSUM);
1051             Response errorResponse = buildErrorResponse(responseFormat);
1052             responseWrapper.setInnerElement(errorResponse);
1053         }
1054     }
1055
1056     protected void validateServiceDoesNotExist(Wrapper<Response> responseWrapper, User user, String serviceName) {
1057         if (serviceImportManager.isServiceExist(serviceName)) {
1058             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.SERVICE_ALREADY_EXISTS);
1059             Response errorResponse = buildErrorResponse(responseFormat);
1060             responseWrapper.setInnerElement(errorResponse);
1061         }
1062     }
1063
1064     protected void handleImportService(Wrapper<Response> responseWrapper, User user, UploadServiceInfo serviceInfoObject, String yamlAsString,
1065                                        ServiceAuthorityTypeEnum authority, boolean createNewVersion, String serviceUniqueId) throws ZipException {
1066         Response response = null;
1067         Object representation = null;
1068         ImmutablePair<Service, ActionStatus> importedServiceStatus = null;
1069         if (CsarValidationUtils.isCsarPayloadName(serviceInfoObject.getPayloadName())) {
1070             log.debug("import service from csar");
1071             importedServiceStatus = importServiceFromUICsar(serviceInfoObject, user, serviceUniqueId);
1072         }
1073         if (importedServiceStatus != null) {
1074             try {
1075                 representation = RepresentationUtils.toRepresentation(importedServiceStatus.left);
1076             } catch (IOException e) {
1077                 log.debug("Error while building service representation : {}", e.getMessage(), e);
1078             }
1079             response = buildOkResponse(getComponentsUtils().getResponseFormat(importedServiceStatus.right), representation);
1080         }
1081         responseWrapper.setInnerElement(response);
1082     }
1083
1084     private ImmutablePair<Service, ActionStatus> importServiceFromUICsar(UploadServiceInfo serviceInfoObject, User user, String serviceUniqueId)
1085         throws ZipException {
1086         Service newService;
1087         ImmutablePair<Service, ActionStatus> result = null;
1088         ActionStatus actionStatus;
1089         Service service = new Service();
1090         String payloadName = serviceInfoObject.getPayloadName();
1091         fillServiceFromServiceInfoObject(service, serviceInfoObject);
1092         Map<String, byte[]> csarUIPayloadRes = getCsarFromPayload(serviceInfoObject);
1093         getAndValidateCsarYaml(csarUIPayloadRes, service, user, payloadName);
1094         newService = serviceImportManager.getServiceImportBusinessLogic()
1095             .createService(service, AuditingActionEnum.CREATE_SERVICE, user, csarUIPayloadRes, payloadName);
1096         actionStatus = ActionStatus.CREATED;
1097         return new ImmutablePair<>(newService, actionStatus);
1098     }
1099
1100     private void fillServiceFromServiceInfoObject(Service service, UploadServiceInfo serviceInfoObject) {
1101         serviceImportManager.populateServiceMetadata(serviceInfoObject, service);
1102         fillArtifacts(service, serviceInfoObject);
1103     }
1104
1105     private Map<String, byte[]> getCsarFromPayload(UploadServiceInfo innerElement) throws ZipException {
1106         String csarUUID = innerElement.getPayloadName();
1107         String payloadData = innerElement.getPayloadData();
1108         return getComponentCsarFromPayload(csarUUID, payloadData);
1109     }
1110
1111     private void getAndValidateCsarYaml(Map<String, byte[]> csarUIPayload, Service service, User user, String csarUUID) {
1112         getAndValidateComponentCsarYaml(csarUIPayload, service, user, csarUUID);
1113     }
1114
1115     private void fillArtifacts(Service service, UploadServiceInfo serviceInfoObject) {
1116         if (service != null && serviceInfoObject != null) {
1117             List<UploadArtifactInfo> artifactList = serviceInfoObject.getArtifactList();
1118             if (artifactList != null) {
1119                 Map<String, ArtifactDefinition> artifactsHM = new HashMap<>();
1120                 buildArtifactsHM(artifactList, artifactsHM);
1121                 service.setArtifacts(artifactsHM);
1122             }
1123         }
1124     }
1125
1126     /**
1127      * import service payload to postman
1128      *
1129      * @param responseWrapper
1130      * @param uploadServiceInfoWrapper
1131      * @param yamlStringWrapper
1132      * @param user
1133      * @param serviceInfoJsonString
1134      * @param serviceAuthorityEnum
1135      * @param file
1136      * @throws ZipException
1137      */
1138     protected void fillServicePayload(Wrapper<Response> responseWrapper, Wrapper<UploadServiceInfo> uploadServiceInfoWrapper,
1139                                       Wrapper<String> yamlStringWrapper, User user, String serviceInfoJsonString,
1140                                       ServiceAuthorityTypeEnum serviceAuthorityEnum, File file) throws ZipException {
1141         log.debug("enter fillServicePayload");
1142         if (responseWrapper.isEmpty()) {
1143             log.debug("enter fillServicePayload,get responseWrapper is empty");
1144             if (serviceAuthorityEnum.isBackEndImport()) {
1145                 // PrePayload Validations
1146                 if (responseWrapper.isEmpty()) {
1147                     validateDataNotNull(responseWrapper, file, serviceInfoJsonString);
1148                 }
1149                 if (responseWrapper.isEmpty()) {
1150                     log.debug("enter fillServicePayload,responseWrapper is empty");
1151                 }
1152                 if (!serviceAuthorityEnum.equals(ServiceAuthorityTypeEnum.CSAR_TYPE_BE)) {
1153                     if (responseWrapper.isEmpty()) {
1154                         validateZip(responseWrapper, file, uploadServiceInfoWrapper.getInnerElement().getPayloadName());
1155                     }
1156                     // Fill PayLoad From File
1157                     if (responseWrapper.isEmpty()) {
1158                         fillToscaTemplateFromZip(yamlStringWrapper, uploadServiceInfoWrapper.getInnerElement().getPayloadName(), file);
1159                     }
1160                 } else {
1161                     log.debug("enter fillServicePayload,ServiceAuthorityTypeEnum is CSAR_TYPE_BE");
1162                     if (responseWrapper.isEmpty()) {
1163                         validateCsar(responseWrapper, file, uploadServiceInfoWrapper.getInnerElement().getPayloadName());
1164                     }
1165                     if (!responseWrapper.isEmpty()) {
1166                         log.debug("enter fillServicePayload,get responseWrapper:{}", responseWrapper);
1167                     }
1168                     // Fill PayLoad From File
1169                     if (responseWrapper.isEmpty()) {
1170                         fillServicePayloadDataFromFile(responseWrapper, uploadServiceInfoWrapper.getInnerElement(), file);
1171                     }
1172                 }
1173             } else {
1174                 // Fill PayLoad From JSON
1175                 if (responseWrapper.isEmpty()) {
1176                     fillServiceToscaTemplateFromJson(responseWrapper, yamlStringWrapper, user, uploadServiceInfoWrapper.getInnerElement());
1177                 }
1178             }
1179         }
1180     }
1181
1182     protected void fillServicePayloadDataFromFile(Wrapper<Response> responseWrapper, UploadServiceInfo uploadServiceInfoWrapper, File file) {
1183         try (InputStream fileInputStream = new FileInputStream(file)) {
1184             log.debug("enter fillServicePayloadDataFromFile");
1185             byte[] data = new byte[(int) file.length()];
1186             if (fileInputStream.read(data) == -1) {
1187                 log.info("Invalid json was received.");
1188                 ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
1189                 Response errorResp = buildErrorResponse(responseFormat);
1190                 responseWrapper.setInnerElement(errorResp);
1191             }
1192             String payloadData = Base64.encodeBase64String(data);
1193             uploadServiceInfoWrapper.setPayloadData(payloadData);
1194             log.debug("enter fillServicePayloadDataFromFile,get payloadData:{}", uploadServiceInfoWrapper.getPayloadData());
1195             log.debug("enter fillServicePayloadDataFromFile,get uploadService:{}", uploadServiceInfoWrapper);
1196         } catch (IOException e) {
1197             log.info("Invalid json was received or Error while closing input Stream.");
1198             log.debug("Invalid json was received or Error while closing input Stream. {}", e.getMessage(), e);
1199             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_CONTENT);
1200             Response errorResp = buildErrorResponse(responseFormat);
1201             responseWrapper.setInnerElement(errorResp);
1202         }
1203     }
1204
1205     private void fillServiceToscaTemplateFromJson(Wrapper<Response> responseWrapper, Wrapper<String> yamlStringWrapper, User user,
1206                                                   UploadServiceInfo serviceInfo) {
1207         if (serviceInfo.getPayloadData() == null || serviceInfo.getPayloadData().isEmpty()) {
1208             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.INVALID_RESOURCE_PAYLOAD);
1209             Response errorResponse = buildErrorResponse(responseFormat);
1210             getComponentsUtils().auditResource(responseFormat, user, serviceInfo.getName(), AuditingActionEnum.IMPORT_RESOURCE);
1211             responseWrapper.setInnerElement(errorResponse);
1212         } else {
1213             String toscaPayload = serviceInfo.getPayloadData();
1214             String decodedPayload = new String(Base64.decodeBase64(toscaPayload));
1215             yamlStringWrapper.setInnerElement(decodedPayload);
1216         }
1217     }
1218 }