com.mozilla.secops.alert

Class AlertSlack

java.lang.Object

com.mozilla.secops.alert.AlertSlack

public class AlertSlack
extends Object

AlertSlack handles slack based alerting output

Constructor Summary

Constructors

Constructor and Description
AlertSlack(AlertConfiguration cfg) Construct new alert slack object
AlertSlack(AlertConfiguration cfg, SlackManager slackManager) Construct new alert slack object, providing an already instantiated SlackManager

Method Summary

Modifier and Type	Method and Description
void	done() Mark AlertSlack instance as done
String	getUserId(String email) Get slack user id from user's email
Boolean	sendConfirmationAlertToUser(Alert a, String userId) Send an alert to a user asking them if it was caused by them.
Boolean	sendToCatchall(Alert a) Send alert to slack catchall channel
Boolean	sendToSupplementary(Alert a) Send alert to supplementary slack channel
Boolean	sendToUser(Alert a, String userId) Send alert to a user.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlertSlack

public AlertSlack(AlertConfiguration cfg)
           throws IOException

Construct new alert slack object

Parameters:

cfg - AlertConfiguration

Throws:

IOException - IOException

AlertSlack

public AlertSlack(AlertConfiguration cfg,
                  SlackManager slackManager)

Construct new alert slack object, providing an already instantiated SlackManager

Parameters:

cfg - AlertConfiguration

slackManager - SlackManager instance

Method Detail

done

public void done()

Mark AlertSlack instance as done

Should be called when object will no longer be used.

sendToCatchall

public Boolean sendToCatchall(Alert a)

Send alert to slack catchall channel

Parameters:

a - Alert

Returns:

Boolean on whether the alert was sent successfully

sendToSupplementary

public Boolean sendToSupplementary(Alert a)

Send alert to supplementary slack channel

If any supplementary slack output metadata is set in the alert, this method will send the required message to the configured channel.

Parameters:

a - Alert

Returns:

Boolean on whether the alert was sent successfully

sendToUser

public Boolean sendToUser(Alert a,
                          String userId)

Send alert to a user.

Parameters:

a - Alert

userId - Slack user id

Returns:

Boolean on whether the alert was sent successfully

sendConfirmationAlertToUser

public Boolean sendConfirmationAlertToUser(Alert a,
                                           String userId)

Send an alert to a user asking them if it was caused by them. Used for AuthProfile

Parameters:

a - Alert

userId - Slack user id

Returns:

Boolean on whether the alert was sent successfully

getUserId

public String getUserId(String email)

Get slack user id from user's email

Parameters:

email - User's email

Returns:

User's slack user id