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

Interface SmtpAlertHandlerCfgClient

All Superinterfaces:
AlertHandlerCfgClient, ConfigurationClient
public interface SmtpAlertHandlerCfgClient extends AlertHandlerCfgClient
A client-side interface for reading and modifying SMTP Alert Handler settings.

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

    • definition

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

    • getJavaClass

      @MandatoryProperty ValueOrExpression<String> getJavaClass()
      Gets the "java-class" property.

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

      Default value: org.opends.server.extensions.SMTPAlertHandler

      Specified by:
      getJavaClass in interface AlertHandlerCfgClient
      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 SMTP Alert Handler implementation.

      Specified by:
      setJavaClass in interface AlertHandlerCfgClient
      Parameters:
      value - The value of the "java-class" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getMessageBody

      @MandatoryProperty ValueOrExpression<String> getMessageBody()
      Gets the "message-body" property.

      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 value of the "message-body" property.

    • setMessageBody

      @MandatoryProperty void setMessageBody(ValueOrExpression<String> value) throws PropertyException
      Sets the "message-body" property.

      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.

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

    • getMessageSubject

      @MandatoryProperty ValueOrExpression<String> getMessageSubject()
      Gets the "message-subject" property.

      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 value of the "message-subject" property.

    • setMessageSubject

      @MandatoryProperty void setMessageSubject(ValueOrExpression<String> value) throws PropertyException
      Sets the "message-subject" property.

      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.

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

    • getRecipientAddress

      @MandatoryProperty SortedSet<ValueOrExpression<String>> getRecipientAddress()
      Gets the "recipient-address" property.

      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 values of the "recipient-address" property.

    • setRecipientAddress

      @MandatoryProperty void setRecipientAddress(Collection<ValueOrExpression<String>> values) throws PropertyException
      Sets the "recipient-address" property.

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

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

      Parameters:
      values - The values of the "recipient-address" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.

    • getSenderAddress

      @MandatoryProperty ValueOrExpression<String> getSenderAddress()
      Gets the "sender-address" property.

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

      Returns:
      Returns the value of the "sender-address" property.

    • setSenderAddress

      @MandatoryProperty void setSenderAddress(ValueOrExpression<String> value) throws PropertyException
      Sets the "sender-address" property.

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

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