Package org.duracloud.common.notification

Interface Notifier

All Known Implementing Classes:
EmailNotifier
public interface Notifier
A Notifier is responsible for sending notifications to a destination or set of destinations. Each notifier will handle distributing notifications over a particular notification channel. The channel handled by the notifier can be determined by asking for the notification type.

  • Method Details

    • initialize

      void initialize(NotificationConfig notificationConfig)
      Initializes the Notifier to be able to set up connects to begin performing notification operations.
      Parameters:
      notificationConfig -

    • getNotificationType

      NotificationType getNotificationType()
      Indicates the type of notifications sent by this notifier
      Returns:
      the channel type of this notifier

    • notify

      void notify(String subject, String message, String... destinations)
      Sends a notification to a destination
      Parameters:
      subject - the subject of the notification
      message - the actual notification message
      destinations - where the notification is to go, could be an email address, a URL address, etc.

    • notifyAdmins

      void notifyAdmins(String subject, String message)
      Sends a notification to configured admins
      Parameters:
      subject - the subject of the notification
      message - the actual notification message