Index

A C D E F G I J L M N O P R S T U 
All Classes and Interfaces|All Packages|Constant Field Values

A

addExtraNotificationFields(Notification, String, String) - Static method in class com.caplin.datasource.notification.impl.NotificationFields
 

C

callbackChannelListener(String, String) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
closeable() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
closeChannel() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
closeChannel() - Method in interface com.caplin.datasource.notification.NotificationChannel
Closes the channel.
closeChannel(String) - Method in interface com.caplin.datasource.notification.impl.NotificationProviderInternal
 
closeChannel(String) - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
com.caplin.datasource.notification - package com.caplin.datasource.notification
This package contains the public elements of the Notification API.
com.caplin.datasource.notification.impl - package com.caplin.datasource.notification.impl
 
com.caplin.datasource.notification.impl.namespace - package com.caplin.datasource.notification.impl.namespace
 
containerRequested() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
controlChannelOpen() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
createCleardownSubject(String, String) - Static method in class com.caplin.datasource.notification.impl.NotificationSubjects
 
createConstiuentCleardownPrefix(String) - Method in class com.caplin.datasource.notification.impl.NotificationSubjectFactory
 
createNestingRecordSubject(ContainerItem, String) - Method in class com.caplin.datasource.notification.impl.NotificationSubjectFactory
 
createSubcontainerCleardownPrefix(String) - Method in class com.caplin.datasource.notification.impl.NotificationSubjectFactory
 
currentTimeMillis() - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 

D

deleteNotification(String, String) - Method in interface com.caplin.datasource.notification.impl.NotificationProviderInternal
 
deleteNotification(String, String) - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
deleteNotification(String, String) - Method in class com.caplin.datasource.notification.NotificationProvider
 

E

execute(Runnable) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 

F

fields - Variable in class com.caplin.datasource.notification.Notification
 
fromJavaLogLevel(Level) - Static method in class com.caplin.datasource.notification.impl.JavaUtils
 

G

getChannelCount() - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
getChannelNamespace() - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
getChannelNamespace() - Method in class com.caplin.datasource.notification.NotificationConfiguration
Gets the channel namespace.
getContainerThrottleMillis() - Method in class com.caplin.datasource.notification.NotificationConfiguration
Get the current millisecond delay used for container throttling
getControlSubject(String) - Static method in class com.caplin.datasource.notification.impl.NotificationSubjects
 
getField(String) - Method in class com.caplin.datasource.notification.Notification
 
getFields() - Method in class com.caplin.datasource.notification.Notification
 
getInstantiationTime() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
getInstantiationTime() - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
getItemCount() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
getItemFields(String) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
getItemNamespace() - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
getItemNamespace() - Method in class com.caplin.datasource.notification.NotificationConfiguration
Gets the item namespace.
getItemSubjects() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
getKey() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
getLibraryVersion() - Static method in class com.caplin.datasource.notification.impl.NotificationVersion
 
getLogLevel() - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
getMasterContainerItemSubject(String) - Static method in class com.caplin.datasource.notification.impl.NotificationSubjects
 
getMasterContainerSubject() - Static method in class com.caplin.datasource.notification.impl.NotificationSubjects
 
getMonitoringKey() - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
getMonitoringService() - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
getNotificationContainerNamespace() - Static method in class com.caplin.datasource.notification.impl.NotificationSubjects
 
getNotificationContainerSubject(String) - Static method in class com.caplin.datasource.notification.impl.NotificationSubjects
 
getNotificationCount() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
getNotificationSubject(String, String, String) - Static method in class com.caplin.datasource.notification.impl.NotificationSubjects
 
getRandomUniqueId() - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
getSourceName() - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
getSourceName() - Method in class com.caplin.datasource.notification.NotificationConfiguration
Gets the notification source name.
getSubject() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
getSubject() - Method in interface com.caplin.datasource.notification.NotificationChannel
Returns the subject for the channel.
getUniqueId() - Method in class com.caplin.datasource.notification.Notification
 
getUsername() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
getUsername() - Method in interface com.caplin.datasource.notification.NotificationChannel
Returns the username for the channel
getUserNotificationSubjectPrefix(String) - Static method in class com.caplin.datasource.notification.impl.NotificationSubjects
 
