com.ibm.soa.parlayx21.multimedia_messaging
Class ReceiveMessageBindingStub

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

public class ReceiveMessageBindingStub
extends com.ibm.ws.webservices.engine.client.Stub
implements ReceiveMessage


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
ReceiveMessageBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)
           
 
Method Summary
 void getMessage(java.lang.String messageRefIdentifier)
          This method will read the whole message.
 MessageURI getMessageURIs(java.lang.String messageRefIdentifier)
          This method will read the different parts of the message, create local files in the Parlay Gateway and return URI references to them.
 MessageReference[] getReceivedMessages(java.lang.String registrationIdentifier, MessagePriority priority)
          This method enables the application to poll for new messages associated with a specific 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

ReceiveMessageBindingStub

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

getReceivedMessages

public MessageReference[] getReceivedMessages(java.lang.String registrationIdentifier,
                                              MessagePriority priority)
                                       throws java.rmi.RemoteException,
                                              PolicyException,
                                              ServiceException
Description copied from interface: ReceiveMessage

This method enables the application to poll for new messages associated with a specific registrationIdentifier. If the registrationIdentifier is not specified, the Parlay X server will return references to all messages sent to the application. The process of binding different registrationIdentifier parameters to applications is an off-line process. The Parlay X gateway shall not allow an application to poll for messages using registrationIdentifier parameters that are not associated with the application. The priority parameter may be used by the application to retrieve references to higher priority messages, for example, if Normal is chosen only references to high priority and normal priority messages are returned. If the priority parameter is omitted all message references are returned.

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:
getReceivedMessages in interface ReceiveMessage
Parameters:
registrationIdentifier - xsd:string

Identifies the off-line provisioning step that enables the application to receive notification of Message reception according to specified criteria.

priority - MessagePriority

The priority of the messages to poll from the Parlay X gateway. All messages of the specified priority and higher will be retrieved. If not specified, all messages shall be returned, for example, the same as specifying Low.

Returns:
result MessageReference [0..unbounded]

It contains an array of messages received according to the specified filter of registrationIdentifier and priority.

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getMessageURIs

public MessageURI getMessageURIs(java.lang.String messageRefIdentifier)
                          throws java.rmi.RemoteException,
                                 PolicyException,
                                 ServiceException
Description copied from interface: ReceiveMessage

This method will read the different parts of the message, create local files in the Parlay Gateway and return URI references to them. The application can then simply read each file or just have them presented as links to the end-user. The URIs to the files will be active for an agreed time.

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:
getMessageURIs in interface ReceiveMessage
Parameters:
messageRefIdentifier - xsd:string

The identity of the message to retrieve.

Returns:
result MessageURI

It contains the complete message, for example, the textual part of the message, if such exists, and a list of file references for the message attachments, if any.

Throws:
java.rmi.RemoteException
PolicyException
ServiceException

getMessage

public void getMessage(java.lang.String messageRefIdentifier)
                throws java.rmi.RemoteException,
                       PolicyException,
                       ServiceException
Description copied from interface: ReceiveMessage

This method will read the whole message. The data is returned as an attachment, as defined in SOAP Messages with Attachments [3], in the return message.

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:
getMessage in interface ReceiveMessage
Parameters:
messageRefIdentifier - xsd:string The identity of the message
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.