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

Class AlertHandlerCfgDefn

java.lang.Object
org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
org.forgerock.opendj.config.ManagedObjectDefinition<AlertHandlerCfgClient,AlertHandlerCfg>
org.forgerock.opendj.server.config.meta.AlertHandlerCfgDefn
public final class AlertHandlerCfgDefn extends ManagedObjectDefinition<AlertHandlerCfgClient,AlertHandlerCfg>
An interface for querying the Alert Handler managed object definition meta information.

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

  • Method Details

    • getInstance

      public static AlertHandlerCfgDefn getInstance()
      Get the Alert Handler configuration definition singleton.
      Returns:
      Returns the Alert Handler configuration definition singleton.

    • createClientConfiguration

      public AlertHandlerCfgClient createClientConfiguration(ManagedObject<? extends AlertHandlerCfgClient> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.
      Specified by:
      createClientConfiguration in class ManagedObjectDefinition<AlertHandlerCfgClient,AlertHandlerCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

      public AlertHandlerCfg createServerConfiguration(ServerManagedObject<? extends AlertHandlerCfg> impl)
      Description copied from class: ManagedObjectDefinition
      Creates a server configuration view of the provided server managed object.
      Specified by:
      createServerConfiguration in class ManagedObjectDefinition<AlertHandlerCfgClient,AlertHandlerCfg>
      Parameters:
      impl - The server managed object.
      Returns:
      Returns a server configuration view of the provided server managed object.

    • getServerConfigurationClass

      public Class<AlertHandlerCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<AlertHandlerCfgClient,AlertHandlerCfg>
      Returns:
      Returns the server configuration class instance associated with this managed object definition.

    • getDisabledAlertTypePropertyDefinition

      public StringPropertyDefinition getDisabledAlertTypePropertyDefinition()
      Get the "disabled-alert-type" property definition.

      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 "disabled-alert-type" property definition.

    • getEnabledPropertyDefinition

      public BooleanPropertyDefinition getEnabledPropertyDefinition()
      Get the "enabled" property definition.

      Indicates whether the Alert Handler is enabled.

      Returns:
      Returns the "enabled" property definition.

    • getEnabledAlertTypePropertyDefinition

      public StringPropertyDefinition getEnabledAlertTypePropertyDefinition()
      Get the "enabled-alert-type" property definition.

      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 "enabled-alert-type" property definition.

    • getJavaClassPropertyDefinition

      public ClassPropertyDefinition getJavaClassPropertyDefinition()
      Get the "java-class" property definition.

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

      Returns:
      Returns the "java-class" property definition.