Skip navigation links

oracle.ocsg.sms.smpp.management
Interface SmsNotificationMBean

public interface SmsNotificationMBean

Method Summary

int	countOfflineNotificationCache() Count the number of entries in the offline notification cache.
int	countOnlineNotificationCache() Count the number of entries in the online notification cache.
int	countSmsCache() Count the number of entries in the sms caches (sum of MT and MO caches).
String	enableReceiveSms(String shortCode, String criteria, String appInstanceID) This method is used to add an offline notification for applications that will poll for MO messages.
NotificationInfo	getOfflineNotificationInfo(String correlator) Get the notification associated with the specified correlator.
NotificationInfo	getOnlineNotificationInfo(String correlator) Get the notification associated with the specified correlator.
String[]	listDeliveryStatusNotificationInfo() list all avaiable deliveryStatus notification information
String[]	listOfflineNotificationInfo() Lists all offline notifications (added using the OAM enableReceiveSms method).
String[]	listOnlineBinaryNotificationInfo() Lists all online Binary notifications (added using startBinarySmsNotification).
NotificationInfo[]	listOnlineNotificationInfo() Lists all online notifications (added using startSmsNotification).
void	modifyOnlineNotificationInfo(String correlator, String endPoint, String shortCode, String criteria, String appInstGroupID) Modify an existing Online sms notification using an existing correlator.
void	removeDeliveryStatusNotificationInfo(String registrationId) remove a delivery status notification information by prompt registrationId.
void	removeOfflineNotificationInfo(String registrationIdentifier) Remove an offline notification that was added using the OAM enableReceiveSms method
void	removeOnlineBinaryNotificationInfo(String correlator) Remove the specified online binary sms notification that was added using OAM interfaces or application interfaces (startBinarySmsNotification).
void	removeOnlineNotificationInfo(String correlator) Remove the specified online notification that was added using OAM interfaces or application interfaces (startSmsNotification).
String	startBinarySmsNotification(String endpoint, String shortCode, String appInstanceID) Add an online binary sms notification for applications that for some reason can not (or are not allowed) call the startBinarySmsNotification method.
String	startDeliveryStatusNotification(String endpoint, String senderAddress, String clientCorrelator, String notificationFormat, String callbackData, String appInstanceID, String serviceType) Add an delivery status notification for applications that for some reason can not (or are not allowed) call the start DeliveryStatus Notification method (OneAPI).
String	startSmsNotification(String endpoint, String shortCode, String criteria, String appInstanceID, String clientCorrelator, String callbackData, String notificationFormat, String serviceType) Add an online notification for applications that for some reason can not (or are not allowed) call the startSmsNotification method.

Method Detail

countOfflineNotificationCache

public int countOfflineNotificationCache()

Count the number of entries in the offline notification cache.

countOnlineNotificationCache

public int countOnlineNotificationCache()

Count the number of entries in the online notification cache.

countSmsCache

public int countSmsCache()

Count the number of entries in the sms caches (sum of MT and MO caches).

enableReceiveSms

public String enableReceiveSms(String shortCode,
                               String criteria,
                               String appInstanceID)

This method is used to add an offline notification for applications that will poll for MO messages. MO messages matching this notification will not result in a callback to an application, the application has to use the correlator returned by this method and poll for new messages.

Parameters:

shortCode - The destination address/service activation number of the short message with URI prefixed, e.g. t"el:6001".

criteria - The text to match against to determine the application to receive the notification.

appInstanceID - The applicationInstanceID to associate with this notification.

Returns:

the correlator uniquely identifying the new notification.

getOfflineNotificationInfo

public NotificationInfo getOfflineNotificationInfo(String correlator)

Get the notification associated with the specified correlator. An offline notification is a notification that has been added using the OAM enableReceiveSms method.

Parameters:

correlator -

getOnlineNotificationInfo

public NotificationInfo getOnlineNotificationInfo(String correlator)

