Skip to content

Add Javadoc to public methods in orchestration package #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ public class RabbitMqOrchestrationProvider implements IOrchestrationProvider {

private Set<String> 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());
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}