com.caplin.datasource.notification

Class Notification

java.lang.Object

com.caplin.datasource.notification.Notification

public class Notification
extends java.lang.Object

Notification represents a single notification to be sent to a client. It is identified by the uniqueId passed into the constructor. Methods are provided for setting field access.

Notifications are passed into the NotificationChannel.sendNotification(Notification) and NotificationChannel.sendNotifications(java.util.List<com.caplin.datasource.notification.Notification>) methods on the NotificationChannel received on NotificationApplicationListener callbacks.

The uniqueId is used in the subject in place of the '%i' in the '/PRIVATE/NOTIFICATIONS/DATASOURCES/%u/NOTIFY/[sourceName]-%i' notification namespace to create the record subject for this Notification. These notifications will be received by any listeners registered with a StreamLink Alerts API's NotificationService whereupon the uniqueId can be extracted.

When the Notification is sent on the NotificationChannel three fields are added to the notification. They include NotificationId, NotificationSource and NotificationTime. The NotificationSource is the source name that has been configured on the NotificationProvider. The NotificationId is set to "[source-name]-[uniqueId-of-notification]". The NotificationTime field will be set to the time in millis since 1970/01/01 at which the Notification is sent, however if this field has been set already using setField(String, String) then this set will be respected and the fields value won't be automatically replaced.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.Map<java.lang.String,java.lang.String>	fields
java.lang.String	uniqueId

Constructor Summary

Constructors

Constructor and Description
Notification(java.lang.String uniqueId)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getField(java.lang.String name)
java.util.Map<java.lang.String,java.lang.String>	getFields()
java.lang.String	getUniqueId()
void	setField(java.lang.String name, java.lang.String value)
void	setFields(java.util.Map<java.lang.String,java.lang.String> fieldMap)
RecordItem	toRecordItem(java.lang.String username, java.lang.String sourceName)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

uniqueId

public final java.lang.String uniqueId

fields

public java.util.Map<java.lang.String,java.lang.String> fields

Constructor Detail

Notification

public Notification(java.lang.String uniqueId)

Parameters:

uniqueId - Unique identifier for this Notification. This id is used when removing items from the NotificationChannel and in the callback in NotificationChannelListener.

Method Detail

getUniqueId

public java.lang.String getUniqueId()

Returns:

uniqueId The uniqueId this Notification was instantiated with.

getField

public java.lang.String getField(java.lang.String name)

Parameters:

name - Key associated with a value.

Returns:

Value of this field.

setField

public void setField(java.lang.String name,
            java.lang.String value)

Parameters:

name - Field name associate with a value. These must be present in the fields.conf used to configure the DataSource.

value - Value to send associated with this field name.

getFields

public java.util.Map<java.lang.String,java.lang.String> getFields()

Returns:

A map containing all fields present on this Notification.

setFields

public void setFields(java.util.Map<java.lang.String,java.lang.String> fieldMap)

Parameters:

fieldMap - Map of fields and values for this Notification. The field names must be present in the fields.conf used to configure the DataSource.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

String containing this Notification's uniqueId and fields.

toRecordItem

public RecordItem toRecordItem(java.lang.String username,
                      java.lang.String sourceName)