com.ibm.soa.parlayx21.multimedia_messaging
Interface MessageNotificationManager

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
MessageNotificationManager_RI
All Known Implementing Classes:
MessageNotificationManagerBindingStub, MessageNotificationManagerProxy

public interface MessageNotificationManager
extends java.rmi.Remote

The message notification manager manages the notifications of the application.

The multimedia message notification manager enables applications to set up and tear down notifications for multimedia messages, online. The means to provision notifications offline are not specified here.


Method Summary
 void startMessageNotification(SimpleReference reference, java.net.URI messageServiceActivationNumber, java.lang.String criteria)
          Start notifications to the application for a given Message Service activation number and criteria.
 void stopMessageNotification(java.lang.String correlator)
          The application may end a multimedia message notification using this operation.
 

Method Detail

startMessageNotification

void startMessageNotification(SimpleReference reference,
                              java.net.URI messageServiceActivationNumber,
                              java.lang.String criteria)
                              throws java.rmi.RemoteException,
                                     PolicyException,
                                     ServiceException

Start notifications to the application for a given Message Service activation number and criteria.

The messageServiceActivationNumber is an Address Data item, for example, a Shortcode, as defined in ES 202 391-1 [2].

The correlator provided in the reference must be unique for the application Web Service at the time the notification is initiated, otherwise a fault (SVC0005) will be returned to the application..

If specified, criteria will be used to filter messages that are to be delivered to an application. The use of criteria will allow different notification endpoints to receive notifications for the same messageServiceActivationNumber. If criteria are not provided, or is an empty string, then all messages for the messageServiceActivationNumber will be delivered to the application. If criteria values overlap then SVC0008 will be returned to the application and the notification will not be set up. The combination of messageServiceActivationNumber and criteria must be unique, so that a notification will be delivered to only one notification endpoint. If no match is found, the message will not be delivered to the application.

Referenced Faults

ServiceException from ES 202 391-1 [2]
  * SVC0001 Service error
  * SVC0002 Invalid input value
  * SVC0005 Duplicate correlator
  * SVC0008 Overlapping Criteria

PolicyException from ES 202 391-1 [2]
  * POL0001 Policy error

Parameters:
reference -

common: SimpleReference Notification endpoint definition

messageServiceActivationNumber - xsd:anyURI The destination address of the multimedia message
criteria - xsd:string

The text to match against to determine the application to receive the notification. This text is matched against the first word, as defined as the initial characters after discarding any leading Whitespace and ending with a Whitespace or end of the string. The matching shall be case-insensitive. If the subject of the multimedia message is present it shall be used as the string. If not, the string is defined as the first plain/text part of the content.

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

stopMessageNotification

void stopMessageNotification(java.lang.String correlator)
                             throws java.rmi.RemoteException,
                                    PolicyException,
                                    ServiceException
The application may end a multimedia message notification using this operation.

Referenced Faults

ServiceException from ES 202 391-1 [2]
  * SVC0001 – Service error
  * SVC0002 – Invalid input value

PolicyException from ES 202 391-1 [2]
  * POL0001 – Policy error

Parameters:
correlator - xsd:string Correlator of request to end
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.