public interface SmtpAlertHandlerCfgClient extends AlertHandlerCfgClient
The SMTP Alert Handler may be used to send e-mail messages to notify administrators of significant events that occur within the server.
Modifier and Type | Method and Description |
---|---|
ManagedObjectDefinition<? extends SmtpAlertHandlerCfgClient,? extends SmtpAlertHandlerCfg> |
definition()
Get the configuration definition associated with this SMTP Alert Handler.
|
ValueOrExpression<String> |
getJavaClass()
Gets the "java-class" property.
|
ValueOrExpression<String> |
getMessageBody()
Gets the "message-body" property.
|
ValueOrExpression<String> |
getMessageSubject()
Gets the "message-subject" property.
|
SortedSet<ValueOrExpression<String>> |
getRecipientAddress()
Gets the "recipient-address" property.
|
ValueOrExpression<String> |
getSenderAddress()
Gets the "sender-address" property.
|
void |
setJavaClass(ValueOrExpression<String> value)
Sets the "java-class" property.
|
void |
setMessageBody(ValueOrExpression<String> value)
Sets the "message-body" property.
|
void |
setMessageSubject(ValueOrExpression<String> value)
Sets the "message-subject" property.
|
void |
setRecipientAddress(Collection<ValueOrExpression<String>> values)
Sets the "recipient-address" property.
|
void |
setSenderAddress(ValueOrExpression<String> value)
Sets the "sender-address" property.
|
getDisabledAlertType, getEnabledAlertType, isEnabled, setDisabledAlertType, setEnabled, setEnabledAlertType
commit, properties
ManagedObjectDefinition<? extends SmtpAlertHandlerCfgClient,? extends SmtpAlertHandlerCfg> definition()
definition
in interface AlertHandlerCfgClient
definition
in interface ConfigurationClient
ValueOrExpression<String> getJavaClass()
Specifies the fully-qualified name of the Java class that provides the SMTP Alert Handler implementation.
getJavaClass
in interface AlertHandlerCfgClient
void setJavaClass(ValueOrExpression<String> value) throws PropertyException
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.PropertyException
- If the new value is invalid.ValueOrExpression<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(ValueOrExpression<String> value) throws PropertyException
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.PropertyException
- If the new value is invalid.ValueOrExpression<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(ValueOrExpression<String> value) throws PropertyException
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.PropertyException
- If the new value is invalid.SortedSet<ValueOrExpression<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(Collection<ValueOrExpression<String>> values) throws PropertyException
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.PropertyException
- If one or more of the new values are invalid.ValueOrExpression<String> getSenderAddress()
Specifies the email address to use as the sender for messages generated by this alert handler.
void setSenderAddress(ValueOrExpression<String> value) throws PropertyException
Specifies the email address to use as the sender for messages generated by this alert handler.
value
- The value of the "sender-address" property.PropertyException
- If the new value is invalid.Copyright 2010-2018 ForgeRock AS.