-/*-
- * ============LICENSE_START=======================================================
- * SDC
- * ================================================================================
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
- * ================================================================================
- * 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.
- * ============LICENSE_END=========================================================
- */
-
-package org.openecomp.sdc.be.externalapi.servlet;
-
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.jcabi.aspects.Loggable;
-import fj.data.Either;
-import io.swagger.annotations.*;
-import javax.inject.Inject;
-import org.apache.commons.lang3.StringUtils;
-import org.openecomp.sdc.be.components.impl.ComponentInstanceBusinessLogic;
-import org.openecomp.sdc.be.components.impl.GroupBusinessLogic;
-import org.openecomp.sdc.be.components.impl.ResourceImportManager;
-import org.openecomp.sdc.be.components.impl.ServiceBusinessLogic;
-import org.openecomp.sdc.be.config.BeEcompErrorManager;
-import org.openecomp.sdc.be.dao.api.ActionStatus;
-import org.openecomp.sdc.be.externalapi.servlet.representation.ServiceDistributionReqInfo;
-import org.openecomp.sdc.be.externalapi.servlet.representation.ServiceDistributionRespInfo;
-import org.openecomp.sdc.be.impl.ComponentsUtils;
-import org.openecomp.sdc.be.impl.ServletUtils;
-import org.openecomp.sdc.be.model.User;
-import org.openecomp.sdc.be.resources.data.auditing.model.DistributionData;
-import org.openecomp.sdc.be.servlets.AbstractValidationsServlet;
-import org.openecomp.sdc.be.servlets.RepresentationUtils;
-import org.openecomp.sdc.be.user.UserBusinessLogic;
-import org.openecomp.sdc.common.api.Constants;
-import org.openecomp.sdc.common.datastructure.Wrapper;
-import org.openecomp.sdc.common.log.wrappers.Logger;
-import org.openecomp.sdc.exception.ResponseFormat;
-
-import javax.inject.Singleton;
-import javax.servlet.ServletContext;
-import javax.servlet.http.HttpServletRequest;
-import javax.ws.rs.*;
-import javax.ws.rs.core.Context;
-import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.Response;
-import java.io.IOException;
-
-/**
- * Created by chaya on 10/17/2017.
- */
-@Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
-@Path("/v1/catalog")
-@Api(value = "Service Activation External Servlet", description = "This Servlet serves external users for activating a specific service")
-@Singleton
-public class ServiceActivationServlet extends AbstractValidationsServlet {
-
- @Context
- private HttpServletRequest request;
-
- private static final Logger log = Logger.getLogger(ServiceActivationServlet.class);
- private final ServiceBusinessLogic serviceBusinessLogic;
-
- @Inject
- public ServiceActivationServlet(UserBusinessLogic userBusinessLogic,
- ComponentInstanceBusinessLogic componentInstanceBL,
- ComponentsUtils componentsUtils, ServletUtils servletUtils,
- ResourceImportManager resourceImportManager,
- ServiceBusinessLogic serviceBusinessLogic) {
- super(userBusinessLogic, componentInstanceBL, componentsUtils, servletUtils, resourceImportManager);
- this.serviceBusinessLogic = serviceBusinessLogic;
- }
-
-
- /**
- * Activates a service on a specific environment
- *
- * @param serviceUUID
- * @param opEnvId
- * @param userId
- * @param instanceIdHeader
- * @return
- */
- @POST
- @Path("/services/{serviceUUID}/distribution/{opEnvId}/activate")
- @Consumes(MediaType.APPLICATION_JSON)
- @Produces(MediaType.APPLICATION_JSON)
- @ApiOperation(value = "activate a service", httpMethod = "POST", notes = "Activates a service")
- @ApiResponses(value = {
- @ApiResponse(code = 202, message = "ECOMP component is authenticated and required service may be distributed"),
- @ApiResponse(code = 400, message = "Missing X-ECOMP-InstanceID HTTP header - POL5001"),
- @ApiResponse(code = 401, message = "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002"),
- @ApiResponse(code = 403, message = "ECOMP component is not authorized - POL5003"),
- @ApiResponse(code = 404, message = "Error: Requested '%1' (uuid) resource was not found - SVC4063"),
- @ApiResponse(code = 405, message = "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050"),
- @ApiResponse(code = 500, message = "The request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000"),
- @ApiResponse(code = 400, message = "Invalid field format. One of the provided fields does not comply with the field rules - SVC4126"),
- @ApiResponse(code = 400, message = "Missing request body. The post request did not contain the expected body - SVC4500"),
- @ApiResponse(code = 400, message = "The resource name is missing in the request body - SVC4062"),
- @ApiResponse(code = 409, message = "Service state is invalid for this action"),
- @ApiResponse(code = 502, message = "The server was acting as a gateway or proxy and received an invalid response from the upstream server")})
- public Response activateServiceExternal(
- @ApiParam(value = "Determines the format of the body of the request", required = true) @HeaderParam(value = Constants.CONTENT_TYPE_HEADER) String contentType,
- @ApiParam(value = "The user id", required = true) @HeaderParam(value = Constants.USER_ID_HEADER) final String userId,
- @ApiParam(value = "X-ECOMP-RequestID header", required = false) @HeaderParam(value = Constants.X_ECOMP_REQUEST_ID_HEADER) String requestId,
- @ApiParam(value = "X-ECOMP-InstanceID header", required = true) @HeaderParam(value = Constants.X_ECOMP_INSTANCE_ID_HEADER) final String instanceIdHeader,
- @ApiParam(value = "Determines the format of the body of the response", required = false) @HeaderParam(value = Constants.ACCEPT_HEADER) String accept,
- @ApiParam(value = "The username and password", required = true) @HeaderParam(value = Constants.AUTHORIZATION_HEADER) String authorization,
- @ApiParam(value = "The serviceUUid to activate", required = true) @PathParam("serviceUUID") final String serviceUUID,
- @ApiParam(value = "The operational environment on which to activate the service on", required = true) @PathParam("opEnvId") final String opEnvId,
- String data) {
-
- init();
-
- ResponseFormat responseFormat = null;
- String requestURI = request.getRequestURI();
- String url = request.getMethod() + " " + requestURI;
- log.debug("Start handle request of {}", url);
-
- User modifier = new User();
-
- try {
-
- Wrapper<ResponseFormat> responseWrapper = validateRequestHeaders(instanceIdHeader, userId);
-
- if (responseWrapper.isEmpty()) {
- modifier.setUserId(userId);
- log.debug("modifier id is {}", userId);
-
- ServiceDistributionReqInfo reqMetadata = convertJsonToActivationMetadata(data);
- Either<String, ResponseFormat> distResponse = serviceBusinessLogic.activateServiceOnTenantEnvironment(serviceUUID, opEnvId, modifier, reqMetadata);
-
- if (distResponse.isRight()) {
- log.debug("failed to activate service distribution");
- responseFormat = distResponse.right().value();
- return buildErrorResponse(responseFormat);
- }
- String distributionId = distResponse.left().value();
- Object result = RepresentationUtils.toRepresentation(new ServiceDistributionRespInfo(distributionId));
- responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.ACCEPTED);
- return buildOkResponse(responseFormat, result);
- } else {
- log.debug("request instanceId/userId header validation failed");
- responseFormat = responseWrapper.getInnerElement();
- return buildErrorResponse(responseFormat);
- }
- } catch (Exception e) {
- BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Activate Distribution");
- log.debug("activate distribution failed with exception", e);
- responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);
- return buildErrorResponse(responseFormat);
- } finally {
- getComponentsUtils().auditExternalActivateService(responseFormat,
- new DistributionData(instanceIdHeader, requestURI), requestId, serviceUUID, modifier);
- }
- }
-
- private Wrapper<ResponseFormat> validateRequestHeaders(String instanceIdHeader, String userId) {
- Wrapper<ResponseFormat> responseWrapper = new Wrapper<>();
- if (responseWrapper.isEmpty()) {
- validateXECOMPInstanceIDHeader(instanceIdHeader, responseWrapper);
- }
- if (responseWrapper.isEmpty()) {
- validateHttpCspUserIdHeader(userId, responseWrapper);
- }
- return responseWrapper;
- }
-
- private ServiceDistributionReqInfo convertJsonToActivationMetadata(String data) {
- ObjectMapper mapper = new ObjectMapper();
- try {
- return mapper.readValue(data, ServiceDistributionReqInfo.class);
- } catch (IOException e) {
- log.error("#convertJsonToActivationMetadata - json deserialization failed with error: ", e);
- return new ServiceDistributionReqInfo(null);
- }
- }
-
- @Override
- protected void validateHttpCspUserIdHeader(String header, Wrapper<ResponseFormat> responseWrapper) {
- ResponseFormat responseFormat;
- if( StringUtils.isEmpty(header)){
- log.debug("MissingUSER_ID");
- responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.AUTH_FAILED);
- responseWrapper.setInnerElement(responseFormat);
- }
- }
-}
-
-
-
+/*-\r
+ * ============LICENSE_START=======================================================\r
+ * SDC\r
+ * ================================================================================\r
+ * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.\r
+ * ================================================================================\r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ * \r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ * \r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ * ============LICENSE_END=========================================================\r
+ */\r
+\r
+package org.openecomp.sdc.be.externalapi.servlet;\r
+\r
+import java.io.IOException;\r
+import javax.inject.Inject;\r
+import javax.inject.Singleton;\r
+import javax.servlet.http.HttpServletRequest;\r
+import javax.ws.rs.Consumes;\r
+import javax.ws.rs.HeaderParam;\r
+import javax.ws.rs.POST;\r
+import javax.ws.rs.Path;\r
+import javax.ws.rs.PathParam;\r
+import javax.ws.rs.Produces;\r
+import javax.ws.rs.core.Context;\r
+import javax.ws.rs.core.MediaType;\r
+import javax.ws.rs.core.Response;\r
+import org.apache.commons.lang3.StringUtils;\r
+import org.openecomp.sdc.be.components.impl.ComponentInstanceBusinessLogic;\r
+import org.openecomp.sdc.be.components.impl.ResourceImportManager;\r
+import org.openecomp.sdc.be.components.impl.ServiceBusinessLogic;\r
+import org.openecomp.sdc.be.config.BeEcompErrorManager;\r
+import org.openecomp.sdc.be.dao.api.ActionStatus;\r
+import org.openecomp.sdc.be.externalapi.servlet.representation.ServiceDistributionReqInfo;\r
+import org.openecomp.sdc.be.externalapi.servlet.representation.ServiceDistributionRespInfo;\r
+import org.openecomp.sdc.be.impl.ComponentsUtils;\r
+import org.openecomp.sdc.be.impl.ServletUtils;\r
+import org.openecomp.sdc.be.model.User;\r
+import org.openecomp.sdc.be.resources.data.auditing.model.DistributionData;\r
+import org.openecomp.sdc.be.servlets.AbstractValidationsServlet;\r
+import org.openecomp.sdc.be.servlets.RepresentationUtils;\r
+import org.openecomp.sdc.be.user.UserBusinessLogic;\r
+import org.openecomp.sdc.common.api.Constants;\r
+import org.openecomp.sdc.common.datastructure.Wrapper;\r
+import org.openecomp.sdc.common.log.wrappers.Logger;\r
+import org.openecomp.sdc.exception.ResponseFormat;\r
+import com.fasterxml.jackson.databind.ObjectMapper;\r
+import com.jcabi.aspects.Loggable;\r
+import fj.data.Either;\r
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;\r
+import io.swagger.v3.oas.annotations.Operation;\r
+import io.swagger.v3.oas.annotations.Parameter;\r
+import io.swagger.v3.oas.annotations.info.Info;\r
+import io.swagger.v3.oas.annotations.responses.ApiResponse;\r
+import io.swagger.v3.oas.annotations.responses.ApiResponses;\r
+\r
+/**\r
+ * Created by chaya on 10/17/2017.\r
+ */\r
+@Loggable(prepend = true, value = Loggable.DEBUG, trim = false)\r
+@Path("/v1/catalog")\r
+@OpenAPIDefinition(info = @Info(title = "Service Activation External Servlet", description = "This Servlet serves external users for activating a specific service"))\r
+@Singleton\r
+public class ServiceActivationServlet extends AbstractValidationsServlet {\r
+\r
+ @Context\r
+ private HttpServletRequest request;\r
+\r
+ private static final Logger log = Logger.getLogger(ServiceActivationServlet.class);\r
+ private final ServiceBusinessLogic serviceBusinessLogic;\r
+\r
+ @Inject\r
+ public ServiceActivationServlet(UserBusinessLogic userBusinessLogic,\r
+ ComponentInstanceBusinessLogic componentInstanceBL,\r
+ ComponentsUtils componentsUtils, ServletUtils servletUtils,\r
+ ResourceImportManager resourceImportManager,\r
+ ServiceBusinessLogic serviceBusinessLogic) {\r
+ super(userBusinessLogic, componentInstanceBL, componentsUtils, servletUtils, resourceImportManager);\r
+ this.serviceBusinessLogic = serviceBusinessLogic;\r
+ }\r
+\r
+\r
+ /**\r
+ * Activates a service on a specific environment\r
+ *\r
+ * @param serviceUUID\r
+ * @param opEnvId\r
+ * @param userId\r
+ * @param instanceIdHeader\r
+ * @return\r
+ */\r
+ @POST\r
+ @Path("/services/{serviceUUID}/distribution/{opEnvId}/activate")\r
+ @Consumes(MediaType.APPLICATION_JSON)\r
+ @Produces(MediaType.APPLICATION_JSON)\r
+ @Operation(description = "activate a service", method = "POST", summary = "Activates a service")\r
+ @ApiResponses(value = {\r
+ @ApiResponse(responseCode = "202",\r
+ description = "ECOMP component is authenticated and required service may be distributed"),\r
+ @ApiResponse(responseCode = "400", description = "Missing X-ECOMP-InstanceID HTTP header - POL5001"),\r
+ @ApiResponse(responseCode = "401",\r
+ description = "ECOMP component should authenticate itself and to re-send again HTTP request with its Basic Authentication credentials - POL5002"),\r
+ @ApiResponse(responseCode = "403", description = "ECOMP component is not authorized - POL5003"),\r
+ @ApiResponse(responseCode = "404",\r
+ description = "Error: Requested '%1' (uuid) resource was not found - SVC4063"),\r
+ @ApiResponse(responseCode = "405",\r
+ description = "Method Not Allowed : Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050"),\r
+ @ApiResponse(responseCode = "500",\r
+ description = "The request failed either due to internal SDC problem. ECOMP Component should continue the attempts to get the needed information - POL5000"),\r
+ @ApiResponse(responseCode = "400",\r
+ description = "Invalid field format. One of the provided fields does not comply with the field rules - SVC4126"),\r
+ @ApiResponse(responseCode = "400",\r
+ description = "Missing request body. The post request did not contain the expected body - SVC4500"),\r
+ @ApiResponse(responseCode = "400",\r
+ description = "The resource name is missing in the request body - SVC4062"),\r
+ @ApiResponse(responseCode = "409", description = "Service state is invalid for this action"),\r
+ @ApiResponse(responseCode = "502",\r
+ description = "The server was acting as a gateway or proxy and received an invalid response from the upstream server")})\r
+ public Response activateServiceExternal(\r
+ @Parameter(description = "Determines the format of the body of the request",\r
+ required = true) @HeaderParam(value = Constants.CONTENT_TYPE_HEADER) String contentType,\r
+ @Parameter(description = "The user id",\r
+ required = true) @HeaderParam(value = Constants.USER_ID_HEADER) final String userId,\r
+ @Parameter(description = "X-ECOMP-RequestID header",\r
+ required = false) @HeaderParam(value = Constants.X_ECOMP_REQUEST_ID_HEADER) String requestId,\r
+ @Parameter(description = "X-ECOMP-InstanceID header", required = true) @HeaderParam(\r
+ value = Constants.X_ECOMP_INSTANCE_ID_HEADER) final String instanceIdHeader,\r
+ @Parameter(description = "Determines the format of the body of the response",\r
+ required = false) @HeaderParam(value = Constants.ACCEPT_HEADER) String accept,\r
+ @Parameter(description = "The username and password",\r
+ required = true) @HeaderParam(value = Constants.AUTHORIZATION_HEADER) String authorization,\r
+ @Parameter(description = "The serviceUUid to activate",\r
+ required = true) @PathParam("serviceUUID") final String serviceUUID,\r
+ @Parameter(description = "The operational environment on which to activate the service on",\r
+ required = true) @PathParam("opEnvId") final String opEnvId,\r
+ String data) {\r
+\r
+ init();\r
+\r
+ ResponseFormat responseFormat = null;\r
+ String requestURI = request.getRequestURI();\r
+ String url = request.getMethod() + " " + requestURI;\r
+ log.debug("Start handle request of {}", url);\r
+\r
+ User modifier = new User();\r
+\r
+ try {\r
+\r
+ Wrapper<ResponseFormat> responseWrapper = validateRequestHeaders(instanceIdHeader, userId);\r
+\r
+ if (responseWrapper.isEmpty()) {\r
+ modifier.setUserId(userId);\r
+ log.debug("modifier id is {}", userId);\r
+\r
+ ServiceDistributionReqInfo reqMetadata = convertJsonToActivationMetadata(data);\r
+ Either<String, ResponseFormat> distResponse = serviceBusinessLogic\r
+ .activateServiceOnTenantEnvironment(serviceUUID, opEnvId, modifier, reqMetadata);\r
+\r
+ if (distResponse.isRight()) {\r
+ log.debug("failed to activate service distribution");\r
+ responseFormat = distResponse.right().value();\r
+ return buildErrorResponse(responseFormat);\r
+ }\r
+ String distributionId = distResponse.left().value();\r
+ Object result = RepresentationUtils.toRepresentation(new ServiceDistributionRespInfo(distributionId));\r
+ responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.ACCEPTED);\r
+ return buildOkResponse(responseFormat, result);\r
+ } else {\r
+ log.debug("request instanceId/userId header validation failed");\r
+ responseFormat = responseWrapper.getInnerElement();\r
+ return buildErrorResponse(responseFormat);\r
+ }\r
+ } catch (Exception e) {\r
+ BeEcompErrorManager.getInstance().logBeRestApiGeneralError("Activate Distribution");\r
+ log.debug("activate distribution failed with exception", e);\r
+ responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.GENERAL_ERROR);\r
+ return buildErrorResponse(responseFormat);\r
+ } finally {\r
+ getComponentsUtils().auditExternalActivateService(responseFormat,\r
+ new DistributionData(instanceIdHeader, requestURI), requestId, serviceUUID, modifier);\r
+ }\r
+ }\r
+\r
+ private Wrapper<ResponseFormat> validateRequestHeaders(String instanceIdHeader, String userId) {\r
+ Wrapper<ResponseFormat> responseWrapper = new Wrapper<>();\r
+ if (responseWrapper.isEmpty()) {\r
+ validateXECOMPInstanceIDHeader(instanceIdHeader, responseWrapper);\r
+ }\r
+ if (responseWrapper.isEmpty()) {\r
+ validateHttpCspUserIdHeader(userId, responseWrapper);\r
+ }\r
+ return responseWrapper;\r
+ }\r
+\r
+ private ServiceDistributionReqInfo convertJsonToActivationMetadata(String data) {\r
+ ObjectMapper mapper = new ObjectMapper();\r
+ try {\r
+ return mapper.readValue(data, ServiceDistributionReqInfo.class);\r
+ } catch (IOException e) {\r
+ log.error("#convertJsonToActivationMetadata - json deserialization failed with error: ", e);\r
+ return new ServiceDistributionReqInfo(null);\r
+ }\r
+ }\r
+\r
+ @Override\r
+ protected void validateHttpCspUserIdHeader(String header, Wrapper<ResponseFormat> responseWrapper) {\r
+ ResponseFormat responseFormat;\r
+ if( StringUtils.isEmpty(header)){\r
+ log.debug("MissingUSER_ID");\r
+ responseFormat = getComponentsUtils().getResponseFormat(ActionStatus.AUTH_FAILED);\r
+ responseWrapper.setInnerElement(responseFormat);\r
+ }\r
+ }\r
+}\r
+\r
+\r
+\r
Code Review / sdc.git / blobdiff