ai.nightfall.scan.model.alert

Class AlertConfig

java.lang.Object

ai.nightfall.scan.model.alert.AlertConfig

public class AlertConfig
extends Object

The AlertConfig class allows clients to specify where alerts should be delivered when findings are discovered as part of a scan. These alerts are delivered asynchronously to all destinations specified in the object instance.

Constructor Summary

Constructors

Constructor and Description
AlertConfig(EmailAlert emailAlert) Build an instance of AlertConfig that sends findings alerts via email.
AlertConfig(EmailAlert emailAlert, SlackAlert slackAlert, WebhookAlert webhookAlert) Build an instance of AlertConfig with all provided alert destinations.
AlertConfig(SlackAlert slackAlert) Build an instance of AlertConfig that sends findings alerts via Slack.
AlertConfig(WebhookAlert webhookAlert) Build an instance of AlertConfig that sends findings alerts via webhook.

Method Summary

Modifier and Type	Method and Description
EmailAlert	getEmailAlert() Returns the email alert destination.
SlackAlert	getSlackAlert() Returns the Slack alert destination.
WebhookAlert	getWebhookAlert() Returns the webhook alert destination.
void	setEmailAlert(EmailAlert emailAlert) Sets the email alert destination.
void	setSlackAlert(SlackAlert slackAlert) Sets the Slack alert destination.
void	setWebhookAlert(WebhookAlert webhookAlert) Sets the webhook alert destination.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AlertConfig

public AlertConfig(EmailAlert emailAlert,
                   SlackAlert slackAlert,
                   WebhookAlert webhookAlert)

Build an instance of AlertConfig with all provided alert destinations.

Parameters:

emailAlert - the email alert destination

slackAlert - the Slack alert destination

webhookAlert - the webhook alert destination

AlertConfig

public AlertConfig(WebhookAlert webhookAlert)

Build an instance of AlertConfig that sends findings alerts via webhook.

Parameters:

webhookAlert - the webhook alert destination

AlertConfig

public AlertConfig(SlackAlert slackAlert)

Build an instance of AlertConfig that sends findings alerts via Slack.

Parameters:

slackAlert - the Slack alert destination

AlertConfig

public AlertConfig(EmailAlert emailAlert)

Build an instance of AlertConfig that sends findings alerts via email.

Parameters:

emailAlert - the email alert destination

Method Detail

getEmailAlert

public EmailAlert getEmailAlert()

Returns the email alert destination.

Returns:

the email alert destination

setEmailAlert

public void setEmailAlert(EmailAlert emailAlert)

Sets the email alert destination.

Parameters:

emailAlert - the email alert destination

getSlackAlert

public SlackAlert getSlackAlert()

Returns the Slack alert destination.

Returns:

the Slack alert destination

setSlackAlert

public void setSlackAlert(SlackAlert slackAlert)

Sets the Slack alert destination.

Parameters:

slackAlert - the Slack alert destination

getWebhookAlert

public WebhookAlert getWebhookAlert()

Returns the webhook alert destination.

Returns:

the webhook alert destination

setWebhookAlert

public void setWebhookAlert(WebhookAlert webhookAlert)

Sets the webhook alert destination.

Parameters:

webhookAlert - the webhook alert destination

toString

public String toString()

Overrides:

toString in class Object