|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SMTPAlertHandlerCfgClient
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 Summary | |
---|---|
ManagedObjectDefinition<? extends SMTPAlertHandlerCfgClient,? extends SMTPAlertHandlerCfg> |
definition()
Get the configuration definition 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 |
setJavaClass(java.lang.String value)
Sets the "java-class" property. |
void |
setMessageBody(java.lang.String value)
Sets the "message-body" property. |
void |
setMessageSubject(java.lang.String value)
Sets the "message-subject" property. |
void |
setRecipientAddress(java.util.Collection<java.lang.String> values)
Sets the "recipient-address" property. |
void |
setSenderAddress(java.lang.String value)
Sets the "sender-address" property. |
Methods inherited from interface org.opends.server.admin.std.client.AlertHandlerCfgClient |
---|
getDisabledAlertType, getEnabledAlertType, isEnabled, setDisabledAlertType, setEnabled, setEnabledAlertType |
Methods inherited from interface org.opends.server.admin.ConfigurationClient |
---|
commit, properties |
Method Detail |
---|
ManagedObjectDefinition<? extends SMTPAlertHandlerCfgClient,? extends SMTPAlertHandlerCfg> definition()
definition
in interface AlertHandlerCfgClient
definition
in interface ConfigurationClient
java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the SMTP Alert Handler implementation.
getJavaClass
in interface AlertHandlerCfgClient
void setJavaClass(java.lang.String value) throws IllegalPropertyValueException
Specifies the fully-qualified name of the Java class that provides the SMTP Alert Handler implementation.
setJavaClass
in interface AlertHandlerCfgClient
value
- The value of the "java-class" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setMessageBody(java.lang.String value) throws IllegalPropertyValueException
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.
value
- The value of the "message-body" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setMessageSubject(java.lang.String value) throws IllegalPropertyValueException
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.
value
- The value of the "message-subject" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setRecipientAddress(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
Specifies an email address to which the messages should be sent.
Multiple values may be provided if there should be more than one recipient.
values
- The values of the "recipient-address" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.java.lang.String getSenderAddress()
Specifies the email address to use as the sender for messages generated by this alert handler.
void setSenderAddress(java.lang.String value) throws IllegalPropertyValueException
Specifies the email address to use as the sender for messages generated by this alert handler.
value
- The value of the "sender-address" property.
IllegalPropertyValueException
- If the new value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |