From 4f251edb14a4f525475df18f4f651696152b3b42 Mon Sep 17 00:00:00 2001 From: aribeiro Date: Fri, 4 Sep 2020 10:29:18 +0100 Subject: Make directives options configurable Issue-ID: SDC-3275 Signed-off-by: aribeiro Change-Id: Ia91655f02c45d033ebae45bd6d9f252c2f6d6f47 --- .../sdc/be/servlets/DirectiveServlet.java | 104 +++++++++++++++++++++ .../src/main/resources/config/configuration.yaml | 7 ++ .../resources/config/catalog-be/configuration.yaml | 7 ++ 3 files changed, 118 insertions(+) create mode 100644 catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DirectiveServlet.java (limited to 'catalog-be/src') diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DirectiveServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DirectiveServlet.java new file mode 100644 index 0000000000..adffdaf9d7 --- /dev/null +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DirectiveServlet.java @@ -0,0 +1,104 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2020 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.openecomp.sdc.be.servlets; + +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.media.ArraySchema; +import io.swagger.v3.oas.annotations.media.Content; +import io.swagger.v3.oas.annotations.media.Schema; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import javax.inject.Inject; +import javax.inject.Singleton; +import javax.servlet.http.HttpServletRequest; +import javax.ws.rs.GET; +import javax.ws.rs.HeaderParam; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.Context; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import org.apache.commons.collections.CollectionUtils; +import org.openecomp.sdc.be.components.impl.aaf.AafPermission; +import org.openecomp.sdc.be.components.impl.aaf.PermissionAllowed; +import org.openecomp.sdc.be.config.BeEcompErrorManager; +import org.openecomp.sdc.be.config.ConfigurationManager; +import org.openecomp.sdc.be.dao.api.ActionStatus; +import org.openecomp.sdc.be.impl.ComponentsUtils; +import org.openecomp.sdc.be.model.User; +import org.openecomp.sdc.be.user.UserBusinessLogic; +import org.openecomp.sdc.common.api.Constants; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +@Path("/v1/catalog/directives") +@Singleton +public class DirectiveServlet extends BeGenericServlet { + + private static final Logger LOGGER = LoggerFactory.getLogger(DirectiveServlet.class); + + @Inject + public DirectiveServlet(final UserBusinessLogic userAdminManager, + final ComponentsUtils componentsUtils) { + super(userAdminManager, componentsUtils); + } + + @GET + @Path("/") + @Produces(MediaType.APPLICATION_JSON) + @Operation(description = "Retrieve all Directives values from configuration file", method = "GET", + summary = "Retrieve all Directives", responses = { + @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = User.class)))), + @ApiResponse(responseCode = "200", + description = "Returns Directive values from configuration file Ok"), + @ApiResponse(responseCode = "404", + description = "Directive not found"), + @ApiResponse(responseCode = "500", description = "Internal Server Error")}) + @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE) + public Response getConfCategoriesAndVersion(@Context final HttpServletRequest request, + @HeaderParam(value = Constants.USER_ID_HEADER) String userId) { + + final String url = request.getMethod() + " " + request.getRequestURI(); + LOGGER.debug("Start handle request of {}", url); + + final Map directivesMap = new HashMap<>(); + try { + final List directives = getDirectiveValues(); + if (CollectionUtils.isEmpty(directives)) { + return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.NO_CONTENT)); + } + directivesMap.put("directives", directives); + + } catch (final Exception e) { + BeEcompErrorManager.getInstance().logBeRestApiGeneralError("SDC Failed to retrieve all Directives"); + LOGGER.debug("Method getDirectiveValues failed with unexpected exception", e); + return buildErrorResponse(getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR)); + } + + return buildOkResponse(getComponentsUtils().getResponseFormat(ActionStatus.OK), directivesMap); + } + + private List getDirectiveValues() { + return ConfigurationManager.getConfigurationManager().getConfiguration().getDirectives(); + } + +} diff --git a/catalog-be/src/main/resources/config/configuration.yaml b/catalog-be/src/main/resources/config/configuration.yaml index ab89d8f158..298862e79f 100644 --- a/catalog-be/src/main/resources/config/configuration.yaml +++ b/catalog-be/src/main/resources/config/configuration.yaml @@ -914,3 +914,10 @@ cadiFilterParams: # This configuration entry lists all node type names prefix that shall be allowed on SDC. definedResourceNamespace: - org.openecomp.resource. + +# This configuration entry lists all Directives values that shall be allowed on SDC. +directives: + - select + - selectable + - substitute + - substitutable diff --git a/catalog-be/src/test/resources/config/catalog-be/configuration.yaml b/catalog-be/src/test/resources/config/catalog-be/configuration.yaml index 88729d655a..7f75646467 100644 --- a/catalog-be/src/test/resources/config/catalog-be/configuration.yaml +++ b/catalog-be/src/test/resources/config/catalog-be/configuration.yaml @@ -554,6 +554,13 @@ cadiFilterParams: definedResourceNamespace: - org.openecomp.resource. +# This configuration entry lists all Directives values that shall be allowed on SDC. +directives: + - select + - selectable + - substitute + - substitutable + artifacts: - type: CONTROLLER_BLUEPRINT_ARCHIVE categories: -- cgit 1.2.3-korg