getVersion() - Method in interface com.caplin.datasource.notification.impl.NotificationProviderInternal
 
getVersion() - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
getVersion() - Method in class com.caplin.datasource.notification.NotificationProvider
Get the Notification API version.

I

internalConfiguration - Variable in class com.caplin.datasource.notification.NotificationConfiguration
 
isNotificationUsingImageFlag() - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
isNotificationUsingImageFlag() - Method in class com.caplin.datasource.notification.NotificationConfiguration
Returns true if image flags are set to true on each Notification record for its initial message, otherwise false.

J

JavaUtils - Class in com.caplin.datasource.notification.impl
 
JavaUtils() - Constructor for class com.caplin.datasource.notification.impl.JavaUtils
 

L

log(LogLevel, String) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
longToString(long) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 

M

MASTER_CONTAINER_ITEM_NAMESPACE - Static variable in class com.caplin.datasource.notification.impl.NotificationSubjects
 
MASTER_CONTAINER_SUBJECT - Static variable in class com.caplin.datasource.notification.impl.NotificationSubjects
 
match(String) - Method in class com.caplin.datasource.notification.impl.namespace.NotificationChannelNamespace
 
match(String) - Method in class com.caplin.datasource.notification.impl.namespace.NotificationItemNamespace
 
match(String) - Method in class com.caplin.datasource.notification.impl.NotificationNamespace
 

N

Notification - Class in com.caplin.datasource.notification
Notification represents a single notification to be sent to a client.
Notification(String) - Constructor for class com.caplin.datasource.notification.Notification
 
NOTIFICATION_CONTAINER_NAMESPACE - Static variable in class com.caplin.datasource.notification.impl.NotificationSubjects
 
NOTIFICATION_CONTROL_NAMESPACE - Static variable in class com.caplin.datasource.notification.impl.NotificationSubjects
 
NOTIFICATION_ID_KEY - Static variable in class com.caplin.datasource.notification.impl.NotificationFields
 
NOTIFICATION_NAMESPACE - Static variable in class com.caplin.datasource.notification.impl.NotificationSubjects
 
NOTIFICATION_OPERATION_KEY - Static variable in class com.caplin.datasource.notification.impl.NotificationFields
 
NOTIFICATION_SOURCE_KEY - Static variable in class com.caplin.datasource.notification.impl.NotificationFields
 
NOTIFICATION_TIME_KEY - Static variable in class com.caplin.datasource.notification.impl.NotificationFields
 
NotificationApplicationListener - Interface in com.caplin.datasource.notification
You must implement this interface.
NotificationChannel - Interface in com.caplin.datasource.notification
The NotificationChannel is a notification communication channel associated with a particular user.
notificationChannelClosed(NotificationChannel) - Method in interface com.caplin.datasource.notification.NotificationApplicationListener
Callback invoked when a discard for a notification channel is received.
NotificationChannelImpl - Class in com.caplin.datasource.notification.impl
 
NotificationChannelImpl(Runtime, String, NestableContainer, NotificationConfiguration) - Constructor for class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
NotificationChannelListener - Interface in com.caplin.datasource.notification
You should implement (and register) the NotificationChannelListener if you want to receive a callback when a user has dismissed a notification from their screen.
NotificationChannelNamespace - Class in com.caplin.datasource.notification.impl.namespace
 
NotificationChannelNamespace() - Constructor for class com.caplin.datasource.notification.impl.namespace.NotificationChannelNamespace
 
notificationChannelOpened(NotificationChannel) - Method in interface com.caplin.datasource.notification.NotificationApplicationListener
Callback invoked when a request for the notification channel is received.
NotificationConfiguration - Class in com.caplin.datasource.notification
Configuration for the Notifications Provider.
NotificationConfiguration(String) - Constructor for class com.caplin.datasource.notification.NotificationConfiguration
Instantiates a new NotificationConfiguration.
NotificationContrib - Class in com.caplin.datasource.notification.impl
 
NotificationFields - Class in com.caplin.datasource.notification.impl
 
NotificationFields() - Constructor for class com.caplin.datasource.notification.impl.NotificationFields
 
