com.ibm.soa.parlayx21.sms
Class SendSmsBindingStub

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

public class SendSmsBindingStub
extends com.ibm.ws.webservices.engine.client.Stub
implements SendSms


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
SendSmsBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)
           
 
Method Summary
 DeliveryInformation[] getSmsDeliveryStatus(java.lang.String requestIdentifier)
          The application invokes the getSmsDeliveryStatus operation to request the status of a previous SMS delivery request identified by requestIdentifier.
 java.lang.String sendSms(java.net.URI[] addresses, java.lang.String senderName, ChargingInformation charging, java.lang.String message, SimpleReference receiptRequest)
          The application invokes the sendSms operation to send an SMS message, specified by the String message.
 java.lang.String sendSmsLogo(java.net.URI[] addresses, java.lang.String senderName, ChargingInformation charging, byte[] image, SmsFormat smsFormat, SimpleReference receiptRequest)
          The application invokes the sendSmsLogo operation to send an SMS logo, specified by the byte array image.
 java.lang.String sendSmsRingtone(java.net.URI[] addresses, java.lang.String senderName, ChargingInformation charging, java.lang.String ringtone, SmsFormat smsFormat, SimpleReference receiptRequest)
          The application invokes the sendSmsRingtone operation to send an SMS ringtone, specified by the String ringtone (in RTX format).
 
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

SendSmsBindingStub

