diff --git a/src/main/java/de/rub/nds/crawler/core/jobs/PublishBulkScanJob.java b/src/main/java/de/rub/nds/crawler/core/jobs/PublishBulkScanJob.java index 1459b1a..856530e 100644 --- a/src/main/java/de/rub/nds/crawler/core/jobs/PublishBulkScanJob.java +++ b/src/main/java/de/rub/nds/crawler/core/jobs/PublishBulkScanJob.java @@ -30,6 +30,20 @@ public class PublishBulkScanJob implements Job { private static final Logger LOGGER = LogManager.getLogger(); + /** + * Executes the bulk scan job which creates scan jobs for a list of targets. This method + * performs the following operations: + * + * + * + * @param context the job execution context containing configuration and provider instances + * @throws JobExecutionException if an error occurs during job execution + */ public void execute(JobExecutionContext context) throws JobExecutionException { try { JobDataMap data = context.getMergedJobDataMap(); @@ -109,6 +123,15 @@ private static class JobSubmitter implements Function { private final BulkScan bulkScan; private final int defaultPort; + /** + * Constructs a JobSubmitter for processing and submitting scan jobs. + * + * @param orchestrationProvider provider for submitting scan jobs to the message queue + * @param persistenceProvider provider for persisting scan results + * @param denylistProvider provider for checking if targets are denylisted + * @param bulkScan the bulk scan context for which jobs are being created + * @param defaultPort the default port to use if not specified in target string + */ public JobSubmitter( IOrchestrationProvider orchestrationProvider, IPersistenceProvider persistenceProvider, @@ -122,6 +145,22 @@ public JobSubmitter( this.defaultPort = defaultPort; } + /** + * Processes a target string to create and submit a scan job. This method performs the + * following operations: + * + * + * + * @param targetString the target to scan (hostname, IP address, or hostname:port) + * @return the status of the job (TO_BE_EXECUTED, DENYLISTED, UNRESOLVABLE, or + * RESOLUTION_ERROR) + */ @Override public JobStatus apply(String targetString) { ScanJobDescription jobDescription;