|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.ws.webservices.engine.client.Stub
com.ibm.soa.parlayx21.sms.SmsNotificationManagerBindingStub
public class SmsNotificationManagerBindingStub
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 | |
---|---|
SmsNotificationManagerBindingStub(java.net.URL endpointURL,
javax.xml.rpc.Service service)
|
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. |
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 |
---|
public SmsNotificationManagerBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service) throws com.ibm.ws.webservices.engine.WebServicesFault
com.ibm.ws.webservices.engine.WebServicesFault
Method Detail |
---|
public void startSmsNotification(SimpleReference reference, java.net.URI smsServiceActivationNumber, java.lang.String criteria) throws java.rmi.RemoteException, PolicyException, ServiceException
SmsNotificationManager
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.
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
startSmsNotification
in interface SmsNotificationManager
reference
- common:SimpleReference
Notification endpoint definitionsmsServiceActivationNumber
- xsd:anyURI
The destination address of the short messagecriteria
- 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.
java.rmi.RemoteException
PolicyException
ServiceException
public void stopSmsNotification(java.lang.String correlator) throws java.rmi.RemoteException, PolicyException, ServiceException
SmsNotificationManager
ServiceException from ES 202 391-1 [2]
* SVC0001 - Service error
* SVC0002 - Invalid input value
PolicyException from ES 202 391-1 [2]
* POL0001 - Policy error
stopSmsNotification
in interface SmsNotificationManager
correlator
- xsd:string
Correlator of request to end
java.rmi.RemoteException
PolicyException
ServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |