Class NotificationConfiguration
Configuration for the Notifications Provider.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionNotificationConfiguration
(String sourceName) Instantiates a new NotificationConfiguration. -
Method Summary
Modifier and TypeMethodDescriptionGets the channel namespace.int
Get the current millisecond delay used for container throttlingGets the item namespace.Gets the notification source name.boolean
Returns true if image flags are set to true on each Notification record for its initial message, otherwise false.void
setContainerThrottleMillis
(int millis) Specify the millisecond delay used to throttle subsequent operations to a single container.void
setNotificationUsingImageFlag
(boolean useImageFlag) Set the Notification records' image flags to be set to true on publishing initial message.toString()
-
Field Details
-
internalConfiguration
public final com.caplin.container.Configuration internalConfiguration
-
-
Constructor Details
-
NotificationConfiguration
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
Gets the channel namespace.
- Returns:
- the channel namespace in the notification configuration
-
getItemNamespace
Gets the item namespace.
- Returns:
- the item namespace in the notification configuration
-
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
-