V1.1.0: Custom logger option added + vulnerability fix

Author: Dev-Bjorn

README.md

@@ -17,7 +17,7 @@ Add this to your `pom.xml`.
 <dependency>
     <groupId>nl.devoxist</groupId>
     <artifactId>module-scheduler</artifactId>
-    <version>1.0.0</version>
+    <version>1.1.0</version>
 </dependency>
 ```
 
@@ -122,6 +122,27 @@ order `ModuleScheduler#beforeModuleExecute` -> `Module#onExecute` -> `ModuleSche
 new Scheduler(new ModuleSchedulerProcess());
 ```
 
+#### Module Scheduler Settings
+
+#### Modules
+
+The modules which are going to be loaded can be added through the `ModuleSchedulerSettings#addModule` method. The
+modules can be added through their class path or their `Class`. 
+
+#### Input Registers
+
+The registers that are used in to construct the modules. These modules need to have a constructor with the parameters
+types registered in the input registries and/or can be the modules that are loaded. These registries can be registered
+through the `ModuleSchedulerSettings#addRegisters` method. Note: The modules that are getting loaded do not have to be
+registered in the input registers.
+
+#### Output Register
+
+This is a register that contains the constructed modules that are loaded inside the loading process.
+
+#### Logger
+
+This is the logger of the process that is going to be used to output the messages of process.
 
 ### Contributors
 

pom.xml

@@ -29,7 +29,7 @@
     <groupId>nl.devoxist</groupId>
     <artifactId>module-scheduler</artifactId>
     <packaging>jar</packaging>
-    <version>1.0.0</version>
+    <version>1.1.0</version>
 
     <name>Module Scheduler</name>
     <description>An API to order tasks in the correct order</description>

src/main/java/nl/devoxist/modulescheduler/Scheduler.java

@@ -89,16 +89,20 @@ public Scheduler(ModuleScheduler moduleScheduler) {
      * @since 1.0.0
      */
     private void run() {
-        this.moduleScheduler.updateSettings(this.moduleSchedulerSettings);
+        try {
+            this.moduleScheduler.updateSettings(this.moduleSchedulerSettings);
 
-        Set<Class<? extends Module>> modules = this.moduleSchedulerSettings.getModules();
-        Map<Class<? extends Module>, ModuleInformation<?>>
-                moduleInformationSet = DependencyResolver.resolveDependencies(modules);
+            Set<Class<? extends Module>> modules = this.moduleSchedulerSettings.getModules();
+            Map<Class<? extends Module>, ModuleInformation<?>>
+                    moduleInformationSet = DependencyResolver.resolveDependencies(modules);
 
-        this.moduleSchedulerInformation.setModuleInformationMap(moduleInformationSet);
-        Set<Stage> stages = Staging.stageModules(this.moduleSchedulerInformation);
+            this.moduleSchedulerInformation.setModuleInformationMap(moduleInformationSet);
 
-        StageRunner.runStages(this.moduleSchedulerSettings, this.moduleScheduler, stages);
+            Set<Stage> stages = Staging.stageModules(this.moduleSchedulerInformation);
+
+            StageRunner.runStages(this.moduleSchedulerSettings, this.moduleScheduler, stages);
+        } catch (InterruptedException ignored) {
+        }
     }
 
 }

src/main/java/nl/devoxist/modulescheduler/console/Formatter.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2023 Devoxist, Dev-Bjorn
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package nl.devoxist.modulescheduler.console;
+
+import java.util.logging.LogRecord;
+
+/**
+ * {@link Formatter} is used for the formatting of the logging in the console and is a subclass of
+ * {@link java.util.logging.Formatter}.
+ *
+ * @author Dev-Bjorn
+ * @version 1.0.0
+ * @see Formatter
+ * @since 1.1.0
+ */
+public class Formatter extends java.util.logging.Formatter {
+    
+    /**
+     * Format the given log record and return the formatted string.
+     * <p>
+     * The resulting formatted String will normally include a
+     * localized and formatted version of the LogRecord's message field.
+     * It is recommended to use the {@link Formatter#formatMessage}
+     * convenience method to localize and format the message field.
+     *
+     * @param record the log record to be formatted.
+     *
+     * @return the formatted log record
+     *
+     * @since 1.1.0
+     */
+    @Override
+    public String format(LogRecord record) {
+        return record.getMessage() + Console.NEWLINE;
+    }
+}

