org.apache.ambari.server.notifications

Interface NotificationDispatcher

All Known Implementing Classes:

AlertScriptDispatcher, AmbariSNMPDispatcher, EmailDispatcher, SNMPDispatcher

public interface NotificationDispatcher

The NotificationDispatcher interface represents a mechanism for dispatching a Notification.

Dispatchers should, in general, be singletons. They should also invoke the appropriate methods on Notification.Callback to indicate a success or failure during dispatch.

Method Summary

Modifier and Type	Method and Description
void	dispatch(Notification notification) Dispatches the specified notification.
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.

Method Detail

getType

String getType()

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

Returns:

the dispatcher's type (never null).

dispatch

void dispatch(Notification notification)

Dispatches the specified notification.

Parameters:

notification - the notificationt to dispatch (not null).

isDigestSupported

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.

Returns:

true if digest is supported, false otherwise.

validateTargetConfig

TargetConfigurationResult validateTargetConfig(Map<String,Object> properties)

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

Parameters:

properties - alert target properties

Returns:

ConfigValidationResult with validation status and message

isNotificationContentGenerationRequired

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.

Returns:

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