com.caplin.datasource.notification

Class NotificationConfiguration

java.lang.Object

com.caplin.datasource.notification.NotificationConfiguration

public class NotificationConfiguration
extends java.lang.Object

The type NotificationConfiguration, which can be used to create a NotificationProvider instance.

Field Summary

Fields

Modifier and Type	Field and Description
Configuration	internalConfiguration

Constructor Summary

Constructors

Constructor and Description
NotificationConfiguration(java.lang.String sourceName) Instantiates a new NotificationConfiguration.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getChannelNamespace() Gets the channel namespace.
java.lang.String	getItemNamespace() Gets the item namespace.
java.lang.String	getSourceName() Gets the notification source name.
boolean	isNotificationUsingImageFlag() Returns true if image flags are set to true on each Notification record for its initial message, otherwise false.
void	setNotificationUsingImageFlag(boolean useImageFlag) Set the Notification records' image flags to be set to true on publishing initial message.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

internalConfiguration

public final Configuration internalConfiguration

Constructor Detail

NotificationConfiguration

public NotificationConfiguration(java.lang.String sourceName)

Instantiates a new NotificationConfiguration.

The sourceName can anything but without spaces is preferable. It will appear in the logging.

Parameters:

sourceName - the NotificationProvider identifier

Method Detail

isNotificationUsingImageFlag

public boolean isNotificationUsingImageFlag()

Returns true if image flags are set to true on each Notification record for its initial message, otherwise false.

Returns:

Returns true if Notification records use image flags

setNotificationUsingImageFlag

public void setNotificationUsingImageFlag(boolean useImageFlag)

Set the Notification records' image flags to be set to true on publishing initial message.

The default, recommended setting is true. The use case for setting to false is to prevent notifications' fields being overwritten when two providers provide for the same Notifications.

Parameters:

useImageFlag - boolean used to set the channel items image flags

getChannelNamespace

public java.lang.String getChannelNamespace()

Gets the channel namespace.

Returns:

the channel namespace in the notification configuration

getItemNamespace

public java.lang.String getItemNamespace()

Gets the item namespace.

Returns:

the item namespace in the notification configuration

getSourceName

public java.lang.String getSourceName()

Gets the notification source name.

Returns:

the notification source name in the notification configuration

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object