NotificationItemNamespace - Class in com.caplin.datasource.notification.impl.namespace
 
NotificationItemNamespace() - Constructor for class com.caplin.datasource.notification.impl.namespace.NotificationItemNamespace
 
NotificationNamespace - Class in com.caplin.datasource.notification.impl
Created by chsitter on 15/12/14.
NotificationNamespace(NotificationConfiguration) - Constructor for class com.caplin.datasource.notification.impl.NotificationNamespace
 
NotificationProvider - Class in com.caplin.datasource.notification
If you want to manage notifications within your application you MUST create an instance of this class.
NotificationProvider(DataSource, NotificationConfiguration, NotificationApplicationListener) - Constructor for class com.caplin.datasource.notification.NotificationProvider
Create a NotificationProvider registering your application.
NotificationProviderInternal - Interface in com.caplin.datasource.notification.impl
 
NotificationProviderInternalImpl - Class in com.caplin.datasource.notification.impl
 
NotificationProviderInternalImpl(Runtime, NotificationConfiguration, NotificationApplicationListener) - Constructor for class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
NotificationSubjectFactory - Class in com.caplin.datasource.notification.impl
 
NotificationSubjectFactory(Runtime) - Constructor for class com.caplin.datasource.notification.impl.NotificationSubjectFactory
 
NotificationSubjects - Class in com.caplin.datasource.notification.impl
 
NotificationSubjects() - Constructor for class com.caplin.datasource.notification.impl.NotificationSubjects
 
NotificationVersion - Class in com.caplin.datasource.notification.impl
 
NotificationVersion() - Constructor for class com.caplin.datasource.notification.impl.NotificationVersion
 

O

onCacheMiss(String) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
onCacheMiss(String) - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
onContainerDiscard(String) - Method in interface com.caplin.datasource.notification.impl.NotificationProviderInternal
 
onContainerDiscard(String) - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
onContainerRequest(String) - Method in interface com.caplin.datasource.notification.impl.NotificationProviderInternal
 
onContainerRequest(String) - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
onContribReceived(String, Map<String, String>) - Method in interface com.caplin.datasource.notification.impl.NotificationProviderInternal
 
onContribReceived(String, Map<String, String>) - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
onDecrement(int) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
onIncrement(int) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
onNotificationAction(NotificationChannel, String, String) - Method in interface com.caplin.datasource.notification.NotificationChannelListener
Called when a contrib comes in for a Notification serviced by this provider.
onNotificationRequest(NotificationChannel, String) - Method in interface com.caplin.datasource.notification.NotificationChannelListener
Called when a previously unsubmitted notification in a channel is requested.
onRecordDiscard(String) - Method in interface com.caplin.datasource.notification.impl.NotificationProviderInternal
 
onRecordDiscard(String) - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
onRecordRequest(String) - Method in interface com.caplin.datasource.notification.impl.NotificationProviderInternal
 
onRecordRequest(String) - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
openChannel(String) - Method in interface com.caplin.datasource.notification.impl.NotificationProviderInternal
 
openChannel(String) - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 

P

printInvalidReasons(String) - Method in class com.caplin.datasource.notification.impl.NotificationContrib
 
publishContainerNotFound(String) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
publishContainerStatusOk(String) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
publishContainerStatusOk(String, String) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
publishContainerStatusStale(String) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
publishContainerStatusStale(String, String) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
publishContainerUpdate(String, ContainerUpdate, boolean, boolean) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
publishDeleteContainer(String) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
publishDeleteRecord(String) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
publishMappingMessage(String, String, boolean) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
publishNotification(String, Notification) - Method in interface com.caplin.datasource.notification.impl.NotificationProviderInternal
 
publishNotification(String, Notification) - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
publishNotification(String, Notification) - Method in class com.caplin.datasource.notification.NotificationProvider
 
publishRecordNotFound(String) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
publishRecordStatusOk(String) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
publishRecordStatusStale(String) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
publishRecordUpdate(String, RecordUpdate, boolean, boolean) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
publishRemoveContainerElements(String, List<String>) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 

R

