com.ibm.soa.parlayx21.sms
Class SmsNotificationBindingStub

java.lang.Object
  extended by com.ibm.ws.webservices.engine.client.Stub
      extended by com.ibm.soa.parlayx21.sms.SmsNotificationBindingStub
All Implemented Interfaces:
SmsNotification, java.rmi.Remote, javax.xml.rpc.Stub

public class SmsNotificationBindingStub
extends com.ibm.ws.webservices.engine.client.Stub
implements SmsNotification


Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.ws.webservices.engine.client.Stub
com.ibm.ws.webservices.engine.client.Stub.Invoke
 
Field Summary
 
Fields inherited from class com.ibm.ws.webservices.engine.client.Stub
cachedEndpoint, cachedhttpProxyHost, cachedhttpProxyPassword, cachedhttpProxyPort, cachedhttpProxyUser, cachedhttpRedirectEnabled, cachedhttpsProxyHost, cachedhttpsProxyPassword, cachedhttpsProxyPort, cachedhttpsProxyUser, cachedPassword, cachedPortName, cachedProperties, cachedRequestSoapHeaders, cachedRequestTransportHeaders, cachedResponseSoapHeaders, cachedResponseSoapHeaderTemplates, cachedResponseTransportHeaders, cachedResponseTransportHeadersTemplate, cachedSessionContext, cachedsslCfgName, cachedTimeout, cachedUsername, cachedWriteTimeout, connection, engine, maintainSession, maintainSessionSet, messageContexts, service
 
Fields inherited from interface javax.xml.rpc.Stub
ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY
 
Constructor Summary
SmsNotificationBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)
           
 
Method Summary
 void notifySmsDeliveryReceipt(java.lang.String correlator, DeliveryInformation deliveryStatus)
          The notifySmsDeliveryReceipt operation must be implemented by a Web Service at the application side if it requires notification of SMS delivery receipt.
 void notifySmsReception(java.lang.String correlator, SmsMessage message)
          The notification is used to send a short message to the application.
 
Methods inherited from class com.ibm.ws.webservices.engine.client.Stub
_getProperty, _getPropertyNames, _setProperty, convert, getPassword, getPortName, getTimeout, getTypeMapping, getUsername, primeMessageContext, setMaintainSession, setPassword, setPortName, setPortName, setTimeout, setUsername, setWriteTimeout, validateSoapHeadersHashMap, validateTransportPropertiesHashMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SmsNotificationBindingStub

public SmsNotificationBindingStub(java.net.URL endpointURL,
                                  javax.xml.rpc.Service service)
                           throws com.ibm.ws.webservices.engine.WebServicesFault
Throws:
com.ibm.ws.webservices.engine.WebServicesFault
Method Detail

notifySmsReception

public void notifySmsReception(java.lang.String correlator,
                               SmsMessage message)
                        throws java.rmi.RemoteException
Description copied from interface: SmsNotification

The notification is used to send a short message to the application. The notification will occur only if the SMS fulfils the criteria specified when starting the SMS notification.

The notifySmsReception method must be implemented by a Web Service at the application side. It will be invoked by the Parlay X 2 server to notify the application of the reception of an SMS. The notification will occur if and only if the SMS received fulfils the criteria specified in a provisioning step, identified by the correlator. The criteria must at least include an smsServiceActivationNumber, for example, the SMS destination address that can be "monitored" by the application. The parameter senderAddress contains the address of the sender. The application can apply the appropriate service logic to process the SMS.

Referenced faults

None.

Specified by:
notifySmsReception in interface SmsNotification
Parameters:
correlator - xsd:string Correlator provided in request to set up this notification
message - SmsMessage Message received
Throws:
java.rmi.RemoteException

notifySmsDeliveryReceipt

public void notifySmsDeliveryReceipt(java.lang.String correlator,
                                     DeliveryInformation deliveryStatus)
                              throws java.rmi.RemoteException
Description copied from interface: SmsNotification
The notifySmsDeliveryReceipt operation must be implemented by a Web Service at the application side if it requires notification of SMS delivery receipt. It will be invoked by the Parlay X 2 server to notify the application when a SMS sent by an application has been delivered to the terminal of the recipient or if delivery is impossible. The notification will occur if and only if the status of the sent SMS is DeliveredToTerminal or DeliveryImpossible and the application has specified interest in notification when sending an SMS message by specifying the optional receiptRequest part. The correlator returned corresponds to the identifier specified by the application in the receiptRequest of the original sendSMS[Logo/Ringtone] request

When a SMS message is sent to multiple addresses, the server will send a notification for each terminal as and when a SMS message is delivered to the terminal.

The following three different SMS delivery status values will be returned in a notifySMSDeliveryReceiptResponse message:
  * DeliveryImpossible: unsuccessful delivery; the message could not be delivered before it expired.
  * DeliveredToTerminal: in case of concatenated messages, only when all the SMS-parts have been successfully delivered to the terminal.
  * DeliveredNotificationNotSupported: if notification is supported by the network but it does not support delivery receipt for one or more addresses specified in the sendSMS[Logo/Ringtone]Request message. The service will send this status for those addresses .

Referenced faults

None.

Specified by:
notifySmsDeliveryReceipt in interface SmsNotification
Parameters:
correlator - xsd:string The identifier defining the original ‘Send’ Request. This correlator was provided by the application in the sendSMS[Logo/Ringtone]Request message
deliveryStatus - DeliveryInformation

It lists the variations on the delivery status of the SMS to a terminal. Possible values are:
  * DeliveryImpossible
  * DeliveredToTerminal
  * DeliveryNotificationNotSupported

Throws:
java.rmi.RemoteException


Copyright © 2003 IBM Corp. All Rights Reserved.