Package org.forgerock.opendj.server.config.server

Interface AlertHandlerCfg

All Superinterfaces:
Configuration
All Known Subinterfaces:
JmxAlertHandlerCfg, SmtpAlertHandlerCfg
public interface AlertHandlerCfg extends Configuration
A server-side interface for querying Alert Handler settings.

Alert Handlers are used to notify administrators of significant problems or notable events that occur in the OpenDJ directory server.

  • Method Details

    • configurationClass

      Class<? extends AlertHandlerCfg> configurationClass()
      Gets the configuration class associated with this Alert Handler.
      Specified by:
      configurationClass in interface Configuration
      Returns:
      Returns the configuration class associated with this Alert Handler.

    • addChangeListener

      void addChangeListener(ConfigurationChangeListener<AlertHandlerCfg> listener)
      Register to be notified when this Alert Handler is changed.
      Parameters:
      listener - The Alert Handler configuration change listener.

    • removeChangeListener

      void removeChangeListener(ConfigurationChangeListener<AlertHandlerCfg> listener)
      Deregister an existing Alert Handler configuration change listener.
      Parameters:
      listener - The Alert Handler configuration change listener.

    • getDisabledAlertType

      SortedSet<String> getDisabledAlertType()
      Gets the "disabled-alert-type" property.

      Specifies the names of the alert types that are disabled for this alert handler.

      If there are any values for this attribute, then no alerts with any of the specified types are allowed. If there are no values for this attribute, then only alerts with a type included in the set of enabled alert types are allowed, or if there are no values for the enabled alert types option, then all alert types are allowed.

      Returns:
      Returns an unmodifiable set containing the values of the "disabled-alert-type" property.

    • isEnabled

      boolean isEnabled()
      Gets the "enabled" property.

      Indicates whether the Alert Handler is enabled.

      Returns:
      Returns the value of the "enabled" property.

    • getEnabledAlertType

      SortedSet<String> getEnabledAlertType()
      Gets the "enabled-alert-type" property.

      Specifies the names of the alert types that are enabled for this alert handler.

      If there are any values for this attribute, then only alerts with one of the specified types are allowed (unless they are also included in the disabled alert types). If there are no values for this attribute, then any alert with a type not included in the list of disabled alert types is allowed.

      Returns:
      Returns an unmodifiable set containing the values of the "enabled-alert-type" property.

    • getJavaClass

      String getJavaClass()
      Gets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the Alert Handler implementation.

      Returns:
      Returns the value of the "java-class" property.