From 629b1d9c61fe16f288d5d1d49b5272ca37732903 Mon Sep 17 00:00:00 2001 From: Robert Merget Date: Thu, 19 Jun 2025 10:54:23 +0000 Subject: [PATCH 1/3] Add Javadoc to DoneNotificationConsumer.consumeDoneNotification() --- .../nds/crawler/orchestration/DoneNotificationConsumer.java | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/main/java/de/rub/nds/crawler/orchestration/DoneNotificationConsumer.java b/src/main/java/de/rub/nds/crawler/orchestration/DoneNotificationConsumer.java index 9af1769..e4c4c1f 100644 --- a/src/main/java/de/rub/nds/crawler/orchestration/DoneNotificationConsumer.java +++ b/src/main/java/de/rub/nds/crawler/orchestration/DoneNotificationConsumer.java @@ -13,5 +13,11 @@ @FunctionalInterface public interface DoneNotificationConsumer { + /** + * Consumes a notification that a scan job has been completed. + * + * @param consumerTag The tag identifying the consumer + * @param scanJobDescription The completed scan job description + */ void consumeDoneNotification(String consumerTag, ScanJobDescription scanJobDescription); } From 81e9a5c8ca201f409a622d41957617c949c6e4f6 Mon Sep 17 00:00:00 2001 From: Robert Merget Date: Thu, 19 Jun 2025 10:55:02 +0000 Subject: [PATCH 2/3] Add Javadoc to ScanJobConsumer.consumeScanJob() --- .../de/rub/nds/crawler/orchestration/ScanJobConsumer.java | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/main/java/de/rub/nds/crawler/orchestration/ScanJobConsumer.java b/src/main/java/de/rub/nds/crawler/orchestration/ScanJobConsumer.java index 628b0ee..32adedb 100644 --- a/src/main/java/de/rub/nds/crawler/orchestration/ScanJobConsumer.java +++ b/src/main/java/de/rub/nds/crawler/orchestration/ScanJobConsumer.java @@ -13,5 +13,10 @@ @FunctionalInterface public interface ScanJobConsumer { + /** + * Consumes a scan job for processing. + * + * @param scanJobDescription The scan job to be consumed and processed + */ void consumeScanJob(ScanJobDescription scanJobDescription); } From 0ce1a4829dc53dfeaca4634f13340a25c1f441c2 Mon Sep 17 00:00:00 2001 From: Robert Merget Date: Thu, 19 Jun 2025 10:55:28 +0000 Subject: [PATCH 3/3] Add Javadoc to RabbitMqOrchestrationProvider constructor --- .../crawler/orchestration/RabbitMqOrchestrationProvider.java | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/main/java/de/rub/nds/crawler/orchestration/RabbitMqOrchestrationProvider.java b/src/main/java/de/rub/nds/crawler/orchestration/RabbitMqOrchestrationProvider.java index 9f9e144..2237701 100644 --- a/src/main/java/de/rub/nds/crawler/orchestration/RabbitMqOrchestrationProvider.java +++ b/src/main/java/de/rub/nds/crawler/orchestration/RabbitMqOrchestrationProvider.java @@ -54,6 +54,11 @@ public class RabbitMqOrchestrationProvider implements IOrchestrationProvider { private Set declaredQueues = new HashSet<>(); + /** + * Constructs a new RabbitMQ orchestration provider with the specified configuration. + * + * @param rabbitMqDelegate The RabbitMQ configuration delegate containing connection parameters + */ public RabbitMqOrchestrationProvider(RabbitMqDelegate rabbitMqDelegate) { ConnectionFactory factory = new ConnectionFactory(); factory.setHost(rabbitMqDelegate.getRabbitMqHost());