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

Class SmtpAlertHandlerCfgDefn

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

The SMTP Alert Handler may be used to send e-mail messages to notify administrators of significant events that occur within the server.

  • Method Details

    • getInstance

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

    • createClientConfiguration

      public SmtpAlertHandlerCfgClient createClientConfiguration(ManagedObject<? extends SmtpAlertHandlerCfgClient> 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<SmtpAlertHandlerCfgClient,SmtpAlertHandlerCfg>
      Parameters:
      impl - The managed object.
      Returns:
      Returns a client configuration view of the provided managed object.

    • createServerConfiguration

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

    • getServerConfigurationClass

      public Class<SmtpAlertHandlerCfg> getServerConfigurationClass()
      Description copied from class: ManagedObjectDefinition
      Gets the server configuration class instance associated with this managed object definition.
      Specified by:
      getServerConfigurationClass in class ManagedObjectDefinition<SmtpAlertHandlerCfgClient,SmtpAlertHandlerCfg>
      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 SMTP 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 SMTP Alert Handler implementation.

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

    • getMessageBodyPropertyDefinition

      public StringPropertyDefinition getMessageBodyPropertyDefinition()
      Get the "message-body" property definition.

      Specifies the body that should be used for email messages generated by this alert handler.

      The token "%%alert-type%%" is dynamically replaced with the alert type string. The token "%%alert-id%%" is dynamically replaced with the alert ID value. The token "%%alert-message%%" is dynamically replaced with the alert message. The token "\\n" is replaced with an end-of-line marker.

      Returns:
      Returns the "message-body" property definition.

    • getMessageSubjectPropertyDefinition

      public StringPropertyDefinition getMessageSubjectPropertyDefinition()
      Get the "message-subject" property definition.

      Specifies the subject that should be used for email messages generated by this alert handler.

      The token "%%alert-type%%" is dynamically replaced with the alert type string. The token "%%alert-id%%" is dynamically replaced with the alert ID value. The token "%%alert-message%%" is dynamically replaced with the alert message. The token "\\n" is replaced with an end-of-line marker.

      Returns:
      Returns the "message-subject" property definition.

    • getRecipientAddressPropertyDefinition

      public StringPropertyDefinition getRecipientAddressPropertyDefinition()
      Get the "recipient-address" property definition.

      Specifies an email address to which the messages should be sent.

      Multiple values may be provided if there should be more than one recipient.

      Returns:
      Returns the "recipient-address" property definition.

    • getSenderAddressPropertyDefinition

      public StringPropertyDefinition getSenderAddressPropertyDefinition()
      Get the "sender-address" property definition.

      Specifies the email address to use as the sender for messages generated by this alert handler.

      Returns:
      Returns the "sender-address" property definition.