com.ibm.soa.parlayx21.sms
Interface SmsNotificationManager

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
SmsNotificationManager_RI
All Known Implementing Classes:
SmsNotificationManagerBindingStub, SmsNotificationManagerProxy

public interface SmsNotificationManager
extends java.rmi.Remote

The short message notification manager enables applications to set up and tear down notifications for short messages online.


Method Summary
 void startSmsNotification(SimpleReference reference, java.net.URI smsServiceActivationNumber, java.lang.String criteria)
          This operation initiates notifications to the application for a given SMS Service activation number and criteria.
 void stopSmsNotification(java.lang.String correlator)
          The application may end a short message notification using this operation.
 

Method Detail

startSmsNotification

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

This operation initiates notifications to the application for a given SMS Service activation number and criteria.

The smsServiceActivationNumber 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 smsServiceActivationNumber. If criteria are not provided, or is an empty string, then all messages for the smsServiceActivationNumber 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 smsServiceActivationNumber 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
smsServiceActivationNumber - xsd:anyURI The destination address of the short 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 in the message, defined as the initial characters after discarding any leading Whitespace and ending with a Whitespace or end of message. The matching shall be case-insensitive.

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

stopSmsNotification

void stopSmsNotification(java.lang.String correlator)
                         throws java.rmi.RemoteException,
                                PolicyException,
                                ServiceException
The application may end a short 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.