Implement web services applications with JAX-RPC
We can use JAX-RPC to develop web services.
Best practice: IBM WAS supports JAX-WS and JAX-RPC. JAX-WS extends JAX-RPC. JAX-WS supports annotations. best-practices
To develop web services based on JAX-RPC, we can use a bottom-up development approach starting from existing JavaBeans or enterprise beans or we can use a top-down development approach starting with an existing WSDL file. This task describes the steps when using the bottom-up development approach.
When developing a JAX-RPC web service starting from existing JavaBeans or enterprise beans, we need develop a WSDL file. We can use existing JavaBeans or enterprise beans and then enable the implementation for web services. Enable the bean for web services includes developing the service endpoint interface, developing a WSDL file that is the description of the web service, generating and configuring the deployment descriptors, assembling all artifacts required for the web service, and deploying the application onto the application server.
- Considerations when using JavaBeans
JavaBeans exposed as JAX-RPC web services are supported only over an HTTP transport.
- Considerations when using enterprise beans
- The enterprise bean must be a stateless session bean.
- Enterprise beans that are exposed as JAX-RPC web services must be packaged in EJB 2.1 or in EJB 3.0 or higher modules.
- For JAX-RPC web services using EJB 2.1 style endpoints, the Web service method parameters must be one of the supported JAX-RPC types. These requirements are documented in the JAX-RPC specification.
- JAX-RPC web services using enterprise beans are supported over an HTTP or Java Message Service (JMS) transport.
Best practice: It is a best practice to use EJB 2.1 style enterprise beans with JAX-RPC applications. bprac
- Set up a development environment for web services. You do not have to set up a development environment if you are using Rational Application Developer.
- Determine the existing JavaBeans or enterprise beans to expose as a JAX-RPC web service.
- Develop a service endpoint interface. The service endpoint interface defines the JavaBeans or enterprise beans methods for a particular web service. The JavaBeans must implement methods that have the same signature as the methods on the service endpoint interface.
- Develop a service endpoint interface for JavaBeans applications.
- Develop a service endpoint interface for enterprise beans applications.
- Develop the Java artifacts.
- Develop a WSDL file. The WSDL file is the description of a Java EE web service. For JAX-RPC applications, a WSDL file is required.
- Develop JAX-RPC deployment descriptors. Use the WSDL2Java command-line tool to create the deployment descriptor templates configured to map the service implementation to the JavaBeans or enterprise beans implementation.
- Develop web services deployment descriptor templates for a JavaBeans implementation.
- Develop web services deployment descriptor templates for an enterprise beans implementation.
- Complete the implementation of the web service application.
- For JavaBeans applications, complete the JavaBeans implementation.
- For enterprise beans applications, complete the enterprise beans implementation.
- Configure the webservices.xml deployment descriptor. For JAX-RPC web services, configure the webservices.xml deployment descriptor so that the application server can process the incoming web services requests.
- Configure the ibm-webservices-bnd.xmi deployment descriptor. Configure the ibm-webservices-bnd.xml deployment descriptor so that the application server can process the incoming web services requests.
- Assemble the artifacts for the web service.
Use assembly tools provided with the application server to assemble the Java-based web services modules.
If we have assembled an EAR file containing enterprise beans modules containing web services, use the endptEnabler command-line tool or an assembly tool before deployment to produce a web services endpoint WAR file. This tool is also used to specify whether the Web services are exposed using SOAP over Java Message Service (JMS) or SOAP over HTTP.
- Deploy the EAR file into the application server. We can now deploy the EAR file that has been configured and enabled for JAX-RPC web services onto the application server.
Results
You have developed a JAX-RPC web service application.
What to do next
After you deploy the EAR file, test the web service to verify the service works with the application server.
Subtopics
- Develop JAX-RPC web services
- Assemble web services applications
We can assemble Java-based web services applications using assembly tools.
- Deploy web services applications onto application servers
After assembling the artifacts required to enable the web module for web services into an EAR file, we can deploy the EAR file into the application server.
- Use a third-party JAX-WS web services engine
In certain situations we might need to set up a third-party JAX-WS web services engine. For example, set up a third-party JAX-WS web services engine if we need to deploy applications that use a single run time across various application servers such as WebSphere Application Server, JBoss, and WebLogic, or to build JAX-WS web services applications using third party JAX-WS run time such as CXF, Axis2, and Metro.
Related concepts
JAX-RPC Web services
Related tasks
Set up a development environment for web services Assembling web services applications Assembling a WAR file that is enabled for web services from Java code Assembling a web services-enabled WAR into an EAR file Deploy web services applications onto application servers Test web services-enabled clients Use HTTP to transport web services Use SOAP over JMS to transport web services
Artifacts used to develop web services Web services specifications and APIs