Get the notification associated with the specified correlator. An online notification is a notification that has been added using startSmsNotification, through OAM interfaces or through an application interface.

Parameters:

correlator -

listDeliveryStatusNotificationInfo

public String[] listDeliveryStatusNotificationInfo()

list all avaiable deliveryStatus notification information

Returns:

array of delivery status information

listOfflineNotificationInfo

public String[] listOfflineNotificationInfo()

Lists all offline notifications (added using the OAM enableReceiveSms method).

listOnlineBinaryNotificationInfo

public String[] listOnlineBinaryNotificationInfo()

Lists all online Binary notifications (added using startBinarySmsNotification).

listOnlineNotificationInfo

public NotificationInfo[] listOnlineNotificationInfo()

Lists all online notifications (added using startSmsNotification).

modifyOnlineNotificationInfo

public void modifyOnlineNotificationInfo(String correlator,
                                         String endPoint,
                                         String shortCode,
                                         String criteria,
                                         String appInstGroupID)

Modify an existing Online sms notification using an existing correlator.

Parameters:

correlator -

removeDeliveryStatusNotificationInfo

public void removeDeliveryStatusNotificationInfo(String registrationId)

remove a delivery status notification information by prompt registrationId.

Parameters:

registrationId -

removeOfflineNotificationInfo

public void removeOfflineNotificationInfo(String registrationIdentifier)

Remove an offline notification that was added using the OAM enableReceiveSms method

Parameters:

registrationIdentifier -

removeOnlineBinaryNotificationInfo

public void removeOnlineBinaryNotificationInfo(String correlator)

Remove the specified online binary sms notification that was added using OAM interfaces or application interfaces (startBinarySmsNotification).

removeOnlineNotificationInfo

public void removeOnlineNotificationInfo(String correlator)

Remove the specified online notification that was added using OAM interfaces or application interfaces (startSmsNotification).

startBinarySmsNotification

public String startBinarySmsNotification(String endpoint,
                                         String shortCode,
                                         String appInstanceID)

Add an online binary sms notification for applications that for some reason can not (or are not allowed) call the startBinarySmsNotification method.

Parameters:

endpoint - The notification endpoint

shortCode - The destination address/service activation number of the short message

appInstanceID - The applicationInstanceID to associate with this notification.

startDeliveryStatusNotification

public String startDeliveryStatusNotification(String endpoint,
                                              String senderAddress,
                                              String clientCorrelator,
                                              String notificationFormat,
                                              String callbackData,
                                              String appInstanceID,
                                              String serviceType)

Add an delivery status notification for applications that for some reason can not (or are not allowed) call the start DeliveryStatus Notification method (OneAPI).

Parameters:

endpoint - the notification URL

senderAddress - the target sender address that the notification will be triggered.

clientCorrelator - the correlator which is passed by application for duplication check.

notificationFormat - current only two possible values: "XML", "JSON"

callbackData - the callbackData which is passed by application for association of request/response/notification.

appInstanceID -

serviceType - "0"= parlayX, "1" =parlayRest default is "1"

Returns:

registrationId

startSmsNotification

public String startSmsNotification(String endpoint,
                                   String shortCode,
                                   String criteria,
                                   String appInstanceID,
                                   String clientCorrelator,
                                   String callbackData,
                                   String notificationFormat,
                                   String serviceType)

Add an online notification for applications that for some reason can not (or are not allowed) call the startSmsNotification method.

Parameters:

endpoint - The notification endpoint.

shortCode - The destination address/service activation number of the short message

criteria - The text to match against to determine the application to receive the notification.

appInstanceID - The applicationInstanceID to associate with this notification.

clientCorrelator - correlator from application side

callbackData - callbackData

notificationFormat - "XML" or "JASON", null means "JSON"

serviceType - "1" = OneAPI/parlayRest and "0" = ParlayX21/30, default is "0"

Skip navigation links