com.ibm.soa.parlayx21.multimedia_messaging
Class MessageNotificationBindingStub

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

public class MessageNotificationBindingStub
extends com.ibm.ws.webservices.engine.client.Stub
implements MessageNotification


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
MessageNotificationBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)
           
 
Method Summary
 void notifyMessageDeliveryReceipt(java.lang.String correlator, DeliveryInformation deliveryStatus)
          The notifyMessageDeliveryReceipt method must be implemented by a Web Service at the application side if it requires notification of message delivery receipt.
 void notifyMessageReception(java.lang.String correlator, MessageReference message)
          The notification to the application will occur only if the multimedia message fulfils the criteria specified when starting the multimedia message notification.
 
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

MessageNotificationBindingStub

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

notifyMessageReception

public void notifyMessageReception(java.lang.String correlator,
                                   MessageReference message)
                            throws java.rmi.RemoteException
Description copied from interface: MessageNotification

The notification to the application will occur only if the multimedia message fulfils the criteria specified when starting the multimedia message notification.

Referenced faults

None.

Specified by:
notifyMessageReception in interface MessageNotification
Parameters:
correlator - xsd:string

Correlator provided in request to set up this notification.

message - MessageReference

This parameter contains all the information associated with the received message.

Throws:
java.rmi.RemoteException

notifyMessageDeliveryReceipt

public void notifyMessageDeliveryReceipt(java.lang.String correlator,
                                         DeliveryInformation deliveryStatus)
                                  throws java.rmi.RemoteException
Description copied from interface: MessageNotification
The notifyMessageDeliveryReceipt method must be implemented by a Web Service at the application side if it requires notification of message delivery receipt. It will be invoked by the Parlay X 2 server to notify the application when a message 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 message is DeliveredToTerminal or DeliveryImpossible and the application has specified interest in notification when sending a message by specifying the optional receiptRequest part. The correlator returned corresponds to the identifier specified by the application in the receiptRequest part of the original sendMessage request

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

The following three different message delivery status will be returned in the notifyMessageDeliveryReceiptRequest message:
  * DeliveryImpossible: unsuccessful delivery; the message could not be delivered before it expired.
  * DeliveredToTerminal: when the message has 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 sendMessageRequest message. The service will send this status for those addresses.

Referenced faults

None.

Specified by:
notifyMessageDeliveryReceipt in interface MessageNotification
Parameters:
correlator - xsd:string The identifier defining the original ‘Send’ Request. This correlator was provided by the application in the sendMessageRequest message
deliveryStatus - DeliveryInformation

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

Throws:
java.rmi.RemoteException


Copyright © 2003 IBM Corp. All Rights Reserved.