catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesFetchServlet.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 package org.openecomp.sdc.be.servlets;
  21
  22 import com.jcabi.aspects.Loggable;
  23 import fj.data.Either;
  24 import io.swagger.v3.oas.annotations.Operation;
  25 import io.swagger.v3.oas.annotations.Parameter;
  26 import io.swagger.v3.oas.annotations.media.ArraySchema;
  27 import io.swagger.v3.oas.annotations.media.Content;
  28 import io.swagger.v3.oas.annotations.media.Schema;
  29 import io.swagger.v3.oas.annotations.responses.ApiResponse;
  30 import io.swagger.v3.oas.annotations.servers.Server;
  31 import io.swagger.v3.oas.annotations.servers.Servers;
  32 import io.swagger.v3.oas.annotations.tags.Tag;
  33 import io.swagger.v3.oas.annotations.tags.Tags;
  34 import java.util.HashMap;
  35 import java.util.List;
  36 import java.util.Map;
  37 import java.util.stream.Collectors;
  38 import javax.inject.Inject;
  39 import javax.servlet.ServletContext;
  40 import javax.servlet.http.HttpServletRequest;
  41 import javax.ws.rs.Consumes;
  42 import javax.ws.rs.GET;
  43 import javax.ws.rs.HeaderParam;
  44 import javax.ws.rs.Path;
  45 import javax.ws.rs.Produces;
  46 import javax.ws.rs.QueryParam;
  47 import javax.ws.rs.core.Context;
  48 import javax.ws.rs.core.MediaType;
  49 import javax.ws.rs.core.Response;
  50 import org.apache.commons.collections4.ListUtils;
  51 import org.glassfish.jersey.media.multipart.FormDataParam;
  52 import org.openecomp.sdc.be.components.impl.CapabilitiesBusinessLogic;
  53 import org.openecomp.sdc.be.components.impl.ComponentBusinessLogic;
  54 import org.openecomp.sdc.be.components.impl.ComponentInstanceBusinessLogic;
  55 import org.openecomp.sdc.be.components.impl.InterfaceOperationBusinessLogic;
  56 import org.openecomp.sdc.be.components.impl.PropertyBusinessLogic;
  57 import org.openecomp.sdc.be.components.impl.RelationshipTypeBusinessLogic;
  58 import org.openecomp.sdc.be.components.impl.ResourceBusinessLogic;
  59 import org.openecomp.sdc.be.components.impl.ResourceImportManager;
  60 import org.openecomp.sdc.be.components.impl.aaf.AafPermission;
  61 import org.openecomp.sdc.be.components.impl.aaf.PermissionAllowed;
  62 import org.openecomp.sdc.be.config.BeEcompErrorManager;
  63 import org.openecomp.sdc.be.dao.api.ActionStatus;
  64 import org.openecomp.sdc.be.datamodel.api.HighestFilterEnum;
  65 import org.openecomp.sdc.be.datatypes.components.ResourceMetadataDataDefinition;
  66 import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
  67 import org.openecomp.sdc.be.impl.ComponentsUtils;
  68 import org.openecomp.sdc.be.impl.ServletUtils;
  69 import org.openecomp.sdc.be.model.CapabilityTypeDefinition;
  70 import org.openecomp.sdc.be.model.Component;
  71 import org.openecomp.sdc.be.model.DataTypeDefinition;
  72 import org.openecomp.sdc.be.model.InterfaceDefinition;
  73 import org.openecomp.sdc.be.model.RelationshipTypeDefinition;
  74 import org.openecomp.sdc.be.model.User;
  75 import org.openecomp.sdc.be.user.UserBusinessLogic;
  76 import org.openecomp.sdc.common.api.Constants;
  77 import org.openecomp.sdc.common.datastructure.Wrapper;
  78 import org.openecomp.sdc.common.log.wrappers.Logger;
  79 import org.openecomp.sdc.exception.ResponseFormat;
  80 import org.springframework.stereotype.Controller;
  81
  82 @Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
  83 @Path("/v1/catalog")
  84 @Tags({@Tag(name = "SDCE-2 APIs")})
  85 @Servers({@Server(url = "/sdc2/rest")})
  86 @Controller
  87 public class TypesFetchServlet extends AbstractValidationsServlet {
  88
  89     private static final Logger log = Logger.getLogger(TypesFetchServlet.class);
  90     private static final String FAILED_TO_GET_ALL_NON_ABSTRACT = "failed to get all non abstract {}";
  91     private final PropertyBusinessLogic propertyBusinessLogic;
  92     private final RelationshipTypeBusinessLogic relationshipTypeBusinessLogic;
  93     private final CapabilitiesBusinessLogic capabilitiesBusinessLogic;
  94     private final InterfaceOperationBusinessLogic interfaceOperationBusinessLogic;
  95     private final ResourceBusinessLogic resourceBusinessLogic;
  96
  97     @Inject
  98     public TypesFetchServlet(UserBusinessLogic userBusinessLogic, ComponentInstanceBusinessLogic componentInstanceBL, ComponentsUtils componentsUtils,
  99                              ServletUtils servletUtils, ResourceImportManager resourceImportManager, PropertyBusinessLogic propertyBusinessLogic,
 100                              RelationshipTypeBusinessLogic relationshipTypeBusinessLogic, CapabilitiesBusinessLogic capabilitiesBusinessLogic,
 101                              InterfaceOperationBusinessLogic interfaceOperationBusinessLogic, ResourceBusinessLogic resourceBusinessLogic) {
 102         super(userBusinessLogic, componentInstanceBL, componentsUtils, servletUtils, resourceImportManager);
 103         this.propertyBusinessLogic = propertyBusinessLogic;
 104         this.relationshipTypeBusinessLogic = relationshipTypeBusinessLogic;
 105         this.capabilitiesBusinessLogic = capabilitiesBusinessLogic;
 106         this.interfaceOperationBusinessLogic = interfaceOperationBusinessLogic;
 107         this.resourceBusinessLogic = resourceBusinessLogic;
 108     }
 109
 110     @GET
 111     @Path("dataTypes")
 112     @Consumes(MediaType.APPLICATION_JSON)
 113     @Produces(MediaType.APPLICATION_JSON)
 114     @Operation(description = "Get data types", method = "GET", summary = "Returns data types", responses = {
 115         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))),
 116         @ApiResponse(responseCode = "200", description = "datatypes"), @ApiResponse(responseCode = "403", description = "Restricted operation"),
 117         @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"),
 118         @ApiResponse(responseCode = "404", description = "Data types not found")})
 119     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 120     public Response getAllDataTypesServlet(@Context final HttpServletRequest request, @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
 121         Wrapper<Response> responseWrapper = new Wrapper<>();
 122         Wrapper<User> userWrapper = new Wrapper<>();
 123         init();
 124         validateUserExist(responseWrapper, userWrapper, userId);
 125         if (responseWrapper.isEmpty()) {
 126             String url = request.getMethod() + " " + request.getRequestURI();
 127             log.debug("Start handle request of {} - modifier id is {}", url, userId);
 128             Map<String, DataTypeDefinition> dataTypes = propertyBusinessLogic.getAllDataTypes();
 129             String dataTypeJson = gson.toJson(dataTypes);
 130             Response okResponse = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), dataTypeJson);
 131             responseWrapper.setInnerElement(okResponse);
 132         }
 133         return responseWrapper.getInnerElement();
 134     }
 135
 136     @GET
 137     @Path("interfaceLifecycleTypes")
 138     @Consumes(MediaType.APPLICATION_JSON)
 139     @Produces(MediaType.APPLICATION_JSON)
 140     @Operation(description = "Get interface lifecycle types", method = "GET", summary = "Returns interface lifecycle types", responses = {
 141         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))),
 142         @ApiResponse(responseCode = "200", description = "Interface lifecycle types"),
 143         @ApiResponse(responseCode = "403", description = "Restricted operation"),
 144         @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"),
 145         @ApiResponse(responseCode = "404", description = "Interface lifecycle types not found")})
 146     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 147     public Response getInterfaceLifecycleTypes(@Context final HttpServletRequest request,
 148                                                @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
 149         Wrapper<Response> responseWrapper = new Wrapper<>();
 150         Wrapper<User> userWrapper = new Wrapper<>();
 151         try {
 152             validateUserExist(responseWrapper, userWrapper, userId);
 153             if (responseWrapper.isEmpty()) {
 154                 String url = request.getMethod() + " " + request.getRequestURI();
 155                 log.info("Start handle request of {} | modifier id is {}", url, userId);
 156                 Either<Map<String, InterfaceDefinition>, ResponseFormat> allInterfaceLifecycleTypes = interfaceOperationBusinessLogic
 157                     .getAllInterfaceLifecycleTypes();
 158                 if (allInterfaceLifecycleTypes.isRight()) {
 159                     log.info("Failed to get all interface lifecycle types. Reason - {}", allInterfaceLifecycleTypes.right().value());
 160                     Response errorResponse = buildErrorResponse(allInterfaceLifecycleTypes.right().value());
 161                     responseWrapper.setInnerElement(errorResponse);
 162                 } else {
 163                     String interfaceLifecycleTypeJson = gson.toJson(allInterfaceLifecycleTypes.left().value());
 164                     Response okResponse = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), interfaceLifecycleTypeJson);
 165                     responseWrapper.setInnerElement(okResponse);
 166                 }
 167             }
 168             return responseWrapper.getInnerElement();
 169         } catch (Exception e) {
 170             log.debug("get all interface lifecycle types failed with exception", e);
 171             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
 172             return buildErrorResponse(responseFormat);
 173         }
 174     }
 175
 176     @GET
 177     @Path("capabilityTypes")
 178     @Consumes(MediaType.APPLICATION_JSON)
 179     @Produces(MediaType.APPLICATION_JSON)
 180     @Operation(description = "Get capability types", method = "GET", summary = "Returns capability types", responses = {
 181         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))),
 182         @ApiResponse(responseCode = "200", description = "capabilityTypes"), @ApiResponse(responseCode = "403", description = "Restricted operation"),
 183         @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"),
 184         @ApiResponse(responseCode = "404", description = "Capability types not found")})
 185     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 186     public Response getAllCapabilityTypesServlet(@Context final HttpServletRequest request,
 187                                                  @HeaderParam(value = Constants.USER_ID_HEADER) String userId,
 188                                                  @Parameter(description = "model", required = false) @QueryParam("model") String modelName) {
 189         Wrapper<Response> responseWrapper = new Wrapper<>();
 190         Wrapper<User> userWrapper = new Wrapper<>();
 191         try {
 192             init();
 193             validateUserExist(responseWrapper, userWrapper, userId);
 194             if (responseWrapper.isEmpty()) {
 195                 String url = request.getMethod() + " " + request.getRequestURI();
 196                 log.debug("Start handle request of {} | modifier id is {}", url, userId);
 197                 Either<Map<String, CapabilityTypeDefinition>, ResponseFormat> allDataTypes = capabilitiesBusinessLogic.getAllCapabilityTypes(modelName);
 198                 if (allDataTypes.isRight()) {
 199                     log.info("Failed to get all capability types. Reason - {}", allDataTypes.right().value());
 200                     Response errorResponse = buildErrorResponse(allDataTypes.right().value());
 201                     responseWrapper.setInnerElement(errorResponse);
 202                 } else {
 203                     Map<String, CapabilityTypeDefinition> dataTypes = allDataTypes.left().value();
 204                     String dataTypeJson = gson.toJson(dataTypes);
 205                     Response okResponse = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), dataTypeJson);
 206                     responseWrapper.setInnerElement(okResponse);
 207                 }
 208             }
 209             return responseWrapper.getInnerElement();
 210         } catch (Exception e) {
 211             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Get Capability Types");
 212             log.debug("get all capability types failed with exception", e);
 213             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
 214             return buildErrorResponse(responseFormat);
 215         }
 216     }
 217
 218     @GET
 219     @Path("relationshipTypes")
 220     @Consumes(MediaType.APPLICATION_JSON)
 221     @Produces(MediaType.APPLICATION_JSON)
 222     @Operation(description = "Get relationship types", method = "GET", summary = "Returns relationship types", responses = {
 223         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))),
 224         @ApiResponse(responseCode = "200", description = "relationshipTypes"),
 225         @ApiResponse(responseCode = "403", description = "Restricted operation"),
 226         @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"),
 227         @ApiResponse(responseCode = "404", description = "Relationship types not found")})
 228     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 229     public Response getAllRelationshipTypesServlet(@Context final HttpServletRequest request,
 230                                                    @HeaderParam(value = Constants.USER_ID_HEADER) String userId,
 231                                                    @Parameter(description = "model", required = false) @QueryParam("model") String modelName) {
 232         Wrapper<Response> responseWrapper = new Wrapper<>();
 233         Wrapper<User> userWrapper = new Wrapper<>();
 234         try {
 235             init();
 236             validateUserExist(responseWrapper, userWrapper, userId);
 237             if (responseWrapper.isEmpty()) {
 238                 String url = request.getMethod() + " " + request.getRequestURI();
 239                 log.debug("Start handle request of {} | modifier id is {}", url, userId);
 240                 Either<Map<String, RelationshipTypeDefinition>, ResponseFormat> allDataTypes = relationshipTypeBusinessLogic
 241                     .getAllRelationshipTypes(modelName);
 242                 if (allDataTypes.isRight()) {
 243                     log.info("Failed to get all relationship types. Reason - {}", allDataTypes.right().value());
 244                     Response errorResponse = buildErrorResponse(allDataTypes.right().value());
 245                     responseWrapper.setInnerElement(errorResponse);
 246                 } else {
 247                     Map<String, RelationshipTypeDefinition> dataTypes = allDataTypes.left().value();
 248                     String dataTypeJson = gson.toJson(dataTypes);
 249                     Response okResponse = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), dataTypeJson);
 250                     responseWrapper.setInnerElement(okResponse);
 251                 }
 252             }
 253             return responseWrapper.getInnerElement();
 254         } catch (Exception e) {
 255             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Get Relationship Types");
 256             log.debug("get all relationship types failed with exception", e);
 257             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
 258             return buildErrorResponse(responseFormat);
 259         }
 260     }
 261
 262     @GET
 263     @Path("nodeTypes")
 264     @Consumes(MediaType.APPLICATION_JSON)
 265     @Produces(MediaType.APPLICATION_JSON)
 266     @Operation(description = "Get node types", method = "GET", summary = "Returns node types", responses = {
 267         @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Response.class)))),
 268         @ApiResponse(responseCode = "200", description = "nodeTypes"), @ApiResponse(responseCode = "403", description = "Restricted operation"),
 269         @ApiResponse(responseCode = "400", description = "Invalid content / Missing content"),
 270         @ApiResponse(responseCode = "404", description = "Node types not found")})
 271     @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
 272     public Response getAllNodeTypesServlet(@Context final HttpServletRequest request, @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
 273         Wrapper<Response> responseWrapper = new Wrapper<>();
 274         Wrapper<User> userWrapper = new Wrapper<>();
 275         ServletContext context = request.getSession().getServletContext();
 276         Either<Map<String, Component>, Response> response;
 277         Map<String, Component> componentMap;
 278         try {
 279             init();
 280             validateUserExist(responseWrapper, userWrapper, userId);
 281             if (responseWrapper.isEmpty()) {
 282                 String url = request.getMethod() + " " + request.getRequestURI();
 283                 log.debug("Start handle request of {} | modifier id is {}", url, userId);
 284                 response = getComponent(resourceBusinessLogic, true, userId);
 285                 if (response.isRight()) {
 286                     return response.right().value();
 287                 }
 288                 componentMap = new HashMap<>(response.left().value());
 289                 response = getComponent(resourceBusinessLogic, false, userId);
 290                 if (response.isRight()) {
 291                     return response.right().value();
 292                 }
 293                 componentMap.putAll(response.left().value());
 294                 String nodeTypesJson = gson.toJson(componentMap);
 295                 Response okResponse = buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), nodeTypesJson);
 296                 responseWrapper.setInnerElement(okResponse);
 297             }
 298             return responseWrapper.getInnerElement();
 299         } catch (Exception e) {
 300             BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Get Node Types");
 301             log.debug("get all node types failed with exception", e);
 302             ResponseFormat responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
 303             return buildErrorResponse(responseFormat);
 304         }
 305     }
 306
 307     private Either<Map<String, Component>, Response> getComponent(ComponentBusinessLogic resourceBL, boolean isAbstract, String userId) {
 308         Either<List<Component>, ResponseFormat> actionResponse;
 309         List<Component> componentList;
 310         actionResponse = resourceBL
 311             .getLatestVersionNotAbstractComponentsMetadata(isAbstract, HighestFilterEnum.HIGHEST_ONLY, ComponentTypeEnum.RESOURCE, null, userId,
 312                 null);
 313         if (actionResponse.isRight()) {
 314             log.debug(FAILED_TO_GET_ALL_NON_ABSTRACT, ComponentTypeEnum.RESOURCE.getValue());
 315             return Either.right(buildErrorResponse(actionResponse.right().value()));
 316         }
 317         componentList = actionResponse.left().value();
 318         return Either.left(ListUtils.emptyIfNull(componentList).stream().filter(component ->
 319             ((ResourceMetadataDataDefinition) component.getComponentMetadataDefinition().getMetadataDataDefinition()).getToscaResourceName() != null)
 320             .collect(Collectors.toMap(
 321                 component -> ((ResourceMetadataDataDefinition) component.getComponentMetadataDefinition().getMetadataDataDefinition())
 322                     .getToscaResourceName(), component -> component, (component1, component2) -> component1)));
 323     }
 324 }