public SendSmsBindingStub(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

sendSms

public java.lang.String sendSms(java.net.URI[] addresses,
                                java.lang.String senderName,
                                ChargingInformation charging,
                                java.lang.String message,
                                SimpleReference receiptRequest)
                         throws java.rmi.RemoteException,
                                PolicyException,
                                ServiceException
Description copied from interface: SendSms

The application invokes the sendSms operation to send an SMS message, specified by the String message.

For GSM systems, if message contains characters not in the GSM 7-bit character set, the SMS is sent as a Unicode SMS.

If message is longer than the maximum supported length (for example, for GSM, 160 GSM 7-bit characters or 70 Unicode characters), the message content will be sent as several concatenated short messages.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.
  * SVC0004 - No valid addresses.
  * SVC0006 - Invalid group.
  * SVC0280 - Message too long.
  * SVC0283 - Delivery Receipt Notification not supported.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.
  * POL0006 - Groups not allowed.
  * POL0007 - Nested groups not allowed.
  * POL0008 - Charging not allowed.

Specified by:
sendSms in interface SendSms
Parameters:
addresses - xsd:anyURI [1..unbounded] Addresses to which the SMS will be sent
senderName - xsd:string If present, it indicates the SMS sender name, for example, the string that is displayed on the user's terminal as the originator of the message
charging - common:ChargingInformation Charge to apply to this message
message - xsd:string Text to be sent in SMS
receiptRequest - common:SimpleReference

It defines the application endpoint, interfaceName and correlator that will be used to notify the application when the message has been delivered to the terminal or if delivery is impossible .

Returns:
sendSmsResponse result xsd:string It identifies a specific SMS delivery request

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

sendSmsLogo

public java.lang.String sendSmsLogo(java.net.URI[] addresses,
                                    java.lang.String senderName,
                                    ChargingInformation charging,
                                    byte[] image,
                                    SmsFormat smsFormat,
                                    SimpleReference receiptRequest)
                             throws java.rmi.RemoteException,
                                    PolicyException,
                                    ServiceException
Description copied from interface: SendSms

The application invokes the sendSmsLogo operation to send an SMS logo, specified by the byte array image.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.
  * SVC0004 - No valid addresses.
  * SVC0006 - Invalid group.
  * SVC0281 - Unrecognized data format.
  * SVC0283 - Delivery Receipt Notification not supported.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.
  * POL0006 - Groups not allowed.
  * POL0007 - Nested groups not allowed.
  * POL0008 - Charging not allowed.

Specified by:
sendSmsLogo in interface SendSms
Parameters:
addresses - xsd:anyURI [1..unbounded] Addresses to which the SMS logo will be sent
senderName - xsd:string SMS sender name, for example, the string that is displayed on the user's terminal as the originator of the message
charging - common:ChargingInformation Charge to apply to this message
image - xsd:base64Binary The image in jpeg, gif or png format. The image will be scaled to the proper format
smsFormat - SmsFormat Conversion to be applied to the message prior to delivery. Possible values are: 'Ems' or 'SmartMessaging'
receiptRequest - common:SimpleReference

It defines the application endpoint, interfaceName and correlator that will be used to notify the application when the message has been delivered to the terminal or if delivery is impossible.

Returns:
result xsd:string It identifies a specific SMS delivery request
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

sendSmsRingtone

public java.lang.String sendSmsRingtone(java.net.URI[] addresses,
                                        java.lang.String senderName,
                                        ChargingInformation charging,
                                        java.lang.String ringtone,
                                        SmsFormat smsFormat,
                                        SimpleReference receiptRequest)
                                 throws java.rmi.RemoteException,
                                        PolicyException,
                                        ServiceException
Description copied from interface: SendSms

The application invokes the sendSmsRingtone operation to send an SMS ringtone, specified by the String ringtone (in RTX format).

Depending on the length of the ringtone, it may be sent as several concatenated short messages.

NOTE: In the RTX Ringtone Specification, an RTX file is a text file, containing the ringtone name, a control subclause and a subclause containing a comma separated sequence of ring tone commands.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.
  * SVC0004 - No valid addresses.
  * SVC0006 - Invalid group.
  * SVC0281 - Unrecognized data format.
  * SVC0283 - Delivery Receipt Notification not supported.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.
  * POL0006 - Groups not allowed.
  * POL0007 - Nested groups not allowed.
  * POL0008 - Charging not allowed.

Specified by:
sendSmsRingtone in interface SendSms
Parameters:
addresses - xsd:anyURI [1..unbounded] Addresses to which the SMS logo will be sent
senderName - xsd:string SMS sender name, for example, the string that is displayed on the user's terminal as the originator of the message
charging - common:ChargingInformation Charge to apply to this message
ringtone - xsd:string The ringtone in RTX format (see note above). (http://www.logomanager.co.uk/help/Edit/RTX.html)
smsFormat - SmsFormat Conversion to be applied to the message prior to delivery. Possible values are: 'Ems' or 'SmartMessaging'
receiptRequest - common:SimpleReference

It defines the application endpoint, interfaceName and correlator that will be used to notify the application when the message has been delivered to the terminal or if delivery is impossible.

Returns:
result xsd:string It identifies a specific SMS delivery request
Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getSmsDeliveryStatus

public DeliveryInformation[] getSmsDeliveryStatus(java.lang.String requestIdentifier)
                                           throws java.rmi.RemoteException,
                                                  PolicyException,
                                                  ServiceException
Description copied from interface: SendSms

The application invokes the getSmsDeliveryStatus operation to request the status of a previous SMS delivery request identified by requestIdentifier. The information on the status is returned in deliveryStatus, which is an array of status related to the request identified by requestIdentifier. The status is identified by a couplet indicating a user address and the associated delivery status. This method can be invoked multiple times by the application even if the status has reached a final value. However, after the status has reached a final value, status information will be available only for a limited period of time that should be specified in an off-line configuration step. The following five different SMS delivery status values have been identified:
  * DeliveredToNetwork: in case of concatenated messages, only when all the SMS-parts have been successfully delivered to the network.
  * DeliveryUncertain: for example, because it was handed off to another network.
  * DeliveryImpossible: unsuccessful delivery; the message could not be delivered before it expired.
  * MessageWaiting: the message is still queued for delivery.
  * DeliveredToTerminal: in case of concatenated messages, only when all the SMS-parts have been successfully delivered to the terminal.

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.

Specified by:
getSmsDeliveryStatus in interface SendSms
Parameters:
requestIdentifier - xsd:string It identifies a specific SMS delivery request
Returns:
result DeliveryInformation [0..unbounded]

It lists the variations on the delivery status of the SMS. Possible values are:
  * DeliveredToNetwork
  * DeliveryUncertain
  * DeliveryImpossible
  * MessageWaiting
  * DeliveredToTerminal

Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.