org.apache.ambari.server.notifications.dispatchers

Class AlertScriptDispatcher

java.lang.Object

org.apache.ambari.server.notifications.dispatchers.AlertScriptDispatcher

All Implemented Interfaces:

NotificationDispatcher

public class AlertScriptDispatcher
extends Object
implements NotificationDispatcher

The AlertScriptDispatcher is used to dispatch AlertNotifications to a script via a Process and command line arguments. This dispatcher does not know how to work with any other types of Notification.

This dispatcher only deals with non-digest notifications.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISPATCH_PROPERTY_SCRIPT_CONFIG_KEY A dispatch property that instructs this dispatcher to read a different key from Configuration.
static String	DISPATCH_PROPERTY_SCRIPT_FILENAME_KEY A dispatch property that instructs this dispatcher to lookup script by filename from AlertTarget.
protected Configuration	m_configuration Configuration data from the ambari.properties file.
static String	SCRIPT_CONFIG_DEFAULT_KEY The key in ambari.properties which contains the script to execute.
static String	SCRIPT_CONFIG_TIMEOUT_KEY The key in ambari.properties which contains the timeout, in milliseconds, of any script run by this dispatcher.
static com.google.common.escape.Escaper	SHELL_ESCAPE Used to escape text being passed into the shell command.

Constructor Summary

Constructors

Constructor and Description
AlertScriptDispatcher()

Method Summary

Modifier and Type	Method and Description
void	dispatch(Notification notification) Dispatches the specified notification.
String	getScriptConfigurationKey(Notification notification) Gets the key that will be used to lookup the script to execute from Configuration.
long	getScriptConfigurationTimeout() Gets the timeout value for the script, in milliseconds, as set in Configuration.
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

SCRIPT_CONFIG_DEFAULT_KEY

public static final String SCRIPT_CONFIG_DEFAULT_KEY

The key in ambari.properties which contains the script to execute.

See Also:

Constant Field Values

SCRIPT_CONFIG_TIMEOUT_KEY

public static final String SCRIPT_CONFIG_TIMEOUT_KEY

The key in ambari.properties which contains the timeout, in milliseconds, of any script run by this dispatcher.

See Also:

Constant Field Values

DISPATCH_PROPERTY_SCRIPT_CONFIG_KEY

public static final String DISPATCH_PROPERTY_SCRIPT_CONFIG_KEY

A dispatch property that instructs this dispatcher to read a different key from Configuration. If this value is not a part of the Notification.DispatchProperties then SCRIPT_CONFIG_DEFAULT_KEY will be used.

See Also:

Constant Field Values

DISPATCH_PROPERTY_SCRIPT_FILENAME_KEY

public static final String DISPATCH_PROPERTY_SCRIPT_FILENAME_KEY

A dispatch property that instructs this dispatcher to lookup script by filename from AlertTarget.

See Also:

Constant Field Values

SHELL_ESCAPE

public static final com.google.common.escape.Escaper SHELL_ESCAPE

Used to escape text being passed into the shell command.

m_configuration

@Inject
protected Configuration m_configuration

Configuration data from the ambari.properties file.

Constructor Detail

AlertScriptDispatcher

public AlertScriptDispatcher()

Method Detail

getScriptConfigurationKey

public String getScriptConfigurationKey(Notification notification)

Gets the key that will be used to lookup the script to execute from Configuration.

Returns:

the key that will be used to lookup the script value from Configuration (never null).

getScriptConfigurationTimeout

public long getScriptConfigurationTimeout()

Gets the timeout value for the script, in milliseconds, as set in Configuration. If there is no setting, then DEFAULT_SCRIPT_TIMEOUT will be returned.

Returns:

the timeout value in milliseconds

getType

public final 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 final 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 false always.

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 final 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 false always.

Specified by:

isDigestSupported in interface NotificationDispatcher

Returns:

true if digest is supported, false otherwise.

validateTargetConfig

public final 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