org.opends.server.admin.std.server
Interface SMTPAlertHandlerCfg

All Superinterfaces:
AlertHandlerCfg, Configuration

public interface SMTPAlertHandlerCfg
extends AlertHandlerCfg

A server-side interface for querying 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 Summary
 void addSMTPChangeListener(ConfigurationChangeListener<SMTPAlertHandlerCfg> listener)
          Register to be notified when this SMTP Alert Handler is changed.
 java.lang.Class<? extends SMTPAlertHandlerCfg> configurationClass()
          Gets the configuration class associated with this SMTP Alert Handler.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.String getMessageBody()
          Gets the "message-body" property.
 java.lang.String getMessageSubject()
          Gets the "message-subject" property.
 java.util.SortedSet<java.lang.String> getRecipientAddress()
          Gets the "recipient-address" property.
 java.lang.String getSenderAddress()
          Gets the "sender-address" property.
 void removeSMTPChangeListener(ConfigurationChangeListener<SMTPAlertHandlerCfg> listener)
          Deregister an existing SMTP Alert Handler configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.AlertHandlerCfg
addChangeListener, getDisabledAlertType, getEnabledAlertType, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends SMTPAlertHandlerCfg> configurationClass()
Gets the configuration class associated with this SMTP Alert Handler.

Specified by:
configurationClass in interface AlertHandlerCfg
Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this SMTP Alert Handler.

addSMTPChangeListener

void addSMTPChangeListener(ConfigurationChangeListener<SMTPAlertHandlerCfg> listener)
Register to be notified when this SMTP Alert Handler is changed.

Parameters:
listener - The SMTP Alert Handler configuration change listener.

removeSMTPChangeListener

void removeSMTPChangeListener(ConfigurationChangeListener<SMTPAlertHandlerCfg> listener)
Deregister an existing SMTP Alert Handler configuration change listener.

Parameters:
listener - The SMTP Alert Handler configuration change listener.

getJavaClass

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

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

Specified by:
getJavaClass in interface AlertHandlerCfg
Returns:
Returns the value of the "java-class" property.

getMessageBody

java.lang.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.

getMessageSubject

java.lang.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.

getRecipientAddress

java.util.SortedSet<java.lang.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 an unmodifiable set containing the values of the "recipient-address" property.

getSenderAddress

java.lang.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.