org.apache.ambari.server.state.services

Class AlertNoticeDispatchService

java.lang.Object

com.google.common.util.concurrent.AbstractScheduledService

org.apache.ambari.server.state.services.AlertNoticeDispatchService

All Implemented Interfaces:

com.google.common.util.concurrent.Service

public class AlertNoticeDispatchService
extends com.google.common.util.concurrent.AbstractScheduledService

The AlertNoticeDispatchService is used to scan the database for AlertNoticeEntity that are in the NotificationState.PENDING state. It will then process them through the dispatch system.

The dispatch system will then make a callback to AlertNoticeDispatchCallback so that the NotificationState can be updated to its final value.

This class uses the templates that are defined via Configuration.getAlertTemplateFile() or the fallback internal template alert-templates.xml. These files are parsed during startUp(). If there is a problem parsing them, the service will still startup normally, producing an error in logs. It will fall back to simple string concatenation for Notification content in this case.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlertNoticeDispatchService.AlertInfo The AlertNoticeDispatchService.AlertInfo class encapsulates all information about a single alert for a single outbound Notification.
static class	AlertNoticeDispatchService.AlertSummaryInfo The AlertNoticeDispatchService.AlertSummaryInfo class encapsulates all of the alert information for the Notification.
static class	AlertNoticeDispatchService.AmbariInfo The AlertNoticeDispatchService.AmbariInfo class is used to provide the template engine with information about the Ambari installation.
static class	AlertNoticeDispatchService.DispatchInfo The AlertNoticeDispatchService.DispatchInfo class is used to provide the template engine with information about the intended target of the notification.

Nested classes/interfaces inherited from class com.google.common.util.concurrent.AbstractScheduledService

com.google.common.util.concurrent.AbstractScheduledService.CustomScheduler, com.google.common.util.concurrent.AbstractScheduledService.Scheduler

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields

Modifier and Type	Field and Description
static String	AMBARI_DISPATCH_CREDENTIAL_PASSWORD The property containing the dispatch authentication password.
static String	AMBARI_DISPATCH_CREDENTIAL_USERNAME The property containing the dispatch authentication username.
static String	AMBARI_DISPATCH_RECIPIENTS The property containing the dispatch recipients

Constructor Summary

Constructors

Constructor and Description
AlertNoticeDispatchService() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	runOneIteration()
protected com.google.common.util.concurrent.AbstractScheduledService.Scheduler	scheduler() Returns a schedule that starts after 2 minute and runs every 2 minutes after runOneIteration() completes.
protected void	setExecutor(Executor executor) Sets the Executor to use when dispatching Notifications.
protected void	startUp() Parse the XML template for Notification content.

Methods inherited from class com.google.common.util.concurrent.AbstractScheduledService

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, executor, failureCause, isRunning, serviceName, shutDown, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Field Detail

AMBARI_DISPATCH_CREDENTIAL_USERNAME

public static final String AMBARI_DISPATCH_CREDENTIAL_USERNAME

The property containing the dispatch authentication username.

See Also:

Constant Field Values

AMBARI_DISPATCH_CREDENTIAL_PASSWORD

public static final String AMBARI_DISPATCH_CREDENTIAL_PASSWORD

The property containing the dispatch authentication password.

See Also:

Constant Field Values

AMBARI_DISPATCH_RECIPIENTS

public static final String AMBARI_DISPATCH_RECIPIENTS

The property containing the dispatch recipients

See Also:

Constant Field Values

Constructor Detail

AlertNoticeDispatchService

public AlertNoticeDispatchService()

Constructor.

Method Detail

startUp

protected void startUp()
                throws Exception

Parse the XML template for Notification content. If there is a problem parsing the content, the service will still startup normally but the Notification content will fallback to plaintext.

Overrides:

startUp in class com.google.common.util.concurrent.AbstractScheduledService

Throws:

Exception

setExecutor

protected void setExecutor(Executor executor)

Sets the Executor to use when dispatching Notifications. This should only be used by unit tests to provide a mock executor.

Parameters:

executor - the executor to use (not {@code null).

runOneIteration

protected void runOneIteration()
                        throws Exception

Specified by:

runOneIteration in class com.google.common.util.concurrent.AbstractScheduledService

Throws:

Exception

scheduler

protected com.google.common.util.concurrent.AbstractScheduledService.Scheduler scheduler()

Returns a schedule that starts after 2 minute and runs every 2 minutes after runOneIteration() completes.

Specified by:

scheduler in class com.google.common.util.concurrent.AbstractScheduledService