com.ibm.soa.parlayx21.sms
Class ReceiveSmsBindingStub

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

public class ReceiveSmsBindingStub
extends com.ibm.ws.webservices.engine.client.Stub
implements ReceiveSms


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
ReceiveSmsBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)
           
 
Method Summary
 SmsMessage[] getReceivedSms(java.lang.String registrationIdentifier)
          The invocation of getReceivedSms retrieves all the SMS messages received that fulfil the criteria identified by registrationIdentifier.
 
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

ReceiveSmsBindingStub

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

getReceivedSms

public SmsMessage[] getReceivedSms(java.lang.String registrationIdentifier)
                            throws java.rmi.RemoteException,
                                   PolicyException,
                                   ServiceException
Description copied from interface: ReceiveSms

The invocation of getReceivedSms retrieves all the SMS messages received that fulfil the criteria identified by registrationIdentifier. The method returns only the list of SMS messages received since the previous invocation of the same method, for example, each time the method is executed the messages returned are removed from the server. Moreover, each SMS message will be automatically removed from the server after a maximum time interval specified in an off-line configuration step.

The received SMS messages are returned in receivedSms. An SMS message is identified by a structure indicating the sender of the SMS message and the content.

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:
getReceivedSms in interface ReceiveSms
Parameters:
registrationIdentifier - xsd:string Identifies the off-line provisioning step that enables the application to receive notification of SMS reception according to specified criteria
Returns:
result SmsMessage [0..unbounded] It lists the received SMS since last invocation
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.