Added logging on endpoints.

Signed-off-by: Dennis Labordus <[email protected]>

Author: Dennis Labordus

app/src/main/java/org/lfenergy/compas/scl/data/rest/v1/CompasCommonResource.java

@@ -17,7 +17,6 @@
 import javax.enterprise.context.RequestScoped;
 import javax.inject.Inject;
 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.MediaType;
@@ -41,8 +40,8 @@ public class CompasCommonResource {
     @GET
     @Path("/type/list")
     @Produces(MediaType.APPLICATION_XML)
-    public Uni<TypeListResponse> list(@HeaderParam("Authorization") String authHeader) {
-        LOGGER.trace("Authorization Header '{}'", authHeader);
+    public Uni<TypeListResponse> list() {
+        LOGGER.info("Retrieving list of the types of SCL Files");
 
         // Retrieve the roles the logged-in user has.
         var roles = jsonWebToken.getGroups();
@@ -61,9 +60,8 @@ public Uni<TypeListResponse> list(@HeaderParam("Authorization") String authHeade
     @GET
     @Path("/userinfo")
     @Produces(MediaType.APPLICATION_XML)
-    public Uni<UserInfoResponse> getUserInfo(@HeaderParam("Authorization") String authHeader) {
-        LOGGER.trace("Authorization Header '{}'", authHeader);
-
+    public Uni<UserInfoResponse> getUserInfo() {
+        LOGGER.info("Retrieving user information about {}", jsonWebToken.getName());
         var response = new UserInfoResponse();
         response.setName(jsonWebToken.getClaim(userInfoProperties.name()));
         response.setSessionWarning(userInfoProperties.sessionWarning());

app/src/main/java/org/lfenergy/compas/scl/data/rest/v1/CompasSclDataResource.java

@@ -49,6 +49,7 @@ public CompasSclDataResource(CompasSclDataService compasSclDataService) {
     @Produces(MediaType.APPLICATION_XML)
     public Uni<CreateResponse> create(@PathParam(TYPE_PATH_PARAM) SclFileType type,
                                       @Valid CreateRequest request) {
+        LOGGER.info("Adding new SCL File for type {} to storage.", type);
         String who = jsonWebToken.getClaim(userInfoProperties.who());
         LOGGER.trace("Username used for Who {}", who);
 
@@ -62,6 +63,7 @@ public Uni<CreateResponse> create(@PathParam(TYPE_PATH_PARAM) SclFileType type,
     @Path("/list")
     @Produces(MediaType.APPLICATION_XML)
     public Uni<ListResponse> list(@PathParam(TYPE_PATH_PARAM) SclFileType type) {
+        LOGGER.info("Listing SCL Files for type {} from storage.", type);
         var response = new ListResponse();
         response.setItems(compasSclDataService.list(type));
         return Uni.createFrom().item(response);
@@ -72,6 +74,7 @@ public Uni<ListResponse> list(@PathParam(TYPE_PATH_PARAM) SclFileType type) {
     @Produces(MediaType.APPLICATION_XML)
     public Uni<VersionsResponse> listVersionsByUUID(@PathParam(TYPE_PATH_PARAM) SclFileType type,
                                                     @PathParam(ID_PATH_PARAM) UUID id) {
+        LOGGER.info("Listing versions of SCL File {} for type {} from storage.", id, type);
         var response = new VersionsResponse();
         response.setItems(compasSclDataService.listVersionsByUUID(type, id));
         return Uni.createFrom().item(response);
@@ -82,6 +85,7 @@ public Uni<VersionsResponse> listVersionsByUUID(@PathParam(TYPE_PATH_PARAM) SclF
     @Produces(MediaType.APPLICATION_XML)
     public Uni<GetResponse> findByUUID(@PathParam(TYPE_PATH_PARAM) SclFileType type,
                                        @PathParam(ID_PATH_PARAM) UUID id) {
+        LOGGER.info("Retrieving latest version of SCL File {} for type {} from storage.", id, type);
         var response = new GetResponse();
         response.setSclData(compasSclDataService.findByUUID(type, id));
         return Uni.createFrom().item(response);
@@ -93,6 +97,7 @@ public Uni<GetResponse> findByUUID(@PathParam(TYPE_PATH_PARAM) SclFileType type,
     public Uni<GetResponse> findByUUIDAndVersion(@PathParam(TYPE_PATH_PARAM) SclFileType type,
                                                  @PathParam(ID_PATH_PARAM) UUID id,
                                                  @PathParam(VERSION_PATH_PARAM) Version version) {
+        LOGGER.info("Retrieving version {} of SCL File {} for type {} from storage.", version, id, type);
         var response = new GetResponse();
         response.setSclData(compasSclDataService.findByUUID(type, id, version));
         return Uni.createFrom().item(response);
@@ -106,6 +111,7 @@ public Uni<GetResponse> findByUUIDAndVersion(@PathParam(TYPE_PATH_PARAM) SclFile
     public Uni<UpdateResponse> update(@PathParam(TYPE_PATH_PARAM) SclFileType type,
                                       @PathParam(ID_PATH_PARAM) UUID id,
                                       @Valid UpdateRequest request) {
+        LOGGER.info("Updating SCL File {} for type {} to storage.", id, type);
         String who = jsonWebToken.getClaim(userInfoProperties.who());
         LOGGER.trace("Username used for Who {}", who);
 
@@ -121,6 +127,7 @@ public Uni<UpdateResponse> update(@PathParam(TYPE_PATH_PARAM) SclFileType type,
     @Produces(MediaType.APPLICATION_XML)
     public Uni<Void> deleteAll(@PathParam(TYPE_PATH_PARAM) SclFileType type,
                                @PathParam(ID_PATH_PARAM) UUID id) {
+        LOGGER.info("Removing all versions of SCL File {} for type {} from storage.", id, type);
         compasSclDataService.delete(type, id);
         return Uni.createFrom().nullItem();
     }
@@ -132,6 +139,7 @@ public Uni<Void> deleteAll(@PathParam(TYPE_PATH_PARAM) SclFileType type,
     public Uni<Void> deleteVersion(@PathParam(TYPE_PATH_PARAM) SclFileType type,
                                    @PathParam(ID_PATH_PARAM) UUID id,
                                    @PathParam(VERSION_PATH_PARAM) Version version) {
+        LOGGER.info("Removing version {} of SCL File {} for type {} from storage.", version, id, type);
         compasSclDataService.delete(type, id, version);
         return Uni.createFrom().nullItem();
     }