org.apache.ambari.server.notifications.dispatchers

Class EmailDispatcher

java.lang.Object

org.apache.ambari.server.notifications.dispatchers.EmailDispatcher

All Implemented Interfaces:

NotificationDispatcher

public class EmailDispatcher
extends Object
implements NotificationDispatcher

The EmailDispatcher class is used to dispatch Notification via JavaMail. This class currently does not attempt to reuse an existing Session or Transport since each Notification could have a different target server with different properties.

In the future, this class could keep various Transport instances open on a Timer, but those instances would need to be hashed so that the proper instance is retrieved from the properties of the incoming Notification.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JAVAMAIL_FROM_PROPERTY The JavaMail property for the From: header.

Constructor Summary

Constructors

Constructor and Description
EmailDispatcher()

Method Summary

Modifier and Type	Method and Description
void	dispatch(Notification notification) Dispatches the specified notification.
protected javax.mail.Transport	getMailTransport(Map<String,Object> properties)
String	getType() Gets the type of dispatcher.
boolean	isDigestSupported() Gets whether the dispatcher supports sending a digest or summary in a single Notification.
boolean	isNotificationContentGenerationRequired() Gets whether Ambari should attempt to generate the content of the Notification before giving it to the dispatcher.
TargetConfigurationResult	validateTargetConfig(Map<String,Object> properties) Validates alert target configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JAVAMAIL_FROM_PROPERTY

public static final String JAVAMAIL_FROM_PROPERTY

The JavaMail property for the From: header.

See Also:

Constant Field Values

Constructor Detail

EmailDispatcher

public EmailDispatcher()

Method Detail

getType

public String getType()

Gets the type of dispatcher. The type of each different dispatcher should be unique.

Specified by:

getType in interface NotificationDispatcher

Returns:

the dispatcher's type (never null).

isNotificationContentGenerationRequired

public boolean isNotificationContentGenerationRequired()

Gets whether Ambari should attempt to generate the content of the Notification before giving it to the dispatcher. Some dispatchers may choose to format data in a way which is not easily represented in the {alert-templates.xml}.

If false then the Notification will only contain the recipients and a map of properties for the dispatcher to use.

Specified by:

isNotificationContentGenerationRequired in interface NotificationDispatcher

Returns:

true if Ambari should generate the Notification content, false otherwise.

dispatch

public void dispatch(Notification notification)

Dispatches the specified notification.

Specified by:

dispatch in interface NotificationDispatcher

Parameters:

notification - the notificationt to dispatch (not null).

isDigestSupported

public boolean isDigestSupported()

Gets whether the dispatcher supports sending a digest or summary in a single Notification. Some providers may not allow the Notification to contain information on more than a single event.

Specified by:

isDigestSupported in interface NotificationDispatcher

Returns:

true if digest is supported, false otherwise.

validateTargetConfig

public TargetConfigurationResult validateTargetConfig(Map<String,Object> properties)

Validates alert target configuration. Checks if it can dispatch notifications with given properties set.

Specified by:

validateTargetConfig in interface NotificationDispatcher

Parameters:

properties - alert target properties

Returns:

ConfigValidationResult with validation status and message

getMailTransport

protected javax.mail.Transport getMailTransport(Map<String,Object> properties)
                                         throws javax.mail.NoSuchProviderException

Throws:

javax.mail.NoSuchProviderException