[sdc] rebase update
[sdc.git] / catalog-be / src / main / java / org / openecomp / sdc / be / distribution / servlet / DistributionServlet.java
index 532cc17..71e97f7 100644 (file)
@@ -84,10 +84,11 @@ public class DistributionServlet extends BeGenericServlet {
        private static Logger log = LoggerFactory.getLogger(DistributionServlet.class.getName());
        @Resource
        private DistributionBusinessLogic distributionLogic;
+       @Context
+       private HttpServletRequest request;
        
        /**
         * 
-        * @param request
         * @param requestId
         * @param instanceId
         * @param accept
@@ -105,12 +106,12 @@ public class DistributionServlet extends BeGenericServlet {
                        @ResponseHeader(name = "Content-Length", description = "Length of  the response body", response = String.class)})
        @ApiResponses(value = {
                        @ApiResponse(code = 200, message = "ECOMP component is authenticated and list of Cambria API server’s FQDNs is returned", response = ServerListResponse.class),
-                       @ApiResponse(code = 400, message = "Missing  “X-ECOMP-InstanceID”  HTTP header - POL5001"),
+                       @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 credentials  for  Basic Authentication - POL5002"),
                        @ApiResponse(code = 403, message = "ECOMP component is not authorized - POL5003"),
                        @ApiResponse(code = 405, message = "Method  Not Allowed: Invalid HTTP method type used ( PUT,DELETE,POST will be rejected) - POL4050"),
                        @ApiResponse(code = 500, message = "The GET request failed either due to internal SDC problem or Cambria Service failure. ECOMP Component should continue the attempts to get the needed information - POL5000")})
-       public Response getUebServerList(@Context final HttpServletRequest request, 
+       public Response getUebServerList( 
                        @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) String instanceId, 
                        @ApiParam(value = "Determines the format of the body of the response", required = false)@HeaderParam(value = Constants.ACCEPT_HEADER) String accept,
@@ -157,7 +158,6 @@ public class DistributionServlet extends BeGenericServlet {
        
        /**
         * 
-        * @param request
         * @param requestId
         * @param instanceId
         * @param accept
@@ -174,18 +174,18 @@ public class DistributionServlet extends BeGenericServlet {
        @ApiOperation(value = "Subscription status", httpMethod = "POST", notes = "Subscribes for distribution notifications")
        @ApiResponses(value = {
                        @ApiResponse(code = 200, message = "ECOMP component is successfully registered for distribution", response = TopicRegistrationResponse.class),
-                       @ApiResponse(code = 400, message = "Missing  “X-ECOMP-InstanceID”  HTTP header - POL5001"),
+                       @ApiResponse(code = 400, message = "Missing  'X-ECOMP-InstanceID'  HTTP header - POL5001"),
                        @ApiResponse(code = 400, message = "Missing  Body - POL4500"),
-                       @ApiResponse(code = 400, message = "Invalid  Body  : missing mandatory parameter “apiPublicKey” - POL4501"),
-                       @ApiResponse(code = 400, message = "Invalid  Body  : missing mandatory parameter “distrEnvName” - POL4502"),
-                       @ApiResponse(code = 400, message = "Invalid Body :  Specified “distrEnvName” doesn’t exist - POL4137"),
+                       @ApiResponse(code = 400, message = "Invalid  Body  : missing mandatory parameter 'apiPublicKey' - POL4501"),
+                       @ApiResponse(code = 400, message = "Invalid  Body  : missing mandatory parameter 'distrEnvName' - POL4502"),
+                       @ApiResponse(code = 400, message = "Invalid Body :  Specified 'distrEnvName' doesn’t exist - POL4137"),
                        @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 = 405, message = "Method  Not Allowed  :  Invalid HTTP method type used to  register for  distribution ( PUT,DELETE,GET  will be rejected) - POL4050"),
                        @ApiResponse(code = 500, message = "The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component  should  continue the attempts to  register for  distribution - POL5000")})
        //TODO Tal G fix response headers and to check missing header validations with Michael L
        @ApiImplicitParams({@ApiImplicitParam(required = true, dataType = "org.openecomp.sdc.be.distribution.api.client.RegistrationRequest", paramType = "body", value = "json describe the artifact")})
-       public Response registerForDistribution(@Context final HttpServletRequest request,
+       public Response registerForDistribution(
                        @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) String instanceId, 
                        @ApiParam(value = "Determines the format of the body of the response", required = false)@HeaderParam(value = Constants.ACCEPT_HEADER) String accept,
@@ -223,25 +223,29 @@ public class DistributionServlet extends BeGenericServlet {
         * Returns list of valid artifact types for validation done in the distribution client.<br>
         * The list is the representation of the values of the enum ArtifactTypeEnum.
         * 
-        * @param request
         * @param requestId
         * @param instanceId
         * @param authorization
         * @param accept
         * @return
         */
-       //TODO Get the missing AID for this API
        @GET
        @Path("/artifactTypes")
        @Consumes(MediaType.APPLICATION_JSON)
        @Produces(MediaType.APPLICATION_JSON)
-       @ApiOperation(value = "Artifact types list", httpMethod = "GET", notes = "Fetches available artifact types list", response = String.class)
-       @ApiResponses(value = { @ApiResponse(code = 200, message = "Artifact types list fetched successfully"), @ApiResponse(code = 500, message = "One or more BE components (Titan, ES, BE) are down") })
-       public Response getValidArtifactTypes(@Context final HttpServletRequest request, 
-                       @HeaderParam(value = Constants.X_ECOMP_REQUEST_ID_HEADER) String requestId,
-                       @HeaderParam(value = Constants.X_ECOMP_INSTANCE_ID_HEADER) String instanceId, 
-                       @HeaderParam(value = Constants.AUTHORIZATION_HEADER) String authorization, 
-                       @HeaderParam(value = Constants.ACCEPT_HEADER) String accept) {
+       @ApiOperation(value = "Artifact types list", httpMethod = "GET", notes = "Fetches available artifact types list")
+       @ApiResponses(value = {
+                       @ApiResponse(code = 200, message = "Artifact types list fetched successfully", response = String.class),
+                       @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 = 405, message = "Method  Not Allowed  :  Invalid HTTP method type used to  register for  distribution ( POST,PUT,DELETE  will be rejected) - POL4050"),
+                       @ApiResponse(code = 500, message = "The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component  should  continue the attempts to  register for  distribution - POL5000")})
+       public Response getValidArtifactTypes(
+                       @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) String instanceId, 
+                       @ApiParam(value = "The username and password", required = true)@HeaderParam(value = Constants.AUTHORIZATION_HEADER) String authorization, 
+                       @ApiParam(value = "The username and password", required = true)@HeaderParam(value = Constants.ACCEPT_HEADER) String accept) {
                init(request);
                String url = request.getMethod() + " " + request.getRequestURI();
                log.debug("Start handle request of {}", url);
@@ -261,7 +265,6 @@ public class DistributionServlet extends BeGenericServlet {
        /**
         * Removes from subscription for distribution notifications
         * 
-        * @param request
         * @param requestId
         * @param instanceId
         * @param accept
@@ -279,17 +282,17 @@ public class DistributionServlet extends BeGenericServlet {
        //TODO Edit the responses
        @ApiResponses(value = {
                        @ApiResponse(code = 204, message = "ECOMP component is successfully unregistered", response = TopicUnregistrationResponse.class),
-                       @ApiResponse(code = 400, message = "Missing  “X-ECOMP-InstanceID”  HTTP header - POL5001"),
+                       @ApiResponse(code = 400, message = "Missing  'X-ECOMP-InstanceID'  HTTP header - POL5001"),
                        @ApiResponse(code = 400, message = "Missing  Body - POL4500"),
-                       @ApiResponse(code = 400, message = "Invalid  Body  : missing mandatory parameter “apiPublicKey” - POL4501"),
-                       @ApiResponse(code = 400, message = "Invalid  Body  : missing mandatory parameter “distrEnvName” - SVC4506"),
-                       @ApiResponse(code = 400, message = "Invalid Body :  Specified “distrEnvName” doesn’t exist - POL4137"),
+                       @ApiResponse(code = 400, message = "Invalid  Body  : missing mandatory parameter 'apiPublicKey' - POL4501"),
+                       @ApiResponse(code = 400, message = "Invalid  Body  : missing mandatory parameter 'distrEnvName' - SVC4506"),
+                       @ApiResponse(code = 400, message = "Invalid Body :  Specified 'distrEnvName' doesn’t exist - POL4137"),
                        @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 = 405, message = "Method  Not Allowed  :  Invalid HTTP method type used to  register for  distribution ( PUT,DELETE,GET will be rejected) - POL4050"),
                        @ApiResponse(code = 500, message = "The registration failed due to internal SDC problem or Cambria Service failure ECOMP Component  should  continue the attempts to  register for  distribution - POL5000")})
        @ApiImplicitParams({@ApiImplicitParam(required = true, dataType = "org.openecomp.sdc.be.distribution.api.client.RegistrationRequest", paramType = "body", value = "json describe the artifact")})
-       public Response unRegisterForDistribution(@Context final HttpServletRequest request, 
+       public Response unRegisterForDistribution( 
                        @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) String instanceId, 
                        @ApiParam(value = "Determines the format of the body of the response", required = false)@HeaderParam(value = Constants.ACCEPT_HEADER) String accept,