Package com.caplin.datasource.notification

Class NotificationConfiguration

java.lang.Object
com.caplin.datasource.notification.NotificationConfiguration
public class NotificationConfiguration extends Object

Configuration for the Notifications Provider.

  • Field Details

    • internalConfiguration

      public final com.caplin.container.Configuration internalConfiguration

  • Constructor Details

    • NotificationConfiguration

      public NotificationConfiguration(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 Details

    • 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 String getChannelNamespace()

      Gets the channel namespace.

      Returns:
      the channel namespace in the notification configuration

    • getItemNamespace

      public String getItemNamespace()

      Gets the item namespace.

      Returns:
      the item namespace in the notification configuration

    • getSourceName

      public String getSourceName()

      Gets the notification source name.

      Returns:
      the notification source name in the notification configuration

    • setContainerThrottleMillis

      public void setContainerThrottleMillis(int millis)

      Specify the millisecond delay used to throttle subsequent operations to a single container. This essentially combines multiple addElement calls into one single container update if all the adds happen within the throttle millisecond period

      Parameters:
      millis - millisecond delay used for throttling

    • getContainerThrottleMillis

      public int getContainerThrottleMillis()

      Get the current millisecond delay used for container throttling

      Returns:
      current millisecond delay for container throttling

    • toString

      public String toString()
      Overrides:
      toString in class Object