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

Interface AlertHandlerCfgClient

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
JmxAlertHandlerCfgClient, SmtpAlertHandlerCfgClient
public interface AlertHandlerCfgClient extends ConfigurationClient
A client-side interface for reading and modifying 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

    • definition

      ManagedObjectDefinition<? extends AlertHandlerCfgClient,? extends AlertHandlerCfg> definition()
      Get the configuration definition associated with this Alert Handler.
      Specified by:
      definition in interface ConfigurationClient
      Returns:
      Returns the configuration definition associated with this Alert Handler.

    • getDisabledAlertType

      SortedSet<ValueOrExpression<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 the values of the "disabled-alert-type" property.

    • setDisabledAlertType

      void setDisabledAlertType(Collection<ValueOrExpression<String>> values) throws PropertyException
      Sets 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.

      Parameters:
      values - The values of the "disabled-alert-type" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • isEnabled

      @MandatoryProperty ValueOrExpression<Boolean> isEnabled()
      Gets the "enabled" property.

      Indicates whether the Alert Handler is enabled.

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

    • setEnabled

      @MandatoryProperty void setEnabled(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "enabled" property.

      Indicates whether the Alert Handler is enabled.

      Parameters:
      value - The value of the "enabled" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getEnabledAlertType

      SortedSet<ValueOrExpression<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 the values of the "enabled-alert-type" property.

    • setEnabledAlertType

      void setEnabledAlertType(Collection<ValueOrExpression<String>> values) throws PropertyException
      Sets 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.

      Parameters:
      values - The values of the "enabled-alert-type" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<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.

    • setJavaClass

      @MandatoryProperty void setJavaClass(ValueOrExpression<String> value) throws PropertyException
      Sets the "java-class" property.

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

      Parameters:
      value - The value of the "java-class" property.
      Throws:
      PropertyException - If the new value is invalid.