Package org.opends.server.api

Interface AlertHandler<T extends AlertHandlerCfg>

Type Parameters:
T - The type of configuration handled by this alert handler.
All Known Implementing Classes:
JMXAlertHandler, SMTPAlertHandler
public interface AlertHandler<T extends AlertHandlerCfg>
This interface defines the set of methods that must be implemented for a Directory Server alert handler. Alert handlers are used to present alert notifications in various forms like JMX, e-mail, or paging.

  • Method Details

    • initializeAlertHandler

      void initializeAlertHandler(ServerContext serverContext, T configuration) throws ConfigException, InitializationException
      Initializes this alert handler based on the information in the provided configuration entry.
      Parameters:
      serverContext - The server context
      configuration - The configuration to use to initialize this alert handler.
      Throws:
      ConfigException - If the provided entry does not contain a valid configuration for this alert handler.
      InitializationException - If a problem occurs during initialization that is not related to the server configuration.

    • getAlertHandlerConfiguration

      AlertHandlerCfg getAlertHandlerConfiguration()
      Retrieves the current configuration for this alert handler.
      Returns:
      The current configuration for this alert handler.

    • isConfigurationAcceptable

      boolean isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons)
      Indicates whether the provided configuration is acceptable for this alert handler.
      Parameters:
      configuration - The configuration for which to make tje determination.
      unacceptableReasons - A list to which human-readable reasons may be added to explain why the configuration is not acceptable.
      Returns:
      true if the provided configuration is acceptable, or false if it is not.

    • finalizeAlertHandler

      void finalizeAlertHandler()
      Performs any necessary cleanup that may be necessary when this alert handler is finalized.

    • sendAlertNotification

      void sendAlertNotification(AlertGenerator generator, String alertType, LocalizableMessage alertMessage)
      Sends an alert notification based on the provided information.
      Parameters:
      generator - The alert generator that created the alert.
      alertType - The alert type name for this alert.
      alertMessage - A message (possibly null) that can provide more information about this alert.