External tools

.gitignore

@@ -33,4 +33,6 @@ build/
 ### VS Code ###
 .vscode/
 
+
+/storage/*
 docker-dev-volumes

pom.xml

@@ -53,6 +53,24 @@
 			<artifactId>spring-boot-starter-test</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<!-- Spring Cache -->
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-cache</artifactId>
+		</dependency>
+		<!-- ehcache -->
+		<dependency>
+			<groupId>org.ehcache</groupId>
+			<artifactId>ehcache</artifactId>
+    		<classifier>jakarta</classifier>
+			<exclusions>
+				<exclusion>
+					<groupId>org.ehcache</groupId>
+					<artifactId>ehcache</artifactId>
+				</exclusion>
+			</exclusions>
+		</dependency>
+
 
 
 		<!-- Spring OPenAPI-->

src/main/java/org/dataverse/marketplace/config/cache/CacheConfig.java

@@ -0,0 +1,10 @@
+package org.dataverse.marketplace.config.cache;
+
+import org.springframework.cache.annotation.EnableCaching;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@EnableCaching
+public class CacheConfig {
+
+}

src/main/java/org/dataverse/marketplace/config/cache/CacheEventLogger.java

@@ -0,0 +1,18 @@
+package org.dataverse.marketplace.config.cache;
+
+import org.ehcache.event.CacheEvent;
+import org.ehcache.event.CacheEventListener;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class CacheEventLogger implements CacheEventListener<Object, Object> {
+
+    Logger logger = LoggerFactory.getLogger(CacheEventLogger.class);
+
+    @Override
+    public void onEvent(
+      CacheEvent<? extends Object, ? extends Object> cacheEvent) {
+        logger.info(cacheEvent.getType().toString(),
+          cacheEvent.getKey(), cacheEvent.getOldValue(), cacheEvent.getNewValue());
+    }
+}

src/main/java/org/dataverse/marketplace/controller/api/AuthController.java

@@ -54,15 +54,16 @@ public ResponseEntity<?> authenticateUser(@Valid @RequestBody LoginRequest login
                         loginRequest.getPassword()));
 
         SecurityContextHolder.getContext().setAuthentication(authentication);
-
         String jwt = jwtUtils.generateJwtToken(authentication);
-
         UserDetailsImpl userDetails = (UserDetailsImpl) authentication.getPrincipal();
-        List<String> roles = userDetails.getAuthorities().stream().map(item -> item.getAuthority())
-                .collect(Collectors.toList());
+
+        List<String> roles = userDetails
+                            .getAuthorities()
+                            .stream()
+                            .map(item -> item.getAuthority())
+                            .collect(Collectors.toList());
 
-        return ResponseEntity
-                .ok(new JwtResponse(jwt,
+        return ResponseEntity.ok(new JwtResponse(jwt,
                         userDetails.getId(),
                         userDetails.getUsername(),
                         userDetails.getEmail(),
@@ -108,7 +109,7 @@ public ResponseEntity<?> registerUser(@Valid @RequestBody SignupRequest signUpRe
 
     @PreAuthorize(ApplicationRoles.ADMIN_ROLE)
     @PostMapping("/roles")
-    @AuthAPIDocs.RoleCreationRequest
+    @AuthAPIDocs.RoleCreationRequestDoc
     public ResponseEntity<?> createRole(@Valid @RequestBody RoleCreationRequest roleCreationRequest) {
 
         if(roleRepository.existsByName(roleCreationRequest.getRoleName().toUpperCase())) {

src/main/java/org/dataverse/marketplace/controller/api/ExternalToolController.java

@@ -0,0 +1,195 @@
+package org.dataverse.marketplace.controller.api;
+
+import jakarta.validation.Valid;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+import org.dataverse.marketplace.model.*;
+import org.dataverse.marketplace.openapi.annotations.ExternalToolsAPIDocs;
+import org.dataverse.marketplace.payload.*;
+import org.dataverse.marketplace.security.ApplicationRoles;
+import org.dataverse.marketplace.service.ExternalToolService;
+import org.dataverse.marketplace.service.ResourceStorageService;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.*;
+import org.springframework.security.access.prepost.PreAuthorize;
+import org.springframework.web.bind.annotation.*;
+import org.springframework.web.multipart.MultipartFile;
+
+
+@RestController
+@RequestMapping("/api/tools")
+public class ExternalToolController {
+
+    @Autowired
+    private ExternalToolService externalToolService;
+
+    @Autowired
+    private ResourceStorageService resourceStorageService;
+
+    /**
+     * Method to retrieve all external tools     
+     */
+    @GetMapping()
+    @ExternalToolsAPIDocs.ExternalToolsListDoc
+    public ResponseEntity<?> getAllTools() {
+
+        return ResponseEntity.ok(externalToolService.getAllTools());
+    }
+
+    /**
+     * Method to add a new external tool
+     */
+    @PreAuthorize(ApplicationRoles.ADMIN_ROLE)
+    @PostMapping(consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
+    @ExternalToolsAPIDocs.AddExternalToolsRequestDoc
+    public ResponseEntity<?> addNewTool(@Valid AddToolRequest addToolRequest) {
+
+        try {
+            return ResponseEntity.ok(externalToolService.addTool(addToolRequest));
+        } catch (IOException e) {
+            ServerMessageResponse messageResponse 
+                = new ServerMessageResponse(HttpStatus.INTERNAL_SERVER_ERROR,
+                                            "Error adding tool",
+                                            e.getMessage());
+            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(messageResponse);
+        }
+    }
+
+    /**
+     * Method to retrieve all external tools     
+     */
+    @GetMapping("/{toolId}")
+    @ExternalToolsAPIDocs.GetExternalToolByIdDoc
+    public ResponseEntity<?> getToolById(@PathVariable("toolId") Integer toolId) {
+
+        ExternalTool tool = externalToolService.getToolById(toolId);
+        return ResponseEntity.ok(new ExternalToolDTO(tool));
+    }
+
+    @PreAuthorize(ApplicationRoles.ADMIN_ROLE)
+    @PutMapping("/{toolId}")
+    @ExternalToolsAPIDocs.UpdateExternalToolDoc
+    public ResponseEntity<?> updateTool(@PathVariable("toolId") Integer toolId, @Valid UpdateToolRequest updateToolRequest) {
+
+        ExternalTool tool = externalToolService.getToolById(toolId);
+
+        if(tool == null){
+            ServerMessageResponse messageResponse = new ServerMessageResponse(HttpStatus.NOT_FOUND,
+                    "Resource not found",
+                    String.format("The requested external tool with ID %d was not found.", toolId));
+            return ResponseEntity.status(HttpStatus.NOT_FOUND).body(messageResponse);
+        }
+
+        try {
+            ServerMessageResponse messageResponse = new ServerMessageResponse(HttpStatus.OK,
+                    "Tool updated",
+                    String.format("The tool with ID %d was updated.", toolId));
+            externalToolService.updateTool(tool, updateToolRequest);
+            return ResponseEntity.ok(messageResponse);
+        } catch (Exception e) {
+            ServerMessageResponse messageResponse 
+                = new ServerMessageResponse(HttpStatus.INTERNAL_SERVER_ERROR,
+                                            "Error updating tool",
+                                            e.getMessage());
+            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(messageResponse);
+        }
+    }
+
+
+    /**
+     * Method to retrieve the images of an external tool.
+     */
+    @GetMapping("/{toolId}/images")
+    @ExternalToolsAPIDocs.GetToolImagesDoc
+    public ResponseEntity<?> getToolImages(@PathVariable("toolId") Integer toolId) {
+
+        ExternalTool tool = externalToolService.getToolById(toolId);
+
+        if(tool == null){
+            ServerMessageResponse messageResponse = new ServerMessageResponse(HttpStatus.NOT_FOUND,
+                    "Resource not found",
+                    String.format("The requested external tool with ID %d was not found.", toolId));
+            return ResponseEntity.status(HttpStatus.NOT_FOUND).body(messageResponse);
+        }
+
+        List<MarketplaceItemImageDTO> imagesResourceId = new ArrayList<>();
+        for (MarketplaceItemImage image : tool.getImages()) {
+            imagesResourceId.add(new MarketplaceItemImageDTO(image));
+        }
+
+        return ResponseEntity.ok(imagesResourceId);
+    }
+
+    /**
+     * Method to add images to an external tool.
+     */
+    @PreAuthorize(ApplicationRoles.ADMIN_ROLE)
+    @PostMapping(path = "/{toolId}/images", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
+    @ExternalToolsAPIDocs.AddToolImagesDoc
+    public ResponseEntity<?> addToolImages(
+            @PathVariable("toolId") Integer toolId, 
+            @RequestBody List<MultipartFile> images) throws IOException {
+
+        ExternalTool tool = externalToolService.getToolById(toolId);
+
+        if(tool == null){
+            ServerMessageResponse messageResponse = new ServerMessageResponse(HttpStatus.NOT_FOUND,
+                    "Resource not found",
+                    String.format("The requested external tool with ID %d was not found.", toolId));
+            return ResponseEntity.status(HttpStatus.NOT_FOUND).body(messageResponse);
+        }
+
+        externalToolService.addItemImages(tool, images);
+
+        ServerMessageResponse messageResponse = new ServerMessageResponse(HttpStatus.OK,
+                "Images added",
+                String.format("The images were added to the tool with ID %d.", toolId));    
+
+        return ResponseEntity.ok(messageResponse);
+    }
+
+    /**
+     * Method to delete an image from an external tool.
+     */
+    @PreAuthorize(ApplicationRoles.ADMIN_ROLE)
+    @DeleteMapping("/{toolId}/images/{imageId}")
+    @ExternalToolsAPIDocs.DeleteToolImageDoc
+    public ResponseEntity<?> deleteToolImage(
+            @PathVariable("toolId") Integer toolId, 
+            @PathVariable("imageId") Integer imageId) {
+
+        MarketplaceItemImage image =  externalToolService.getItemImage(imageId, toolId);
+
+        if(image == null){
+            ServerMessageResponse messageResponse = new ServerMessageResponse(HttpStatus.NOT_FOUND,
+                    "Resource not found",
+                    String.format("The requested image with ID %d was not found.", imageId));
+            return ResponseEntity.status(HttpStatus.NOT_FOUND).body(messageResponse);
+        }
+
+        try {
+
+            resourceStorageService.deleteResourceContent(image.getImageStoredResourceId()); 
+            externalToolService.deleteToolImage(image);
+            return ResponseEntity.ok(new ServerMessageResponse(HttpStatus.OK,
+                    "Image deleted",
+                    String.format("The image with ID %d was deleted.", imageId)));
+
+        } catch (IOException e) {
+
+            ServerMessageResponse messageResponse = new ServerMessageResponse(HttpStatus.INTERNAL_SERVER_ERROR,
+                    "Error deleting image",
+                    e.getMessage());
+            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(messageResponse);
+        }
+    }
+
+
+
+
+
+
+}