Use SOAP over JMS to transport web services
Use the SOAP over JMS transport protocol as an alternative to SOAP over HTTP for communicating SOAP messages between clients and servers.
A web service must be implemented as an enterprise bean for accessibility through the JMS transport.
This product supports an emerging industry standard SOAP over JMS protocol. The SOAP over JMS specification provides a standard set of interoperability guidelines for using a JMS-compliant transport with SOAP messages to enable interoperability between the implementations of different vendors. Using this standard, a mixture of client and server components from different vendors can interoperate when exchanging SOAP request and response messages over the JMS transport for both JAX-WS and JAX-RPC web services. By using the JMS transport, your enterprise beans based web service clients and servers can communicate through JMS queues and topics instead of through HTTP connections.
Deprecated feature: In earlier versions of the application server, an IBM proprietary SOAP over JMS protocol was supported for JAX-RPC applications. In WebSphere Application Server 7.0 and later, this proprietary SOAP over
JMS protocol is now deprecated in favor of an emerging industry standard SOAP over JMS protocol. Use the IBM proprietary SOAP over JMS protocol with the JAX-WS or JAX-RPC web
services; however, take advantage of the emerging standard SOAP over JMS protocol. If our client
application invokes enterprise beans-based web services supported by an earlier version of
the WAS, we must continue to use the IBM proprietary SOAP over JMS protocol to access those
web services. depfeat
The benefits of using JMS include:
- Reliable messaging transport for communicating request and response messages.
- Flexible one-way requests for clients and servers. For example, the server does not have to be active when the client sends the one-way request. Simultaneous one-way requests can be sent to multiple servers through the use of a topic.
- Synchronous two-way requests are supported for both JAX-WS and JAX-RPC clients.
- Asynchronous requests are supported for JAX-WS clients.
The SOAP over JMS specification defines a JMS endpoint URI syntax for specifying JMS destinations. A JMS endpoint URL is used to access JAX-WS or JAX-RPC web services with the JMS transport. This URL specifies the JMS destination and connection factory, as well as the port component name for the web service request. This endpoint URL is similar to the HTTP endpoint URL, which specifies the host and port as well as the context root and port component name.
Tasks
- Develop the enterprise bean that we intend to use as your service implementation bean.
- For JAX-WS applications, develop an enterprise beans- based JAX-WS service implementation bean.
- For JAX-RPC applications, develop an enterprise beans-based JAX-RPC service implementation bean.
- For JAX-WS applications, add the @BindingType annotation
to your endpoint implementation class and specify the SOAP over JMS binding id for our endpoint. For example:
@WebService @BindingType("http://www.w3.org/2010/soapjms/") public class MyServiceBeanImpl { ... }The @BindingType annotation is used to indicate the protocol (SOAP) and transport (JMS) to be used when sending request and response messages for the endpoint.
- Assemble the enterprise beans.
- Assemble a JAR file enabled for web services from an enterprise bean. We can assemble the artifacts required to enable the enterprise beans module for web services into a Java archive (JAR) file.
- Assemble a web services-enabled enterprise bean JAR file into an EAR file. We can assemble the artifacts required to enable the web services-enabled JAR file into an EAR file.
- Enable the enterprise beans-based endpoints using the endptEnabler command. Use the -transport jms option to request that the endptEnabler command create a message-driven bean (MDB) listener for each EJB JAR file containing web services implementation beans. This message-driven bean serves as a listener for requests associated with the web service endpoints contained in the EJB JAR file.
- Decide on the names and the types of the JMS objects that the application uses.
Before installing the application, we need to:
- Decide whether the web service receives requests from a queue
or a topic.
- Decide whether to use a secure destination or a nonsecure destination.
- Decide the names for our queues and topics, connection factory and activation specification.
Use the following guidelines for deciding JMS object names and types. In typical situations, we can use a queue for receiving web services requests.
- Queue
- A queue receive all types of requests. Valid requests include one-way, two-way, and synchronous. Asynchronous requests are only valid with JAX-WS web services.
- A queue is used only by a single EJB JAR file for receiving the requests for web services endpoints contained within that EJB JAR file.
- Topic
- A topic is used to receive only one-way requests.
- We can share a topic among multiple EJB JAR files. Each request message sent to a topic is processed by each of the MDB listeners configured to listen on that topic. This means that each request message is processed by each EJB JAR file associated with that specific topic.
The following example describes a typical configuration for a single EJB JAR file containing web services endpoints:
- Suppose the EJB JAR file is StockQuoteEJB.jar and contains one or more web services endpoints related to the StockQuote service.
- We have a single queue, StockQuote_Q, with the JNDI name, jms/StockQuote_Q, used to receive requests.
- We have a connection factory, StockQuote_CF, with JNDI name, jms/StockQuote_CF, that can be used by clients to connect to the JMS provider.
- We also have a connection factory, StockQuote_ReplyCF, with JNDI name, jms/StockQuote_ReplyCF, used by the DB listener for the EJB JAR file to connect to the JMS provider when sending reply messages.
- We have an activation specification, StockQuote_AS, with JNDI name, jms/StockQuote_AS, used to associate the StockQuoteEJB.jar's MDB listener with the queue named StockQuote_Q.
- Decide whether the web service receives requests from a queue
or a topic.
- Define the JMS administered objects.
After we decide on the names and types of the JMS objects, use the administrative console or the wsadmin scripting tool to define the JMS objects. There are multiple ways to administer JMS resources depending on what type of JMS provider is being used. Read about choosing a messaging provider to learn more about administering JMS resources.
- Deploy the web services application.
During the installation process we are prompted for two types of information for each enterprise bean JAR file enabled for web services and is contained in your EAR file:
- The JNDI name of the connection factory used by the MDB
listener to use for sending reply messages.
If our web service contains two-way operations, the MDB listener that is defined by the endptEnabler command needs to access a queue connection factory to add a reply message to the reply queue. The MDB listener uses a resource environment reference of java:comp/env/jms/WebServicesReplyQCF. Therefore, during the application installation process, provide the actual JNDI name of the connection factory for the MDB listener to use for that web service. Using the previous example, the JNDI name is jms/StockQuote_ReplyCF.
- The name of the activation specification for the MDB listener to use.
An activation specification is an object used to associate a JMS connection factory with a JMS destination (queue or topic). When deployed, an MDB is configured with the correct activation specification so that messages from the queue or topic are properly delivered to the MDB. During deployment, we can modify the name of the activation specification associated with each MDB listener. The activation specification name contained in the input EAR file is displayed as a default value. If we specify the correct activation specification name to the endptEnabler command, we can accept the default value. Otherwise, enter the correct activation specification name.
- The JNDI name of the connection factory used by the MDB
listener to use for sending reply messages.
- Decide whether to use the new industry standard SOAP over
JMS protocol or the IBM proprietary SOAP/JMS protocol.
It is a best practice to use the industry standard SOAP/JMS protocol. The IBM proprietary SOAP/JMS protocol has been deprecated with this release. However, if the application needs to interoperate with previous versions of the product, then use the proprietary protocol.bprac
- If we use the industry standard SOAP over JMS protocol, use the Configure endpoint
URL information for JMS bindings task to specify a JMS endpoint
URL prefix that adheres to the JMS endpoint URI syntax associated
with the standard; for example:
jms:jndi:jms/StockQuote_Q&jndiConnectionFactoryName=jms/StockQuote_CF
- If we use the IBM proprietary SOAP over JMS protocol,
use the Configure endpoint
URL information for JMS bindings task to specify a JMS endpoint
URL prefix that adheres to the IBM proprietary
SOAP over JMS protocol; for example:
jms:/queue?destination=jms/StockQuote_Q&connectionFactory=jms/StockQuote_CF
- If we use the industry standard SOAP over JMS protocol, use the Configure endpoint
URL information for JMS bindings task to specify a JMS endpoint
URL prefix that adheres to the JMS endpoint URI syntax associated
with the standard; for example:
- (Optional) Configure endpoint URL information for JMS bindings.
Use the administrative console to configure a JMS endpoint URL prefix that we can associate with each EJB JAR module in the application. The WSDL publisher uses this partial URL string to produce the actual JMS URL for each port component defined in the enterprise bean JAR file. The clients that need to invoke the web service can use the published WSDL file.
Perform this step only if we are publishing the WSDL file for the application.
- (Optional) Publish
the WSDL file for the application.
Publishing the WSDL file, this produces WSDL documents we can use to develop your client applications. The publishing process produces fully-resolved endpoint location URLs within the WSDL files.
Perform this step only if the published WSDL files are needed to develop the client applications.
We have a web service configured to use SOAP over JMS to transport the requests.
What to do next
Develop a web services client.