catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesUploadServlet.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.sdc.be.servlets;
  22
  23 import com.google.gson.reflect.TypeToken;
  24 import com.jcabi.aspects.Loggable;
  25 import fj.data.Either;
  26 import io.swagger.annotations.*;
  27 import org.apache.commons.lang3.tuple.ImmutablePair;
  28 import org.glassfish.jersey.media.multipart.FormDataParam;
  29 import org.openecomp.sdc.be.components.impl.*;
  30 import org.openecomp.sdc.be.components.impl.model.ToscaTypeImportData;
  31 import org.openecomp.sdc.be.config.BeEcompErrorManager;
  32 import org.openecomp.sdc.be.dao.api.ActionStatus;
  33 import org.openecomp.sdc.be.datatypes.enums.NodeTypeEnum;
  34 import org.openecomp.sdc.be.model.DataTypeDefinition;
  35 import org.openecomp.sdc.be.model.GroupTypeDefinition;
  36 import org.openecomp.sdc.be.model.PolicyTypeDefinition;
  37 import org.openecomp.sdc.be.model.User;
  38 import org.openecomp.sdc.be.model.normatives.ToscaTypeMetadata;
  39 import org.openecomp.sdc.common.api.Constants;
  40 import org.openecomp.sdc.common.datastructure.FunctionalInterfaces.ConsumerTwoParam;
  41 import org.openecomp.sdc.common.datastructure.Wrapper;
  42 import org.openecomp.sdc.common.log.wrappers.Logger;
  43 import org.openecomp.sdc.exception.ResponseFormat;
  44 import org.springframework.stereotype.Controller;
  45
  46 import javax.servlet.http.HttpServletRequest;
  47 import javax.ws.rs.*;
  48 import javax.ws.rs.core.Context;
  49 import javax.ws.rs.core.MediaType;
  50 import javax.ws.rs.core.Response;
  51 import java.io.File;
  52 import java.io.IOException;
  53 import java.util.List;
  54 import java.util.Map;
  55 import java.util.Set;
  56 import java.util.function.Supplier;
  57 import java.util.stream.Collectors;
  58
  59 @Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
  60 @Path("/v1/catalog/uploadType")
  61 @Consumes(MediaType.MULTIPART_FORM_DATA)
  62 @Produces(MediaType.APPLICATION_JSON)
  63 @Api(value = "Catalog Types Upload")
  64 @Controller
  65 public class TypesUploadServlet extends AbstractValidationsServlet {
  66     private static final Logger log = Logger.getLogger(TypesUploadServlet.class);
  67     public static final String CREATE = "Create ";
  68
  69     private final CapabilityTypeImportManager capabilityTypeImportManager;
  70     private final InterfaceLifecycleTypeImportManager interfaceLifecycleTypeImportManager;
  71     private final CategoriesImportManager categoriesImportManager;
  72     private final DataTypeImportManager dataTypeImportManager;
  73     private final GroupTypeImportManager groupTypeImportManager;
  74     private final PolicyTypeImportManager policyTypeImportManager;
  75
  76     public TypesUploadServlet(CapabilityTypeImportManager capabilityTypeImportManager, InterfaceLifecycleTypeImportManager interfaceLifecycleTypeImportManager, CategoriesImportManager categoriesImportManager, DataTypeImportManager dataTypeImportManager,
  77                               GroupTypeImportManager groupTypeImportManager, PolicyTypeImportManager policyTypeImportManager) {
  78         this.capabilityTypeImportManager = capabilityTypeImportManager;
  79         this.interfaceLifecycleTypeImportManager = interfaceLifecycleTypeImportManager;
  80         this.categoriesImportManager = categoriesImportManager;
  81         this.dataTypeImportManager = dataTypeImportManager;
  82         this.groupTypeImportManager = groupTypeImportManager;
  83         this.policyTypeImportManager = policyTypeImportManager;
  84     }
  85
  86     @POST
  87     @Path("/capability")
  88     @ApiOperation(value = "Create Capability Type from yaml", httpMethod = "POST", notes = "Returns created Capability Type", response = Response.class)
  89     @ApiResponses(value = { @ApiResponse(code = 201, message = "Capability Type created"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content"),
  90     @ApiResponse(code = 409, message = "Capability Type already exist") })
  91     public Response uploadCapabilityType(@ApiParam("FileInputStream") @FormDataParam("capabilityTypeZip") File file, @Context final HttpServletRequest request, @HeaderParam("USER_ID") String creator) {
  92         ConsumerTwoParam<Wrapper<Response>, String> createElementsMethod = (responseWrapper, ymlPayload) -> createElementsType(responseWrapper, () -> capabilityTypeImportManager.createCapabilityTypes(ymlPayload));
  93         return uploadElementTypeServletLogic(createElementsMethod, file, request, creator, NodeTypeEnum.CapabilityType.name());
  94     }
  95
  96     @POST
  97     @Path("/interfaceLifecycle")
  98     @ApiOperation(value = "Create Interface Lyfecycle Type from yaml", httpMethod = "POST", notes = "Returns created Interface Lifecycle Type", response = Response.class)
  99     @ApiResponses(value = { @ApiResponse(code = 201, message = "Interface Lifecycle Type created"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content"),
 100     @ApiResponse(code = 409, message = "Interface Lifecycle Type already exist") })
 101     public Response uploadInterfaceLifecycleType(@ApiParam("FileInputStream") @FormDataParam("interfaceLifecycleTypeZip") File file, @Context final HttpServletRequest request, @HeaderParam("USER_ID") String creator) {
 102         ConsumerTwoParam<Wrapper<Response>, String> createElementsMethod = (responseWrapper, ymlPayload) -> createElementsType(responseWrapper, () -> interfaceLifecycleTypeImportManager.createLifecycleTypes(ymlPayload));
 103         return uploadElementTypeServletLogic(createElementsMethod, file, request, creator, "Interface Types");
 104     }
 105
 106     @POST
 107     @Path("/categories")
 108     @ApiOperation(value = "Create Categories from yaml", httpMethod = "POST", notes = "Returns created categories", response = Response.class)
 109     @ApiResponses(value = { @ApiResponse(code = 201, message = "Categories created"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content"),
 110     @ApiResponse(code = 409, message = "Category already exist") })
 111     public Response uploadCategories(@ApiParam("FileInputStream") @FormDataParam("categoriesZip") File file, @Context final HttpServletRequest request, @HeaderParam("USER_ID") String creator) {
 112         ConsumerTwoParam<Wrapper<Response>, String> createElementsMethod = (responseWrapper, ymlPayload) -> createElementsType(responseWrapper, () -> categoriesImportManager.createCategories(ymlPayload));
 113         return uploadElementTypeServletLogic(createElementsMethod, file, request, creator, "categories");
 114     }
 115
 116     @POST
 117     @Path("/datatypes")
 118     @ApiOperation(value = "Create Categories from yaml", httpMethod = "POST", notes = "Returns created data types", response = Response.class)
 119     @ApiResponses(value = { @ApiResponse(code = 201, message = "Data types created"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content"),
 120     @ApiResponse(code = 409, message = "Data types already exist") })
 121     public Response uploadDataTypes(@ApiParam("FileInputStream") @FormDataParam("dataTypesZip") File file, @Context final HttpServletRequest request, @HeaderParam("USER_ID") String creator) {
 122         ConsumerTwoParam<Wrapper<Response>, String> createElementsMethod = this::createDataTypes;
 123         return uploadElementTypeServletLogic(createElementsMethod, file, request, creator, NodeTypeEnum.DataType.getName());
 124     }
 125
 126     @POST
 127     @Path("/grouptypes")
 128     @ApiOperation(value = "Create GroupTypes from yaml", httpMethod = "POST", notes = "Returns created group types", response = Response.class)
 129     @ApiResponses(value = { @ApiResponse(code = 201, message = "group types created"), @ApiResponse(code = 403, message = "Restricted operation"), @ApiResponse(code = 400, message = "Invalid content / Missing content"),
 130     @ApiResponse(code = 409, message = "group types already exist") })
 131     public Response uploadGroupTypes(@ApiParam("toscaTypeMetadata") @FormDataParam("toscaTypeMetadata") String toscaTypesMetaData,
 132                                      @ApiParam("FileInputStream") @FormDataParam("groupTypesZip") File file,
 133                                      @Context final HttpServletRequest request,
 134                                      @HeaderParam("USER_ID") String creator) {
 135         Map<String, ToscaTypeMetadata> typesMetadata = getTypesMetadata(toscaTypesMetaData);
 136         return uploadTypesWithMetaData(this::createGroupTypes, typesMetadata, file, request, creator, NodeTypeEnum.GroupType.getName());
 137     }
 138
 139     @POST
 140     @Path("/policytypes")
 141     @ApiOperation(value = "Create PolicyTypes from yaml", httpMethod = "POST", notes = "Returns created policy types", response = Response.class)
 142     @ApiResponses(value = { @ApiResponse(code = 201, message = "policy types created"),
 143                             @ApiResponse(code = 403, message = "Restricted operation"),
 144                             @ApiResponse(code = 400, message = "Invalid content / Missing content"),
 145     @ApiResponse(code = 409, message = "policy types already exist") })
 146     public Response uploadPolicyTypes(
 147             @ApiParam("toscaTypeMetadata") @FormDataParam("toscaTypeMetadata") String toscaTypesMetaData,
 148             @ApiParam("FileInputStream") @FormDataParam("policyTypesZip") File file,
 149             @Context final HttpServletRequest request, @HeaderParam("USER_ID") String creator) {
 150         Map<String, ToscaTypeMetadata> typesMetadata = getTypesMetadata(toscaTypesMetaData);
 151         return uploadTypesWithMetaData(this::createPolicyTypes, typesMetadata, file, request, creator, NodeTypeEnum.PolicyType.getName());
 152     }
 153
 154     private Map<String, ToscaTypeMetadata> getTypesMetadata(String toscaTypesMetaData) {
 155         return gson.fromJson(toscaTypesMetaData, new TypeToken<Map<String, ToscaTypeMetadata>>(){}.getType());
 156     }
 157
 158     private Response uploadElementTypeServletLogic(ConsumerTwoParam<Wrapper<Response>, String> createElementsMethod, File file, final HttpServletRequest request, String creator, String elementTypeName) {
 159         init();
 160         String userId = initHeaderParam(creator, request, Constants.USER_ID_HEADER);
 161         try {
 162             Wrapper<String> yamlStringWrapper = new Wrapper<>();
 163
 164             String url = request.getMethod() + " " + request.getRequestURI();
 165             log.debug("Start handle request of {}", url);
 166             Wrapper<Response> responseWrapper = doUploadTypeValidations(request, userId, file);
 167             if (responseWrapper.isEmpty()) {
 168                 fillZipContents(yamlStringWrapper, file);
 169             }
 170             if (responseWrapper.isEmpty()) {
 171                 createElementsMethod.accept(responseWrapper, yamlStringWrapper.getInnerElement());
 172             }
 173             return responseWrapper.getInnerElement();
 174         } catch (Exception e) {
 175             log.debug("create {} failed with exception:", elementTypeName, e);
 176             BeEcompErrorManager.getInstance().logBeRestApiGeneralError(CREATE + elementTypeName);
 177             return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
 178         }
 179     }
 180
 181     private Wrapper<Response> doUploadTypeValidations(final HttpServletRequest request, String userId, File file) {
 182         Wrapper<Response> responseWrapper = new Wrapper<>();
 183         Wrapper<User> userWrapper = new Wrapper<>();
 184
 185         String url = request.getMethod() + " " + request.getRequestURI();
 186         log.debug("Start handle request of {}", url);
 187
 188         validateUserExist(responseWrapper, userWrapper, userId);
 189
 190         if (responseWrapper.isEmpty()) {
 191             validateUserRole(responseWrapper, userWrapper.getInnerElement());
 192         }
 193
 194         if (responseWrapper.isEmpty()) {
 195             validateDataNotNull(responseWrapper, file);
 196         }
 197         return responseWrapper;
 198     }
 199
 200     private Response uploadTypesWithMetaData(ConsumerTwoParam<Wrapper<Response>, ToscaTypeImportData> createElementsMethod, Map<String, ToscaTypeMetadata> typesMetaData, File file, final HttpServletRequest request, String creator, String elementTypeName) {
 201         init();
 202         String userId = initHeaderParam(creator, request, Constants.USER_ID_HEADER);
 203         Wrapper<String> yamlStringWrapper = new Wrapper<>();
 204         try {
 205             Wrapper<Response> responseWrapper = doUploadTypeValidations(request, userId, file);
 206             if (responseWrapper.isEmpty()) {
 207                 fillZipContents(yamlStringWrapper, file);
 208             }
 209             if (responseWrapper.isEmpty()) {
 210                 ToscaTypeImportData toscaTypeImportData = new ToscaTypeImportData(yamlStringWrapper.getInnerElement(), typesMetaData);
 211                 createElementsMethod.accept(responseWrapper, toscaTypeImportData);
 212             }
 213             return responseWrapper.getInnerElement();
 214         } catch (Exception e) {
 215             log.debug("create {} failed with exception:", elementTypeName, e);
 216             BeEcompErrorManager.getInstance().logBeRestApiGeneralError(CREATE + elementTypeName);
 217             return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
 218         }
 219     }
 220
 221     private <T> void createElementsType(Wrapper<Response> responseWrapper, Supplier<Either<T, ResponseFormat>> elementsCreater) {
 222         Either<T, ResponseFormat> eitherResult = elementsCreater.get();
 223         if (eitherResult.isRight()) {
 224             Response response = buildErrorResponse(eitherResult.right().value());
 225             responseWrapper.setInnerElement(response);
 226         } else {
 227             try {
 228                 Response response = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.CREATED), RepresentationUtils.toRepresentation(eitherResult.left().value()));
 229                 responseWrapper.setInnerElement(response);
 230             } catch (Exception e) {
 231                 Response response = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
 232                 responseWrapper.setInnerElement(response);
 233                 log.error("#createElementsType - json serialization failed with error: ", e);
 234             }
 235         }
 236     }
 237
 238     // data types
 239     private void createDataTypes(Wrapper<Response> responseWrapper, String dataTypesYml) {
 240         final Supplier<Either<List<ImmutablePair<DataTypeDefinition, Boolean>>, ResponseFormat>> generateElementTypeFromYml = () -> dataTypeImportManager.createDataTypes(dataTypesYml);
 241         buildStatusForElementTypeCreate(responseWrapper, generateElementTypeFromYml, ActionStatus.DATA_TYPE_ALREADY_EXIST, NodeTypeEnum.DataType.name());
 242     }
 243
 244     // group types
 245     private void createGroupTypes(Wrapper<Response> responseWrapper, ToscaTypeImportData toscaTypeImportData) {
 246         final Supplier<Either<List<ImmutablePair<GroupTypeDefinition, Boolean>>, ResponseFormat>> generateElementTypeFromYml = () -> groupTypeImportManager.createGroupTypes(toscaTypeImportData);
 247         buildStatusForElementTypeCreate(responseWrapper, generateElementTypeFromYml, ActionStatus.GROUP_TYPE_ALREADY_EXIST, NodeTypeEnum.GroupType.name());
 248     }
 249
 250     // policy types
 251     private void createPolicyTypes(Wrapper<Response> responseWrapper, ToscaTypeImportData toscaTypeImportData) {
 252         final Supplier<Either<List<ImmutablePair<PolicyTypeDefinition, Boolean>>, ResponseFormat>> generateElementTypeFromYml = () -> policyTypeImportManager.createPolicyTypes(toscaTypeImportData);
 253         buildStatusForElementTypeCreate(responseWrapper, generateElementTypeFromYml, ActionStatus.POLICY_TYPE_ALREADY_EXIST, NodeTypeEnum.PolicyType.name());
 254     }
 255
 256     // data types
 257     private <ElementTypeDefinition> void buildStatusForElementTypeCreate(Wrapper<Response> responseWrapper, Supplier<Either<List<ImmutablePair<ElementTypeDefinition, Boolean>>, ResponseFormat>> generateElementTypeFromYml, ActionStatus alreadyExistStatus, String elementTypeName) {
 258         Either<List<ImmutablePair<ElementTypeDefinition, Boolean>>, ResponseFormat> eitherResult = generateElementTypeFromYml.get();
 259
 260         if (eitherResult.isRight()) {
 261             Response response = buildErrorResponse(eitherResult.right().value());
 262             responseWrapper.setInnerElement(response);
 263         } else {
 264             Object representation;
 265             try {
 266                 List<ImmutablePair<ElementTypeDefinition, Boolean>> list = eitherResult.left().value();
 267                 ActionStatus status = ActionStatus.OK;
 268                 if (list != null) {
 269
 270                     // Group result by the right value - true or false.
 271                     // I.e., get the number of data types which are new and
 272                     // which are old.
 273                     Map<Boolean, List<ImmutablePair<ElementTypeDefinition, Boolean>>> collect = list.stream().collect(Collectors.groupingBy(ImmutablePair<ElementTypeDefinition, Boolean>::getRight));
 274                     if (collect != null) {
 275                         Set<Boolean> keySet = collect.keySet();
 276                         if (keySet.size() == 1) {
 277                             Boolean isNew = keySet.iterator().next();
 278                             if (isNew.booleanValue()) {
 279                                 // all data types created at the first time
 280                                 status = ActionStatus.CREATED;
 281                             } else {
 282                                 // All data types already exists
 283
 284                                 status = alreadyExistStatus;
 285                             }
 286                         }
 287                     }
 288                 }
 289                 representation = RepresentationUtils.toRepresentation(eitherResult.left().value());
 290
 291                 Response response = buildOkResponse(getComponentsUtils().getResponseFormat(status), representation);
 292                 responseWrapper.setInnerElement(response);
 293
 294             } catch (IOException e) {
 295                 BeEcompErrorManager.getInstance().logBeRestApiGeneralError(CREATE + elementTypeName);
 296                 log.debug("failed to convert {} to json", elementTypeName, e);
 297                 Response response = buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR));
 298                 responseWrapper.setInnerElement(response);
 299             }
 300         }
 301     }
 302
 303
 304 }