Added comment

bcgov · Jul 17, 2023 · d8e9afa · d8e9afa
1 parent b46c9b2
commit d8e9afa
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/api/src/main/java/ca/bc/gov/educ/api/distribution/config/ScheduledTasksConfig.java b/api/src/main/java/ca/bc/gov/educ/api/distribution/config/ScheduledTasksConfig.java
@@ -28,6 +28,9 @@ public ScheduledTasksConfig(@Qualifier("TmpCacheFileVisitor") FileVisitor<Path>
         this.educDistributionApiConstants = educDistributionApiConstants;
     }
 
+    /**
+     * Removes artifacts from the /tmp/Batch directory that are expired
+     */
     @Scheduled(cron = "${scheduler.clean-tmp-cache-cron}")
     public void cleanTmpCacheFiles() {
         Path startingDir = Paths.get(educDistributionApiConstants.getCleanTmpCacheBaseDir());
@@ -38,7 +41,6 @@ public void cleanTmpCacheFiles() {
                 logger.error("ScheduledTasksConfig: There was an error removing file cache: {}", e.getLocalizedMessage());
             }
         }
-
     }