removeNotification(String) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
removeNotification(String) - Method in interface com.caplin.datasource.notification.NotificationChannel
Removes the Notification from the internal cache and sends a container remove so that this notification is no longer requested when the channel is subscribed to.
removeNotifications(List<String>) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
removeNotifications(List<String>) - Method in interface com.caplin.datasource.notification.NotificationChannel
Removes Notifications from the internal cache and sends a container remove so that these notifications are no longer requested when the channel is subscribed to.
RuntimeImpl - Class in com.caplin.datasource.notification.impl
 
RuntimeImpl(DataSource, NotificationConfiguration, ActivePublisher, ActivePublisher) - Constructor for class com.caplin.datasource.notification.impl.RuntimeImpl
 

S

schedule(Runnable, long, Object) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
sendEmptyNotificationContainer() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
sendEmptyNotificationContainer() - Method in interface com.caplin.datasource.notification.NotificationChannel
Sends an empty container on the channel.
sendNotification(Notification) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
sendNotification(Notification) - Method in interface com.caplin.datasource.notification.NotificationChannel
Adds the Notification to the internal cache and sends a container add so that this notification is requested when the channel is subscribed to.
sendNotificationContainerStatusOk() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
sendNotificationContainerStatusOk() - Method in interface com.caplin.datasource.notification.NotificationChannel
Sends a status ok on the channel.
sendNotificationContainerStatusStale() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
sendNotificationContainerStatusStale() - Method in interface com.caplin.datasource.notification.NotificationChannel
Sends a status stale on the channel.
sendNotificationNotFound(String) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
sendNotificationNotFound(String) - Method in interface com.caplin.datasource.notification.NotificationChannel
Sends a not found for a Notification.
sendNotifications(List<Notification>) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
sendNotifications(List<Notification>) - Method in interface com.caplin.datasource.notification.NotificationChannel
Adds Notifications to the internal cache and sends a container add so that these items are requested when the channel is subscribed to.
sendNotificationStatusOk(String) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
sendNotificationStatusOk(String) - Method in interface com.caplin.datasource.notification.NotificationChannel
Send status ok for a Notification.
sendNotificationStatusStale(String) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
sendNotificationStatusStale(String) - Method in interface com.caplin.datasource.notification.NotificationChannel
Send status stale for a Notification.
setContainerRequested(boolean) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
setContainerThrottleMillis(int) - Method in class com.caplin.datasource.notification.NotificationConfiguration
Specify the millisecond delay used to throttle subsequent operations to a single container.
setControlChannelOpen(boolean) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
setField(String, String) - Method in class com.caplin.datasource.notification.Notification
 
setFields(Map<String, String>) - Method in class com.caplin.datasource.notification.Notification
 
setNotificationChannelListener(NotificationChannelListener) - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
setNotificationChannelListener(NotificationChannelListener) - Method in interface com.caplin.datasource.notification.NotificationChannel
Your application SHOULD set a NotificationChannelListener on the channel.
setNotificationUsingImageFlag(boolean) - Method in class com.caplin.datasource.notification.NotificationConfiguration
Set the Notification records' image flags to be set to true on publishing initial message.

T

toJavaLogLevel(LogLevel) - Static method in class com.caplin.datasource.notification.impl.JavaUtils
 
toRecordItem(String, String) - Method in class com.caplin.datasource.notification.Notification
 
toString() - Method in class com.caplin.datasource.notification.impl.namespace.NotificationChannelNamespace
 
toString() - Method in class com.caplin.datasource.notification.impl.namespace.NotificationItemNamespace
 
toString() - Method in class com.caplin.datasource.notification.impl.NotificationChannelImpl
 
toString() - Method in class com.caplin.datasource.notification.impl.NotificationProviderInternalImpl
 
toString() - Method in class com.caplin.datasource.notification.Notification
 
toString() - Method in class com.caplin.datasource.notification.NotificationConfiguration
 

U

uniqueId - Variable in class com.caplin.datasource.notification.Notification
 
userCallback(Runnable) - Method in class com.caplin.datasource.notification.impl.RuntimeImpl
 
A C D E F G I J L M N O P R S T U 
All Classes and Interfaces|All Packages|Constant Field Values