Skip navigation links

oracle.ocsg.multimediamessaging.mm7.management
Interface MM7NotificationMBean

public interface MM7NotificationMBean

Method Summary

String	enableReceiveMms(String shortCode, String criteria, String appInstanceID) This method is used to add an offline notification for applications that will poll for MO messages.
String	enableReceiveMmsOneApi(String shortCode, String criteria, String appInstanceID) This method is used to add an offline subscription for OneApi 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[]	listOfflineNotificationInfo()
String[]	listOnlineDeliveryNotificationInfo()
String[]	listOnlineNotificationInfo()
void	removeOfflineNotificationInfo(String registrationIdentifier) Remove an offline notification that was added using the OAM enableReceiveMms method
void	removeOnlineDeliveryNotificationInfo(String subscriptionId) Remove the specified OneApi online delivery notification that was added using outbound subscription resource request.
void	removeOnlineNotificationInfo(String correlator) Remove the specified online notification that was added using OAM interfaces or application interfaces (startMessageNotification).
String	startMessageNotification(String endpoint, String shortCode, String criteria, String appInstanceID) Add an online notification for applications that for some reason can not (or are not allowed) call the startMessageNotification method.

Method Detail

enableReceiveMms

public String enableReceiveMms(String shortCode,
                               String criteria,
                               String appInstanceID)
                        throws ManagementException

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. "tel:6001".

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

appInstanceID - The applicationInstanceID to associate with this notification.

Returns:

Returns the correlator uniquely identifying the new notification (known as 'registrationIdentifier' in Parlay X)

Throws:

ManagementException

enableReceiveMmsOneApi

public String enableReceiveMmsOneApi(String shortCode,
                                     String criteria,
                                     String appInstanceID)
                              throws ManagementException

This method is used to add an offline subscription for OneApi 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. "tel:6001".

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

appInstanceID - The applicationInstanceID to associate with this notification.

Returns:

Returns the correlator uniquely identifying the new notification (known as 'registrationIdentifier' in Parlay X)

Throws:

ManagementException

getOfflineNotificationInfo

public NotificationInfo getOfflineNotificationInfo(String correlator)
                                            throws ManagementException

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

Throws:

ManagementException

getOnlineNotificationInfo

public NotificationInfo getOnlineNotificationInfo(String correlator)
                                           throws ManagementException

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

Throws:

ManagementException

listOfflineNotificationInfo

public String[] listOfflineNotificationInfo()
                                     throws ManagementException

Throws:

ManagementException

listOnlineDeliveryNotificationInfo

public String[] listOnlineDeliveryNotificationInfo()
                                            throws ManagementException

Throws:

ManagementException

listOnlineNotificationInfo

public String[] listOnlineNotificationInfo()
                                    throws ManagementException

Throws:

ManagementException

removeOfflineNotificationInfo

public void removeOfflineNotificationInfo(String registrationIdentifier)
                                   throws ManagementException

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

Parameters:

registrationIdentifier - registration identifier

Throws:

ManagementException

removeOnlineDeliveryNotificationInfo

public void removeOnlineDeliveryNotificationInfo(String subscriptionId)
                                          throws ManagementException

Remove the specified OneApi online delivery notification that was added using outbound subscription resource request.

Parameters:

subscriptionId -

Throws:

ManagementException

removeOnlineNotificationInfo

public void removeOnlineNotificationInfo(String correlator)
                                  throws ManagementException

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

Parameters:

correlator -

Throws:

ManagementException

startMessageNotification

public String startMessageNotification(String endpoint,
                                       String shortCode,
                                       String criteria,
                                       String appInstanceID)
                                throws ManagementException

Add an online notification for applications that for some reason can not (or are not allowed) call the startMessageNotification 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.

Returns:

Returns the correlator uniquely identifying the new notification.

Throws:

ManagementException

Skip navigation links