Merge pull request #123 from pwssOrg/114-implement-parallel-retrieval-of-monitored-directories-using-futures

114 implement parallel retrieval of monitored directories using futures

Author: lilstiffy

File-Integrity-Scanner/src/main/java/org/pwss/file_integrity_scanner/component/DirectoryTraverser.java

@@ -2,11 +2,13 @@
 
 import org.pwss.io_file.FileTraverserImpl;
 import org.pwss.util.PWSSDirectoryNavUtil;
+import org.springframework.scheduling.annotation.Async;
 import org.springframework.stereotype.Component;
 
 import java.io.File;
 import java.util.List;
 import java.util.Optional;
+import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Future;
 
@@ -17,45 +19,43 @@
 @Component
 public class DirectoryTraverser {
 
+    private final org.slf4j.Logger log;
+
+    public DirectoryTraverser() {
+        this.log = org.slf4j.LoggerFactory.getLogger(DirectoryTraverser.class);
+    }
+
     /**
-     * Scans a directory and retrieves a list of all files within it.
+     * Collects all files in a directory asynchronously.
+     * <p>
+     * This method uses a `FileTraverserImpl` instance to traverse the specified directory
+     * and retrieve a list of files. The traversal is performed asynchronously, and the
+     * result is returned as a `Future`.
      *
      * @param directoryPath the path of the directory to scan
-     * @return a list of files found in the directory
-     * @throws ExecutionException   if an error occurs during the asynchronous file
-     *                              traversal
-     * @throws InterruptedException if the thread executing the file traversal is
-     *                              interrupted
+     * @return a Future containing the list of files found in the directory
      */
-    public final List<File> collectFilesInDirectory(String directoryPath)
-            throws ExecutionException, InterruptedException {
+    @Async
+    public Future<List<File>> collectFilesInDirectory(String directoryPath) {
+        log.info("Starting asynchronous traversal scan for directory: {}", directoryPath);
         FileTraverserImpl traverser = new FileTraverserImpl();
-        Future<List<File>> future = traverser.traverse(directoryPath);
-
-        List<File> files = future.get();
-
-        traverser.shutdownThreadPool();
-
-        return files;
+        return traverser.traverse(directoryPath);
     }
 
     /**
-     * Collects all top-level files from the specified directory, excluding any
-     * files in subdirectories.
+     * Collects the top-level files in a directory asynchronously.
+     * <p>
+     * This method retrieves the files located directly in the specified directory
+     * without traversing its subdirectories. The operation is performed asynchronously,
+     * and the result is returned as a `Future`.
      *
-     * @param directoryPath the path of the directory to scan for top-level files
-     * @return an Optional containing a list of top-level files found in the
-     *         directory,
-     *         or empty if no files are found
-     * @throws ExecutionException   if an error occurs during the asynchronous file
-     *                              traversal
-     * @throws InterruptedException if the thread executing the file traversal is
-     *                              interrupted
+     * @param directoryPath the directory to scan for top-level files
+     * @return a Future containing the list of top-level files in the directory
      */
-    public final Optional<List<File>> collectTopLevelFiles(File directoryPath)
-            throws ExecutionException, InterruptedException {
-
-        return Optional.of(PWSSDirectoryNavUtil.GetSelectedFolderWithoutSubFolders(directoryPath));
+    @Async
+    public Future<List<File>> collectTopLevelFiles(File directoryPath) {
+        log.info("Starting asynchronous scan for top-level files in directory: {}", directoryPath);
+        List<File> files = PWSSDirectoryNavUtil.GetSelectedFolderWithoutSubFolders(directoryPath);
+        return CompletableFuture.completedFuture(files);
     }
-
 }

File-Integrity-Scanner/src/main/java/org/pwss/file_integrity_scanner/component/FileHashComputer.java

@@ -24,7 +24,7 @@ public FileHashComputer() {
      * @param file the file for which hashes need to be computed
      * @return an object containing the computed hashes for the file
      */
-    public final HashForFilesOutput computeHashes(File file) {
+    public HashForFilesOutput computeHashes(File file) {
         return fileHashHandler.GetAllHashes(file);
     }
 }

File-Integrity-Scanner/src/main/java/org/pwss/file_integrity_scanner/config/AppConfig.java

@@ -9,9 +9,11 @@
 import org.springframework.context.annotation.Primary;
 import org.springframework.scheduling.annotation.AsyncConfigurer;
 import org.springframework.scheduling.annotation.EnableAsync;
+import org.springframework.scheduling.annotation.EnableScheduling;
 import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
 
 @EnableAsync
+@EnableScheduling
 @Configuration
 public class AppConfig implements AsyncConfigurer {
 

File-Integrity-Scanner/src/main/java/org/pwss/file_integrity_scanner/msr/domain/model/entities/monitored_directory/MonitoredDirectory.java

@@ -30,6 +30,9 @@ public class MonitoredDirectory {
     @Column(name = "baseline_established", nullable = false)
     private Boolean baselineEstablished = false;
 
+    @Column(name = "include_subdirectories", nullable = false)
+    private Boolean includeSubdirectories = true;
+
     // Getters and setters
 
     public Integer getId() {
@@ -87,4 +90,12 @@ public Boolean getBaselineEstablished() {
     public void setBaselineEstablished(Boolean baselineEstablished) {
         this.baselineEstablished = baselineEstablished;
     }
+
+    public Boolean getIncludeSubdirectories() {
+        return includeSubdirectories;
+    }
+
+    public void setIncludeSubdirectories(Boolean includeSubdirectories) {
+        this.includeSubdirectories = includeSubdirectories;
+    }
 }

File-Integrity-Scanner/src/main/java/org/pwss/file_integrity_scanner/msr/service/monitored_directory/MonitoredDirectoryService.java

@@ -17,7 +17,7 @@ public interface MonitoredDirectoryService {
      *
      * @param isActive true to find active directories, false to find inactive ones
      * @return a list of monitored directories matching the specified active status,
-     *         or null if no matches are found or an error occurs
+     * or null if no matches are found or an error occurs
      */
     List<MonitoredDirectory> findByIsActive(boolean isActive);
 
@@ -32,7 +32,7 @@ public interface MonitoredDirectoryService {
 
     /**
      * Persists a monitored directory entity in the database.
-     *
+     * <p>
      * This method saves or updates the provided {@code MonitoredDirectory}
      * entity, ensuring its state is recorded persistently. It handles all
      * necessary operations to make the entity available for future queries.

File-Integrity-Scanner/src/main/java/org/pwss/file_integrity_scanner/msr/service/monitored_directory/MonitoredDirectoryServiceImpl.java

@@ -36,7 +36,7 @@ public List<MonitoredDirectory> findByIsActive(boolean isActive) {
 
     @Override
     public void save(MonitoredDirectory mDirectory) {
-      this.repository.save(mDirectory);
+        this.repository.save(mDirectory);
     }
 
     @Override

File-Integrity-Scanner/src/main/java/org/pwss/file_integrity_scanner/msr/service/scan/ScanService.java

@@ -1,6 +1,6 @@
 package org.pwss.file_integrity_scanner.msr.service.scan;
 
-import org.pwss.file_integrity_scanner.msr.domain.model.entities.scan.Scan;
+import org.pwss.file_integrity_scanner.msr.domain.model.entities.monitored_directory.MonitoredDirectory;
 
 /**
  * Service interface for managing directory scans.
@@ -17,26 +17,14 @@ public interface ScanService {
     void scanAllDirectories();
 
     /**
-     * Scans a monitored directory using the provided scan instance.
+     * Initiates scanning of a single monitored directory.
+     * <p>
+     * This method starts the scanning process for the specified monitored directory.
+     * It ensures that only the provided directory is scanned, rather than all monitored directories.
      *
-     * This method is an overloaded variant that calls the two-parameter method with
-     * default value set to true for
-     * includeSubFolders.
-     *
-     * @param scanInstance the scan instance used for scanning the directory
-     * @return true if the monitored directory scan is successful, false otherwise
-     */
-    Boolean scanMonitoredDirectory(Scan scanInstance);
-
-    /**
-     * Scans a monitored directory using the provided scan instance.
-     *
-     * @param scanInstance      the scan instance used for scanning the directory
-     * @param includeSubFolders whether to include subfolders in the scan (default
-     *                          is false)
-     * @return true if the monitored directory scan is successful, false otherwise
+     * @param monitoredDirectory the monitored directory to be scanned
      */
-    Boolean scanMonitoredDirectory(Scan scanInstance, boolean includeSubFolders);
+    void scanSingleDirectory(MonitoredDirectory monitoredDirectory);
 
     /**
      * Stops any ongoing scans.