src/main/java/nl/devoxist/modulescheduler/path/PathCyclePrinter.java

@@ -22,17 +22,21 @@
 
 package nl.devoxist.modulescheduler.path;
 
+import nl.devoxist.modulescheduler.ModuleScheduler;
 import nl.devoxist.modulescheduler.console.Console;
+import nl.devoxist.modulescheduler.settings.ModuleSchedulerInformation;
 
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
 /**
  * The process of path resolver and printing of the {@link Path}. This is meant to be for to showcase the cycle
  * dependencies.
  *
  * @author Dev-Bjorn
- * @version 1.0.0
+ * @version 1.1.0
  * @since 1.0.0
  */
 public class PathCyclePrinter extends Thread {
@@ -42,6 +46,12 @@ public class PathCyclePrinter extends Thread {
      * @since 1.0.0
      */
     private final Path firstPath;
+    /**
+     * The information of the current running {@link ModuleScheduler}
+     *
+     * @since 1.1.0
+     */
+    private final ModuleSchedulerInformation moduleSchedulerInformation;
     /**
      * The current path of the resolver.
      *
@@ -64,11 +74,13 @@ public class PathCyclePrinter extends Thread {
     /**
      * Construct a {@link PathCyclePrinter} object that is responsible for the printing of a path cycle.
      *
-     * @param path The path that needs to be printed.
+     * @param moduleSchedulerInformation The information of the current running {@link ModuleScheduler}
+     * @param path                       The path that needs to be printed.
      *
      * @since 1.0.0
      */
-    PathCyclePrinter(Path path) {
+    PathCyclePrinter(ModuleSchedulerInformation moduleSchedulerInformation, Path path) {
+        this.moduleSchedulerInformation = moduleSchedulerInformation;
         this.path = path;
         this.firstPath = path;
 
@@ -78,12 +90,13 @@ public class PathCyclePrinter extends Thread {
     /**
      * Construct and print the cycle of {@link Path}.
      *
-     * @param path The path that needs to be printed.
+     * @param moduleSchedulerInformation The information of the current running {@link ModuleScheduler}
+     * @param path                       The path that needs to be printed.
      *
      * @since 1.0.0
      */
-    public static void printPath(Path path) {
-        PathCyclePrinter builder = new PathCyclePrinter(path);
+    public static void printPath(ModuleSchedulerInformation moduleSchedulerInformation, Path path) {
+        PathCyclePrinter builder = new PathCyclePrinter(moduleSchedulerInformation, path);
         builder.start();
         builder.print();
     }
@@ -98,8 +111,7 @@ public static void printPath(Path path) {
     public void run() {
         StringBuilder builder = new StringBuilder();
 
-        builder.append(Console.NEWLINE)
-                .append("[WARN] Dependency cycle detected: ");
+        builder.append("[WARN] Dependency cycle detected: ");
 
         while (path.hasPreviousPath()) {
             builder.append(Console.NEWLINE).append("[WARN]    -> %s".formatted(path.getCls().getName()));
@@ -130,7 +142,9 @@ public void print() {
         } catch (InterruptedException | ExecutionException ignored) {
             return;
         }
-        this.completableFuture.thenRun(() -> System.out.println(value)).thenRun(() -> System.exit(0));
+
+        Logger logger = this.moduleSchedulerInformation.getModuleSchedulerSettings().getLogger();
+        this.completableFuture.thenRun(() -> logger.log(Level.WARNING, value));
     }
 
 }

src/main/java/nl/devoxist/modulescheduler/settings/ModuleSchedulerSettings.java

@@ -23,10 +23,14 @@
 package nl.devoxist.modulescheduler.settings;
 
 import nl.devoxist.modulescheduler.Module;
+import nl.devoxist.modulescheduler.ModuleScheduler;
+import nl.devoxist.modulescheduler.console.Formatter;
 import nl.devoxist.modulescheduler.exception.ModuleException;
 import nl.devoxist.typeresolver.register.Register;
 
 import java.util.*;
+import java.util.logging.ConsoleHandler;
+import java.util.logging.Logger;
 
 /**
  * This object gives the options to manipulate the process.
@@ -55,6 +59,25 @@ public class ModuleSchedulerSettings {
      * @since 1.0.0
      */
     private Register outputRegister = new Register();
+    /**
+     * The {@link Logger} of the current running {@link ModuleScheduler}.
+     *
+     * @see Logger
+     * @since 1.1.0
+     */
+    private Logger logger;
+
+    {
+        logger = Logger.getAnonymousLogger();
+
+        logger.setUseParentHandlers(false);
+
+        ConsoleHandler consoleHandler = new ConsoleHandler();
+        consoleHandler.setFormatter(new Formatter());
+
+        logger.addHandler(consoleHandler);
+
+    }
 
     /**
      * Add a {@link Module} to the load process. If the module is added to the process it will be used to order the
@@ -76,7 +99,7 @@ public void addModule(Class<? extends Module> moduleCls) {
      *                   class and where that class has been implemented with {@link Module}.
      *
      * @throws ClassNotFoundException If the class was not found
-     * @throws ModuleException        If the class, that is retrieved of the path, is not extended with {@link Module}.
+     * @throws ModuleException        If the class, that is retrieved by its path, is not extended with {@link Module}.
      * @since 1.0.0
      */
     public void addModule(String modulePath) throws ClassNotFoundException {
@@ -94,7 +117,7 @@ public void addModule(String modulePath) throws ClassNotFoundException {
     /**
      * Get the {@link Module}s that needs to in the load process.
      *
-     * @return The {@link Module}s that needs to be in the load process.
+     * @return An unmodifiable {@link Set} of the {@link Module}s that needs to be in the load process.
      *
      * @since 1.0.0
      */
@@ -107,6 +130,7 @@ public Set<Class<? extends Module>> getModules() {
      *
      * @param registers The registers that will be added to the {@link Set} of {@link Register}s.
      *
+     * @see Register
      * @since 1.0.0
      */
     public void addRegisters(Register... registers) {
@@ -116,8 +140,9 @@ public void addRegisters(Register... registers) {
     /**
      * Get the {@link Set} of registries that are used to construct the {@link Module}.
      *
-     * @return The {@link Set} of registries that are used to construct the {@link Module}.
+     * @return An unmodifiable {@link Set} of registries that are used to construct the {@link Module}.
      *
+     * @see Register
      * @since 1.0.0
      */
     public Set<Register> getRegistries() {
@@ -130,6 +155,7 @@ public Set<Register> getRegistries() {
      *
      * @param outputRegister The output registry of the modules that are getting loaded.
      *
+     * @see Register
      * @since 1.0.0
      */
     public void setOutputRegister(Register outputRegister) {
@@ -140,14 +166,39 @@ public void setOutputRegister(Register outputRegister) {
      * Get the output registery of the module scheduler. This will contain all the loaded modules after the
      * modules are loaded.
      *
-     * @return The output registery of the module scheduler.
+     * @return The cloned output registery of the module scheduler.
      *
+     * @see Register
      * @since 1.0.0
      */
     public Register getOutputRegister() {
         return this.outputRegister.clone();
     }
 
+    /**
+     * Set the {@link Logger} of the current running {@link ModuleScheduler}.
+     *
+     * @param logger The {@link Logger} of the current running {@link ModuleScheduler}
+     *
+     * @see Logger
+     * @since 1.1.0
+     */
+    public void setLogger(Logger logger) {
+        this.logger = logger;
+    }
+
+    /**
+     * Get the {@link Logger} of the current running {@link ModuleScheduler}.
+     *
+     * @return The {@link Logger} of the current running {@link ModuleScheduler}
+     *
+     * @see Logger
+     * @since 1.1.0
+     */
+    public Logger getLogger() {
+        return logger;
+    }
+
     /**
      * Creates and returns a copy of this object.  The precise meaning
      * of "copy" may depend on the class of the object. The general