This tutorial will take you through the steps required in developing, deploying and testing a EJB Stateless Session Bean Web Service in Apache Geronimo. After completing this tutorial you should be able to understand how to develop simple JAX-WS compliant EJB web services in Apache Geronimo using Eclipse development environment.
It is highly recommended that you go through the Developing a JAX-WS POJO Web Service tutorial before jumping into this. We will be using the same sample from the tutorial to develop a EJB Web Service.
Client development is excluded from this tutorial because there is no difference in creating a client for EJB Stateless Session Bean Web Service and a POJO Web Service.
You can refer to Developing a JAX-WS POJO Web Service tutorial for further knowledge about how to develop a client for Web Services.
To run this tutorial, as a minimum you will be required to have installed the following prerequisite software.
- Sun JDK 5.0+ (J2SE 1.5)
- Eclipse 22.214.171.124 (Eclipse Classic package of Europa distribution), which is platform specific
- Web Tools Platform (WTP) 2.0.1
- Data Tools Platform (DTP) 1.5.1
- Eclipse Modeling Framework (EMF) 2.3.1
- Graphical Editing Framework (GEF) 3.3.1
Details on installing eclipse are provided in the Development environment section. This tutorial will take you through the following steps:
Setting Up Eclipse for Application Development
- Create a Stateless Session EJB Project
- Select File->New->Project
- In the popup window, select EJB->EJB Project and then click Next
- Type jaxws-converterejb as the Project Name and click Next..
- The default option should work for Geronimo, so click Next
- Here also default options will work, but the service and wsdl file will be located at the URL specified by the annotations
Changing Service Location
If you want to change the service location to any custom URL you want, make sure that the check box Generate Deployment Descriptor is selected.
- Modify the Group Id to org.apache.geronimo.samples.jaxws and the artifact id to jaxws-converterejb.
- Click Finish
- Select File->New->Project
This completes the configuration of Eclipse for application development.
Creating the Web Services Implementation code
To deploy the Converter EJB Service, we are going to create a remote interface and a stateless session bean that implements the interface. The steps required are as follows:
- Right click on ejbModule and select New->Package
- Name the package to org.apache.geronimo.samples.jaxws and click Finish
- Right click on the new package and select New->Interface
- Name the interface as Converter and click Finish
- Add the following code to the Converter class
- Right click on the new package and select New->Class
- Name the class as ConverterBean and click Finish
- Add the following code to the ConverterBean class
A little observation
If you have already gone through the Developing a JAX-WS POJO Web Service tutorial, you might have observed that there's not much difference between an EJB Web Service and POJO Web Service except for the EJB specific annotations.
This completes the development of the Web Service Implementation code.
Setting Up the Deployment Descriptor and Deployment Plan
Geronimo default location
If you are comfortable with the location that Geronimo deploys the EJB Web Service, you can skip this section and got Deploy and Test Section.
- Expand the META-INF directory present under ejbModule and add the following code to ejb-jar.xml
If ejb-jar.xml is not present, create a XML file and name it as ejb-jar.xml
- Add the following code to ejb-jar.xml
- Also add the following code to the openejb-jar.xml present at the same location.
This completes the setting up of Deployment descriptor and Deployment Plan.
Deploy and Test the Web Service
Now, we will look into the steps involved in deploying and testing our web service without any clients.
- Right click on the Apache Geronimo Server Runtime present in the servers view and select Add or Remove Projects
- In the popup dialog, select the jaxws-converterejb project and click Add
- Make sure that jaxws-converter is in the configured projects list and then click Finish
- Wait for some time till the server status is changed to synchronized.
Errors at Deploy time
If you see any errors at deploy time like Unable to read WSDL file null, simply ignore them.
- Once the application is deployed on to the server, Launch a browser and go to the following url.
If you have followed the steps to deploy the service onto custom location, go to the url http://localhost:8080/CUSTOM_URL
- Now you should see the screen telling that service is located at the following URL
Using Web Service Explorer in Eclipse
You can also use Web Services Explorer present in Eclipse to rapidly test your web service without developing a client.
To know how to use Web Services Explorer in Eclipse, one can refer to the Developing a JAX-WS POJO Web Service#Using Web Services Explorer in Eclipse