Catalog alignment
[sdc.git] / catalog-be / src / main / java / org / openecomp / sdc / be / servlets / GroupEndpoint.java
index 387faae..dd56b47 100644 (file)
-/*-\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.servlets;\r
-\r
-import java.util.List;\r
-import javax.inject.Inject;\r
-import javax.ws.rs.Consumes;\r
-import javax.ws.rs.GET;\r
-import javax.ws.rs.HeaderParam;\r
-import javax.ws.rs.POST;\r
-import javax.ws.rs.PUT;\r
-import javax.ws.rs.Path;\r
-import javax.ws.rs.PathParam;\r
-import javax.ws.rs.Produces;\r
-import javax.ws.rs.core.MediaType;\r
-import org.openecomp.sdc.be.components.impl.GroupBusinessLogicNew;\r
-import org.openecomp.sdc.be.datatypes.elements.PropertyDataDefinition;\r
-import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;\r
-import org.openecomp.sdc.be.model.GroupProperty;\r
-import org.openecomp.sdc.common.api.Constants;\r
-import org.springframework.stereotype.Controller;\r
-import com.jcabi.aspects.Loggable;\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.media.ArraySchema;\r
-import io.swagger.v3.oas.annotations.media.Content;\r
-import io.swagger.v3.oas.annotations.media.Schema;\r
-import io.swagger.v3.oas.annotations.responses.ApiResponse;\r
-import io.swagger.v3.oas.annotations.responses.ApiResponses;\r
-\r
-/**\r
- * Here new APIs for group will be written in an attempt to gradually clean BL code\r
- */\r
-@Loggable(prepend = true, value = Loggable.DEBUG, trim = false)\r
-@Path("/v1/catalog")\r
-@OpenAPIDefinition(info = @Info(title = "Group Servlet"))\r
-@Controller\r
-@Consumes(MediaType.APPLICATION_JSON)\r
-@Produces(MediaType.APPLICATION_JSON)\r
-public class GroupEndpoint {\r
-\r
-    private final GroupBusinessLogicNew groupBusinessLogic;\r
-\r
-    @Inject\r
-    public GroupEndpoint(GroupBusinessLogicNew groupBusinessLogic) {\r
-        this.groupBusinessLogic = groupBusinessLogic;\r
-    }\r
-\r
-    @POST\r
-    @Path("/{containerComponentType}/{componentId}/groups/{groupUniqueId}/members")\r
-    @Operation(description = "Update group members ", method = "POST",\r
-            summary = "Updates list of members and returns it", responses = @ApiResponse(\r
-                    content = @Content(array = @ArraySchema(schema = @Schema(implementation = String.class)))))\r
-    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Group members updated"), @ApiResponse(\r
-            responseCode = "400",\r
-            description = "field name invalid type/length, characters;  mandatory field is absent, already exists (name)"),\r
-            @ApiResponse(responseCode = "403", description = "Restricted operation"),\r
-            @ApiResponse(responseCode = "404", description = "Component not found"),\r
-            @ApiResponse(responseCode = "500", description = "Internal Error")})\r
-    public List<String> updateGroupMembers(@PathParam("containerComponentType") final String containerComponentType,\r
-            @PathParam("componentId") final String componentId, @PathParam("groupUniqueId") final String groupUniqueId,\r
-            @Parameter(description = "List of members unique ids", required = true) List<String> members,\r
-            @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {\r
-        ComponentTypeEnum componentTypeEnum = ComponentTypeEnum.findByParamName(containerComponentType);\r
-        return groupBusinessLogic.updateMembers(componentId, componentTypeEnum, userId, groupUniqueId, members);\r
-    }\r
-\r
-    @GET\r
-    @Path("/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties")\r
-    @Operation(description = "Get List of properties on a group", method = "GET",\r
-            summary = "Returns list of properties", responses = @ApiResponse(\r
-                    content = @Content(array = @ArraySchema(schema = @Schema(implementation = GroupProperty.class)))))\r
-    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Group Updated"),\r
-            @ApiResponse(responseCode = "403", description = "Restricted operation"),\r
-            @ApiResponse(responseCode = "400", description = "Invalid content / Missing content")})\r
-    public List<PropertyDataDefinition> getGroupProperties(\r
-            @PathParam("containerComponentType") final String containerComponentType,\r
-            @PathParam("componentId") final String componentId, @PathParam("groupUniqueId") final String groupUniqueId,\r
-            @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {\r
-        return groupBusinessLogic.getProperties(containerComponentType, userId, componentId, groupUniqueId);\r
-    }\r
-\r
-    @PUT\r
-    @Path("/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties")\r
-    @Operation(description = "Updates List of properties on a group (only values)", method = "PUT",\r
-            summary = "Returns updated list of properties", responses = @ApiResponse(\r
-                    content = @Content(array = @ArraySchema(schema = @Schema(implementation = GroupProperty.class)))))\r
-    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Group Updated"),\r
-            @ApiResponse(responseCode = "403", description = "Restricted operation"),\r
-            @ApiResponse(responseCode = "400", description = "Invalid content / Missing content")})\r
-    public List<GroupProperty> updateGroupProperties(\r
-            @PathParam("containerComponentType") final String containerComponentType,\r
-            @PathParam("componentId") final String componentId, @PathParam("groupUniqueId") final String groupUniqueId,\r
-            @Parameter(description = "Group Properties to be Updated", required = true) List<GroupProperty> properties,\r
-            @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {\r
-        ComponentTypeEnum componentTypeEnum = ComponentTypeEnum.findByParamName(containerComponentType);\r
-        return groupBusinessLogic.updateProperties(componentId, componentTypeEnum, userId, groupUniqueId, properties);\r
-    }\r
-\r
-}\r
+/*-
+ * ============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.servlets;
+
+import com.jcabi.aspects.Loggable;
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.info.Info;
+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 io.swagger.v3.oas.annotations.responses.ApiResponses;
+import org.openecomp.sdc.be.components.impl.GroupBusinessLogicNew;
+import org.openecomp.sdc.be.components.impl.aaf.AafPermission;
+import org.openecomp.sdc.be.components.impl.aaf.PermissionAllowed;
+import org.openecomp.sdc.be.datatypes.elements.PropertyDataDefinition;
+import org.openecomp.sdc.be.datatypes.enums.ComponentTypeEnum;
+import org.openecomp.sdc.be.impl.ComponentsUtils;
+import org.openecomp.sdc.be.model.GroupProperty;
+import org.openecomp.sdc.be.user.UserBusinessLogic;
+import org.openecomp.sdc.common.api.Constants;
+import org.openecomp.sdc.common.log.elements.LoggerSupportability;
+import org.openecomp.sdc.common.log.enums.LoggerSupportabilityActions;
+import org.openecomp.sdc.common.log.enums.StatusCode;
+import org.springframework.stereotype.Controller;
+
+import javax.inject.Inject;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.GET;
+import javax.ws.rs.HeaderParam;
+import javax.ws.rs.POST;
+import javax.ws.rs.PUT;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+import java.util.List;
+
+/**
+ * Here new APIs for group will be written in an attempt to gradually clean BL code
+ */
+@Loggable(prepend = true, value = Loggable.DEBUG, trim = false)
+@Path("/v1/catalog")
+@OpenAPIDefinition(info = @Info(title = "Group Servlet"))
+@Controller
+@Consumes(MediaType.APPLICATION_JSON)
+@Produces(MediaType.APPLICATION_JSON)
+public class GroupEndpoint extends BeGenericServlet{
+
+    private final GroupBusinessLogicNew groupBusinessLogic;
+    private static final LoggerSupportability loggerSupportability = LoggerSupportability.getLogger(GroupEndpoint.class.getName());
+
+    @Inject
+    public GroupEndpoint(UserBusinessLogic userBusinessLogic,
+                         ComponentsUtils componentsUtils, GroupBusinessLogicNew groupBusinessLogic) {
+        super(userBusinessLogic, componentsUtils);
+        this.groupBusinessLogic = groupBusinessLogic;
+    }
+
+    @POST
+    @Path("/{containerComponentType}/{componentId}/groups/{groupUniqueId}/members")
+    @Operation(description = "Update group members ", method = "POST",
+            summary = "Updates list of members and returns it", responses = @ApiResponse(
+                    content = @Content(array = @ArraySchema(schema = @Schema(implementation = String.class)))))
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Group members updated"), @ApiResponse(
+            responseCode = "400",
+            description = "field name invalid type/length, characters;  mandatory field is absent, already exists (name)"),
+            @ApiResponse(responseCode = "403", description = "Restricted operation"),
+            @ApiResponse(responseCode = "404", description = "Component not found"),
+            @ApiResponse(responseCode = "500", description = "Internal Error")})
+    @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
+    public List<String> updateGroupMembers(@PathParam("containerComponentType") final String containerComponentType,
+            @PathParam("componentId") final String componentId, @PathParam("groupUniqueId") final String groupUniqueId,
+            @Parameter(description = "List of members unique ids", required = true) List<String> members,
+            @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
+        loggerSupportability.log(LoggerSupportabilityActions.UPDATE_GROUP_MEMBERS, StatusCode.STARTED," Starting to update Group Members for component {} " , componentId );
+        ComponentTypeEnum componentTypeEnum = ComponentTypeEnum.findByParamName(containerComponentType);
+        loggerSupportability.log(LoggerSupportabilityActions.UPDATE_GROUP_MEMBERS, StatusCode.COMPLETE," Ended update Group Members for component {} " , componentId );
+        return groupBusinessLogic.updateMembers(componentId, componentTypeEnum, userId, groupUniqueId, members);
+    }
+
+    @GET
+    @Path("/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties")
+    @Operation(description = "Get List of properties on a group", method = "GET",
+            summary = "Returns list of properties", responses = @ApiResponse(
+                    content = @Content(array = @ArraySchema(schema = @Schema(implementation = GroupProperty.class)))))
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Group Updated"),
+            @ApiResponse(responseCode = "403", description = "Restricted operation"),
+            @ApiResponse(responseCode = "400", description = "Invalid content / Missing content")})
+    @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
+    public List<PropertyDataDefinition> getGroupProperties(
+            @PathParam("containerComponentType") final String containerComponentType,
+            @PathParam("componentId") final String componentId, @PathParam("groupUniqueId") final String groupUniqueId,
+            @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
+        return groupBusinessLogic.getProperties(containerComponentType, userId, componentId, groupUniqueId);
+    }
+
+    @PUT
+    @Path("/{containerComponentType}/{componentId}/groups/{groupUniqueId}/properties")
+    @Operation(description = "Updates List of properties on a group (only values)", method = "PUT",
+            summary = "Returns updated list of properties", responses = @ApiResponse(
+                    content = @Content(array = @ArraySchema(schema = @Schema(implementation = GroupProperty.class)))))
+    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Group Updated"),
+            @ApiResponse(responseCode = "403", description = "Restricted operation"),
+            @ApiResponse(responseCode = "400", description = "Invalid content / Missing content")})
+    @PermissionAllowed(AafPermission.PermNames.INTERNAL_ALL_VALUE)
+    public List<GroupProperty> updateGroupProperties(
+            @PathParam("containerComponentType") final String containerComponentType,
+            @PathParam("componentId") final String componentId, @PathParam("groupUniqueId") final String groupUniqueId,
+            @Parameter(description = "Group Properties to be Updated", required = true) List<GroupProperty> properties,
+            @HeaderParam(value = Constants.USER_ID_HEADER) String userId) {
+        ComponentTypeEnum componentTypeEnum = ComponentTypeEnum.findByParamName(containerComponentType);
+        return groupBusinessLogic.updateProperties(componentId, componentTypeEnum, userId, groupUniqueId, properties);
+    }
+
+}