org.apache.ambari.server.notifications

Class Notification

java.lang.Object

org.apache.ambari.server.notifications.Notification

Direct Known Subclasses:

AlertNotification

public class Notification
extends Object

The Notification class is a generic way to relay content through an NotificationDispatcher.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Notification.Type The Notification.Type enumeration represents the type of notification being sent to a NotificationDispatcher.

Field Summary

Fields

Modifier and Type	Field and Description
String	Body The main content of the notification.
DispatchCallback	Callback An optional callback implementation that the dispatcher can use to report success/failure on delivery.
List<String>	CallbackIds An option list of unique IDs that will identify the origins of this notification.
DispatchCredentials	Credentials The optional credentials used to authenticate with the dispatcher.
Map<String,String>	DispatchProperties A map of all of the properties that a NotificationDispatcher needs in order to dispatch this notification.
List<Recipient>	Recipients The optional recipients of the notification.
String	Subject A short summary of the notification.

Constructor Summary

Constructors

Constructor and Description
Notification()

Method Summary

Modifier and Type	Method and Description
Notification.Type	getType() Gets the type of notificaton.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

Subject

public String Subject

A short summary of the notification.

Body

public String Body

The main content of the notification.

Recipients

public List<Recipient> Recipients

The optional recipients of the notification. Some dispatchers may not require explicit recipients.

DispatchProperties

public Map<String,String> DispatchProperties

A map of all of the properties that a NotificationDispatcher needs in order to dispatch this notification.

Credentials

public DispatchCredentials Credentials

The optional credentials used to authenticate with the dispatcher.

Callback

public DispatchCallback Callback

An optional callback implementation that the dispatcher can use to report success/failure on delivery.

CallbackIds

public List<String> CallbackIds

An option list of unique IDs that will identify the origins of this notification.

Constructor Detail

Notification

public Notification()

Method Detail

getType

public Notification.Type getType()

Gets the type of notificaton.

Returns:

the type (never null).

toString

public String toString()

Overrides:

toString in class Object