Parlay X Web Services Multimedia Messaging API 18-7
■
If an endpoint is already registered by another client application, or the registration ID is already being used, a Policy Error results.
■
Certain characters are not allowed in URIs; if it is necessary to include them in an address they can be encodedescaped. See the Oracle Fusion Middleware User
Messaging Service API Reference for java.net.URI for details on how to create a properly encoded URI. For example, when registering to receive XMPP messages
you must specify an address such as IM:jabber|userexample.com, however the pipe | character is not allowed in URIs, and must be escaped before submitting
to the server.
■
There is no guarantee that the server can actually receive messages at a given endpoint address. That depends on the overall configuration of Oracle User
Messaging Service, particularly the Messaging drivers that are deployed in the system. No error is indicated if a client binds to an address where the server
cannot receive messages.
The startReceiveMessage operation has the following inputs and outputs: Table 18–10
describes the startReceiveMessageRequest input messages for the startReceiveMessage operation.
There are no startReceiveMessageResponse output messages for the startReceiveMessage operation.
18.4.1.2 stopReceiveMessage Operation
Invoking this operation removes the previously-established binding between a client and a receiving endpoint. The client specifies the same registration ID that was
supplied when startReceiveMessage was called in order to identify the endpoint binding that is being broken. If there is no corresponding registration ID binding
known to the server for this application, a Policy Error results.
Table 18–11 describes the stopReceiveMessageRequest input messages for the
stopReceiveMessage operation.
There are no stopReceiveMessageResponse output messages for the stopReceiveMessage operation.
18.5 Parlay X Messaging Client API and Client Proxy Packages
While it is possible to assemble a Parlay X Messaging Client using only the Parlay X WSDL files and a Web Service assembly tool, we also provide pre-built Web Service
stubs and interfaces for the supported Parlay X Messaging interfaces. Due to difficulty
Table 18–10 startReceiveMessageRequest Input Message Descriptions
Part Name Part Type
Optional Description
registrationIdentifier xsd:string
No A registration identifier.
messageService ActivationNumber
xsd:anyURI No
Message Service Activation Number.
criteria xsd:string
Yes Descriptive string.
Table 18–11 stopReceiveMessageRequest Input Message Descriptions
Part Name Part Type
Optional Description
registrationIdentifier xsd:string
No A registration identifier.
18-8 Developers Guide
in assembling a Web Service with SOAP attachments in the style mandated by Parlay X, we recommend the use of the provided API rather than starting from WSDL.
For a complete listing of the classes available in the Parlay X Messaging API, see the Oracle Fusion Middleware User Messaging Service API Reference. The main entry
points for the API are through the following client classes:
■
oracle.sdp.parlayx.multimedia_messaging.send.SendMessageClient
■
oracle.sdp.parlayx.multimedia_messaging.receive.ReceiveMessageClient
■
oracle.sdp.parlayx.multimedia_messaging.extension.receive_manager. ReceiveMessageManager
Each client class allows a client application to invoke the operations in the corresponding interface. Additional Web Service parameters such as the remote
gateway URL and any required security credentials, are provided when an instance of the client class is constructed. See the Oracle Fusion Middleware User Messaging
Service API Reference for more details. The security credentials are propagated to the server using standard WS-Security headers, as mandated by the Parlay X specification.
The general process for a client application is to create one of the client classes above, set the necessary configuration items endpoint, username, password, then invoke
one of the business methods for example SendMessageClient.sendMessage, etc. For examples of how to use this API, see the Messaging samples on Oracle Technology
Network OTN, and specifically usermessagingsample-parlayx-src.zip.
18.6 Sample Chat Application with Parlay X APIs
This chapter describes how to create, deploy and run the sample chat application with Parlay X APIs provided with Oracle User Messaging Service on OTN.
This chapter contains the following sections:
■
Section 18.6.1, Overview
■
Section 18.6.2, Running the Pre-Built Sample
■
Section 18.6.3, Testing the Sample
■
Section 18.6.4, Creating a New Application Server Connection
18.6.1 Overview
This sample demonstrates how to create a Web-based chat application to send and receive messages through e-mail, SMS, or IM. The sample uses standards-based Parlay
X Web Service APIs to interact with a User Messaging server. The sample application includes web service proxy code for each of three Web service interfaces: the
SendMessage and ReceiveMessage services defined by Parlay X, and the ReceiveMessageManager service which is an Oracle extension to Parlay X. You must
define an Application Server connection in JDeveloper, and deploy and run the application.
The application is provided as a pre-built Oracle JDeveloper project that includes a simple web chat interface.
Note: To learn about the architecture and components of Oracle User
Messaging Service, see Oracle Fusion Middleware Getting Started with Oracle SOA Suite.
