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 Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends SMTPAlertHandlerCfgClient,? extends SMTPAlertHandlerCfg>	definition()	Get the configuration definition associated with this SMTP Alert Handler.
String	getJavaClass()	Gets the "java-class" property.
String	getMessageBody()	Gets the "message-body" property.
String	getMessageSubject()	Gets the "message-subject" property.
SortedSet<String>	getRecipientAddress()	Gets the "recipient-address" property.
String	getSenderAddress()	Gets the "sender-address" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setMessageBody(String value)	Sets the "message-body" property.
void	setMessageSubject(String value)	Sets the "message-subject" property.
void	setRecipientAddress(Collection<String> values)	Sets the "recipient-address" property.
void	setSenderAddress(String value)	Sets the "sender-address" property.

Methods inherited from interface org.forgerock.opendj.server.config.client.AlertHandlerCfgClient

getDisabledAlertType, getEnabledAlertType, isEnabled, setDisabledAlertType, setEnabled, setEnabledAlertType

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Method Detail

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

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 AlertHandlerCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(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

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

void setMessageBody(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

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

void setMessageSubject(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

SortedSet<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

void setRecipientAddress(Collection<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

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

void setSenderAddress(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.