Improvements to Javadocumentation and Database Deserialization

pom.xml

@@ -125,7 +125,7 @@
         <dependency>
             <groupId>de.rub.nds</groupId>
             <artifactId>scanner-core</artifactId>
-            <version>5.5.0</version>
+            <version>6.2.0</version>
         </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>
@@ -135,6 +135,14 @@
             <groupId>org.apache.logging.log4j</groupId>
             <artifactId>log4j-api</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-core</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-slf4j-impl</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.eclipse.persistence</groupId>
             <artifactId>jakarta.persistence</artifactId>
@@ -182,8 +190,7 @@
                         <configuration>
                             <filesets>
                                 <fileset>
-                                    <!--suppress UnresolvedMavenProperty -->
-                                    <directory>${maven.multiModuleProjectDirectory}/apps</directory>
+                                    <directory>${project.basedir}/apps</directory>
                                 </fileset>
                             </filesets>
                         </configuration>
@@ -198,8 +205,7 @@
                             <excludeDefaultDirectories>true</excludeDefaultDirectories>
                             <filesets>
                                 <fileset>
-                                    <!--suppress UnresolvedMavenProperty -->
-                                    <directory>${maven.multiModuleProjectDirectory}/apps</directory>
+                                    <directory>${project.basedir}/apps</directory>
                                 </fileset>
                             </filesets>
                         </configuration>

src/main/java/de/rub/nds/crawler/CommonMain.java

@@ -18,9 +18,50 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
+/**
+ * Main entry point for the TLS-Crawler application.
+ *
+ * <p>This class provides the command-line interface for running the TLS-Crawler in two modes:
+ *
+ * <ul>
+ *   <li><strong>Controller</strong> - Orchestrates scan jobs and manages the scanning workflow
+ *   <li><strong>Worker</strong> - Executes individual scan tasks assigned by the controller
+ * </ul>
+ *
+ * <p>The application uses RabbitMQ for communication between controllers and workers, and MongoDB
+ * for persistence of scan results and job status.
+ *
+ * <p>Usage examples:
+ *
+ * <pre>
+ * java -jar crawler-core.jar controller --config controller.properties
+ * java -jar crawler-core.jar worker --config worker.properties
+ * </pre>
+ *
+ * @see Controller
+ * @see Worker
+ * @see ControllerCommandConfig
+ * @see WorkerCommandConfig
+ */
 public class CommonMain {
     private static final Logger LOGGER = LogManager.getLogger();
 
+    /** Private constructor to prevent instantiation of utility class. */
+    private CommonMain() {
+        // Utility class should not be instantiated
+    }
+
+    /**
+     * Main entry point for the TLS-Crawler application.
+     *
+     * <p>Parses command line arguments to determine whether to run as a controller or worker,
+     * initializes the appropriate configuration and dependencies, and starts the selected mode.
+     *
+     * @param args command line arguments including the mode ("controller" or "worker") and
+     *     configuration parameters
+     * @param controllerCommandConfig configuration for controller mode
+     * @param workerCommandConfig configuration for worker mode
+     */
     public static void main(
             String[] args,
             ControllerCommandConfig controllerCommandConfig,
@@ -71,6 +112,15 @@ public static void main(
         }
     }
 
+    /**
+     * Convenience method for running the application with only controller configuration.
+     *
+     * <p>Creates a default worker configuration and delegates to the main method. This is useful
+     * when only controller functionality is needed.
+     *
+     * @param args command line arguments
+     * @param controllerConfig configuration for controller mode
+     */
     public static void main(String[] args, ControllerCommandConfig controllerConfig) {
         main(args, controllerConfig, new WorkerCommandConfig());
     }