|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SMTPAlertHandlerCfg
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 |
---|
java.lang.Class<? extends SMTPAlertHandlerCfg> configurationClass()
configurationClass
in interface AlertHandlerCfg
configurationClass
in interface Configuration
void addSMTPChangeListener(ConfigurationChangeListener<SMTPAlertHandlerCfg> listener)
listener
- The SMTP Alert Handler configuration change listener.void removeSMTPChangeListener(ConfigurationChangeListener<SMTPAlertHandlerCfg> listener)
listener
- The SMTP Alert Handler configuration change listener.java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the SMTP Alert Handler implementation.
getJavaClass
in interface AlertHandlerCfg
java.lang.String getMessageBody()
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.
java.lang.String getMessageSubject()
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.
java.util.SortedSet<java.lang.String> getRecipientAddress()
Specifies an email address to which the messages should be sent.
Multiple values may be provided if there should be more than one recipient.
java.lang.String getSenderAddress()
Specifies the email address to use as the sender for messages generated by this alert handler.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |