Skip navigation links

oracle.ocsg.multimediamessaging.mm7.management
Interface MM7NotificationMBean

public interface MM7NotificationMBean

Method Summary

String	enableReceiveMms(String shortCode, String criteria, String appInstanceID) Used to add an offline notification for applications that will poll for MO messages.
String	enableReceiveMmsOneApi(String shortCode, String criteria, String appInstanceID) Used to add an offline subscription for OneApi applications that will poll for MO messages.
NotificationInfo	getOfflineNotificationInfo(String correlator) Gets the notification associated with the specified correlator.
NotificationInfo	getOnlineNotificationInfo(String correlator) Gets the notification associated with the specified correlator.
String[]	listOfflineNotificationInfo()
String[]	listOnlineDeliveryNotificationInfo()
String[]	listOnlineNotificationInfo()
void	removeOfflineNotificationInfo(String registrationIdentifier) Removes an offline notification that was added using the OAM enableReceiveMms method.
void	removeOnlineDeliveryNotificationInfo(String subscriptionId) Removes the specified OneApi online delivery notification that was added using outbound subscription resource request.
void	removeOnlineNotificationInfo(String correlator) Removes the specified online notification that was added using OAM interfaces or application interfaces (startMessageNotification).
String	startMessageNotification(String endpoint, String shortCode, String criteria, String appInstanceID) Creates an online notification on behalf of an application.

Method Detail

enableReceiveMms

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

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.

Scope: Cluster

Parameters:

shortCode - The destination address/service activation number of the short message with URI prefixed, for example, "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

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.

Scope: Cluster

Parameters:

shortCode - The destination address/service activation number of the short message with URI prefixed, for example, "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

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

Scope: Cluster

Throws:

ManagementException

getOnlineNotificationInfo

public NotificationInfo getOnlineNotificationInfo(String correlator)
                                           throws ManagementException

Gets 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.

Scope: Cluster

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

Removes an offline notification that was added using the OAM enableReceiveMms method.

Scope: Cluster

Parameters:

registrationIdentifier - registration identifier.

Throws:

ManagementException

removeOnlineDeliveryNotificationInfo

public void removeOnlineDeliveryNotificationInfo(String subscriptionId)
                                          throws ManagementException

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

Scope: Cluster

Parameters:

subscriptionId - subscription identifier.

Throws:

ManagementException

removeOnlineNotificationInfo

public void removeOnlineNotificationInfo(String correlator)
                                  throws ManagementException

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

Scope: Cluster

Parameters:

correlator - uniquely identifying the notification to be removed.

Throws:

ManagementException

startMessageNotification

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

Creates an online notification on behalf of an application. Produces the same results as if an application registered for notifications using the startMessageNotification method in the Parlay X 2.1 Multimedia Messaging MessageNotificationManager interface. This method can be used, for example, if the application is not allowed to register for notifications by restrictions defined in its SLA. Returns a correlator that uniquely identifies the notification.

Scope: Cluster

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