JAX-WS webservice deployment on tomcat

Updated on September 24, 2021 by Arpit Mandliya

In previous post,we have seen how to develop JAX-WS web service end point and client.In this post,we will see how we can deploy web service end point to application server.

Web service Tutorial Content:

Here we will use tomcat as application server.

1) Open eclipse.
2) Create new dynamic web project named “HelloWorldWS”
3) Create new package named “org.arpit.javapostsforlearning.webservice”

4) Create JAXWSService Interface.
HelloWorld.java


package org.arpit.javapostsforlearning.webservice;
import javax.jws.WebMethod;
import javax.jws.WebService;

@WebService
public interface HelloWorld {

 @WebMethod public String helloWorld(String name);
}

package org.arpit.javapostsforlearning.webservice;

import javax.jws.WebMethod;

import javax.jws.WebService;

@WebService

public interface HelloWorld {

@WebMethod public String helloWorld(String name);

}

5)Create JAXWSService implementation class.
HelloWorldImpl.java


package org.arpit.javapostsforlearning.webservice;
import javax.jws.WebService;

@WebService(endpointInterface="org.arpit.javapostsforlearning.webservice.HelloWorld")
public class HelloWorldImpl implements HelloWorld{

 public String helloWorld(String name) {
  return "Hello world from "+name;
 }

}

package org.arpit.javapostsforlearning.webservice;

import javax.jws.WebService;

@WebService(endpointInterface="org.arpit.javapostsforlearning.webservice.HelloWorld")

public class HelloWorldImpl implements HelloWorld{

public String helloWorld(String name) {

return "Hello world from "+name;

}

6) Now , you need generate Web Services classes, open your command line, and type :


/* Now You need do following,
1) open command prompt.Go to your eclipse workspace(For example: cd E:/arpit/workspace)
2) then go to project(For example if project name is jaxws then "cd jaxws")
3) paste following "wsgen -s src -d build/classes -cp build/classes org.arpit.javapostsforlearning.webservice.HelloWorldImpl" then enter */
cd %project_home%
wsgen -s src -d build/classes -cp build/classes org.arpit.javapostsforlearning.webservice.HelloworldImpl

/* Now You need do following,

1) open command prompt.Go to your eclipse workspace(For example: cd E:/arpit/workspace)

2) then go to project(For example if project name is jaxws then "cd jaxws")

3) paste following "wsgen -s src -d build/classes -cp build/classes org.arpit.javapostsforlearning.webservice.HelloWorldImpl" then enter */

cd %project_home%

wsgen -s src -d build/classes -cp build/classes org.arpit.javapostsforlearning.webservice.HelloworldImpl

Now we will have two class generated under src/org/arpit/javapostsforlearning/webservice/jaxws

7)Now you need to create web.xml and put it under /HelloWorldWS/WebContent/WEB-INF/


<!--?xml version="1.0" encoding="UTF-8"?-->
<web-app
     xmlns="http://java.sun.com/xml/ns/j2ee"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
                         http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
     version="2.4">
     <display-name>HellooWorldWS</display-name>
   <listener>
     <listener-class>
        com.sun.xml.ws.transport.http.servlet.WSServletContextListener
     </listener-class>
   </listener>
   <servlet>
      <servlet-name>HelloWorldWS</servlet-name>
      <servlet-class>
        com.sun.xml.ws.transport.http.servlet.WSServlet
      </servlet-class>
   </servlet>
   <servlet-mapping>
     <servlet-name>HelloWorldWS</servlet-name>
     <url-pattern>/HelloWorldWS</url-pattern>
   </servlet-mapping>
</web-app>

<web-app

xmlns="http://java.sun.com/xml/ns/j2ee"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee

http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"

version="2.4">

<display-name>HellooWorldWS</display-name>

<listener-class>

com.sun.xml.ws.transport.http.servlet.WSServletContextListener

</listener-class>

</listener>

<servlet-name>HelloWorldWS</servlet-name>

<servlet-class>

com.sun.xml.ws.transport.http.servlet.WSServlet

</servlet-class>

</servlet>

<servlet-mapping>

<servlet-name>HelloWorldWS</servlet-name>

<url-pattern>/HelloWorldWS</url-pattern>

</servlet-mapping>

</web-app>

we have inserted three things here 1.listner-class 2.servlet 3.servlet-mapping
8) Now we will add sun-jaxws.xml under HelloWorldWS/WebContent/WEB-INF/.It will have endpoint definition.


<!--?xml version="1.0" encoding="UTF-8"?-->
<endpoints xmlns="http://java.sun.com/xml/ns/jax-ws/ri/runtime" version="2.0">
  <endpoint
     name="HelloWorldWS"
     implementation="org.arpit.javapostsforlearning.webservice.HelloWorldImpl"
     url-pattern="/HelloWorldWS"/>
</endpoints>

<endpoint

name="HelloWorldWS"

implementation="org.arpit.javapostsforlearning.webservice.HelloWorldImpl"

url-pattern="/HelloWorldWS"/>

</endpoints>

9) We need to download some jaxws jars and put jars under /HelloWorldWS/WebContent/WEB-INF/lib.

Download

click to begin

5.93MB .zip

10) Now export your project as war and put it under your Tomcat webapps folder.

11) If you have target runtime as none then you can refer configure Apache Tomcat in Eclipse IDE.
then Run tomcat

12) Click this URL http://localhost:8080/HelloWorldWS/HelloWorldWS

If You see web service information page then you are done.


<b>Source:</b><a href="https://dl.dropbox.com/s/jaiwljd0ltzb2ra/HelloWorldWebService.rar" target="_blank">Download</a>

<b>Source:</b><a href="https://dl.dropbox.com/s/jaiwljd0ltzb2ra/HelloWorldWebService.rar" target="_blank">Download</a>

Was this post helpful?

Let us know if this post was helpful. Feedbacks are monitored on daily basis. Please do provide feedback as that\'s the only way to improve.

Next

Web Service Tutorial

Author

Arpit Mandliya

Follow Author

Comments

Siva says:

May 13, 2013 at 7:40 am

Very nice example.

Reply
1. ashutosh says:
  
  May 14, 2013 at 9:12 am
  
  its nice siva but go and try urself until u try u wont be able to learn
  
  Reply
  1. siva says:
    
    May 14, 2013 at 9:14 am
    
    wtf is this
    
    Reply
Patrick says:

May 22, 2013 at 12:06 pm

THX

Reply
Akash says:

June 16, 2013 at 3:32 am

I am unable to get step 6 to execute successfully. Arpit, could you kindly review this step and provide more details.

Reply
Suren says:

June 20, 2013 at 7:04 am

I do not think step 6 is required ? I'm able to build, deploy and run my JAX-WS service following the above steps but without step 6.

Reply
Neeraja says:

July 24, 2013 at 6:51 am

Hi Arpit,

Thanks for the good post.
I have one query , I am able to access the wsdl file locally , when i try to access from some other machine in same netwrok , I am not able to accesss it

Thanks

Reply
sreenivas says:

August 4, 2013 at 11:23 am

in wsgen of step 6 command “HelloworldImpl” should be “HelloWorldImpl” i.e. caps W.

Reply
1. arpitmandliya says:
  
  September 28, 2013 at 1:56 pm
  
  Sorry if step 6 in my post is not clear.You can do following,
  1) open command prompt.Go to your eclipse workspace(For example: cd E:/arpit/workspace)
  2) then go to project(For example if project name is jaxws then “cd jaxws”)
  3) paste following “wsgen -s src -d build/classes -cp build/classes org.arpit.javapostsforlearning.webservice.HelloWorldImpl” then enter
  
  Reply
Binod says:

August 19, 2013 at 12:02 pm

Hi Arpit
I am facing problem while executing Step 6 – directory not found.
Below are the out put messages i got.

F:\WEBSERVICE\HelloWorldWS\src>wsgen -s src -d build/classes -cp build/classes o
rg.arpit.javapostsforlearning.webservice.HelloworldImpl
directory not found: src

Reply
priyanka says:

August 22, 2013 at 2:44 pm

Hi Arpit,

i have followed all the above steps. but i am unable to get the output shown in step 12.
i am getting 404 error. can you help me out

Reply
1. Guest says:
  
  January 23, 2014 at 11:33 pm
  
  I just resolved this 404 error. I tried with the name of the war file (that is my project name). Ex: if the war file name is : SOAPWebServices, then the URL to get the above output is: http://localhost:8080/SOAPWebServices/HelloWorldWS. This worked and gave above output. And the wsdl is accessible at: http://localhost:8080/HelloWorldWS/HelloWorldWS?wsdl as shown in the above output
  
  Reply
  1. Guest says:
    
    January 23, 2014 at 11:37 pm
    
    I am sorry, there was a mistake in my comment above. Even the wsdl is accessible at: http://localhost:8080/SOAPWebServices/HelloWorldWS?wsdl
    
    Reply
cooldevelopers says:

September 3, 2013 at 7:09 am

Excellent work !!!!

any idea that how can i call this service from salesforce

Reply
Raja says:

September 5, 2013 at 2:49 pm

Fantastic Tutorial DUde Hats OFF to you 😀 !!!!!!!!!!!!!!!!!!!!!!!!1

awesommme tutorial dude……hatsoff to you 🙂

Reply
rathishkumar says:

September 5, 2013 at 6:07 pm

nice tutorial if i change the url pattern to / or /* its not calling the welcome file , what are the steps need to be followed to change the url mapping from/test/ to / or (/*)

Reply
gopi says:

September 9, 2013 at 11:37 am

Hi Arpit
I am facing problem while executing Step 6 – directory not found.
Below are the out put messages i got.
Read more at http://javapostsforlearning.blogspot.com/2013/03/…

D:\java\webservices\HelloWorldWS\src>wsgen -s src -d build/classes -cp build/classes org.arpit.javapostsforlearning.webservice.HelloworldImpl
directory not found: src

Reply
sreekanth says:

September 28, 2013 at 12:36 pm

Hi arpit,

This is Sreekanth.
I am unable to get step 6 to execute successfully. would you kindly review this step and provide more details.
I have checked the comments also, but i am not getting it to be solved. Please help me. I am getting the error like.

i am getting directorynotfound : src.

Reply
1. arpitmandliya says:
  
  September 28, 2013 at 1:35 pm
  
  Hello Sreekanth,
  Are you creating project using eclipse? There must be src in your project
  
  Reply
2. arpitmandliya says:
  
  September 28, 2013 at 1:57 pm
  
  Sorry if step 6 in my post is not clear.You can do following,
  1) open command prompt.Go to your eclipse workspace(For example: cd E:/arpit/workspace)
  2) then go to project(For example if project name is jaxws then “cd jaxws”)
  3) paste following “wsgen -s src -d build/classes -cp build/classes org.arpit.javapostsforlearning.webservice.HelloWorldImpl” then enter
  
  Reply
  1. sreekanth says:
    
    September 30, 2013 at 4:35 am
    
    Hi Arpit,
    Good Morning. Thanks for the reply. You are awesome Arpit. That is working absolutely perfectly.
    Thanks bro. Your tutorial is awesome and crystal clear.
    
    Reply
Viet says:

September 29, 2013 at 2:57 pm

I go the error when I run it. look like there are some missing jar files.

Sep 29, 2013 9:53:16 AM org.apache.catalina.startup.HostConfig deployWAR
INFO: Deploying web application archive HelloWorldWS.war
Sep 29, 2013 9:53:16 AM com.sun.xml.ws.transport.http.servlet.WSServletContextLi
stener contextInitialized
INFO: WSSERVLET12: JAX-WS context listener initializing
Sep 29, 2013 9:53:16 AM com.sun.xml.ws.transport.http.servlet.WSServletContextLi
stener contextInitialized
SEVERE: WSSERVLET11: failed to parse runtime descriptor: java.lang.NoClassDefFou
ndError: com/sun/xml/stream/buffer/XMLStreamBuffer

Reply
Fran says:

October 31, 2013 at 10:09 am

Nice demo. Only a comment to prevent other people from wasting time as I have wasted. I downloaded the last Metro build (metro-standalone-2.3) from the Metro project page, not from the link you provide in the step 9 of the tutorial. This build includes in its lib directory two jar files: databinding\jaxws-eclipselink-plugin.jar and databinding\sdo-eclipselink-plugin.jar. Don’t add that jars to the project classpath. If you do so, you’ll get the following error: java.lang.ClassNotFoundException: org.eclipse.persistence.sdo.helper.SDOHelperContext.
Moreover, I don’t need step 6.
Thx.

Reply
1. Raul says:
  
  April 30, 2014 at 9:25 am
  
  thanks a lot
  
  Reply
Luk says:

November 14, 2013 at 10:17 pm

Step 2 – Create new web project… I have eclipse EE version, but there is no “web project” (there is only “dynamic web project”…) How get this “web project” ?

Reply
pavan says:

December 6, 2013 at 5:35 pm

http://www.mkyong.com/webservices/jax-ws/deploy-j…

Reply
Sreekanth says:

January 16, 2014 at 3:03 pm

We need to call link this

http://localhost:8080/HelloWorldWS/HelloWorldWS?WSDL

Reply
1. Guest says:
  
  January 23, 2014 at 11:21 pm
  
  I have the same 404 error and I tried the above URL too, but it did not work for me.
  
  Reply
Domenico says:

August 25, 2014 at 6:22 pm

Where i found the jars for jaxws?

Reply
Anonym says:

September 1, 2014 at 9:56 am

HTTP Status 404 – /HelloWorldWS/HelloWorldWS

type Status report

message /HelloWorldWS/HelloWorldWS

description The requested resource is not available.

Apache Tomcat/7.0.55

I am getting this error..can you help me?

Reply
Bindu says:

November 5, 2014 at 6:33 am

Hi,

To make this complete webservice,you need the following jar.

javax.jws-1.0.jar
jaxws-api-2.1.3.jar
jaxws-rt-2.1.4.jar
stax-ex-1.2.jar
streambuffer.jar

Reply
1. Venkat says:
  
  November 22, 2015 at 11:06 pm
  
  I copied the following jar files into WEB-INF/lib and tried to start Tomcat. I got the error: Server Tomcat v7.0 Server at localhost failed to start.
  javax.jws-1.0.jar
  jaxb-impl.jar
  jaxws-api.jar
  jaxws-rt.jar
  stax-ex.jar
  streambuffer.jar
  
  Could you please give me some suggestions?
  
  Thanks,
  Venkat
  
  Reply
zach says:

November 12, 2014 at 2:55 am

you also need to add the jaxb-impl-2.1.jar

Reply
1. Venkat says:
  
  November 22, 2015 at 10:57 pm
  
  It is not working with all the jars.
  
  Reply
steve says:

January 7, 2015 at 2:18 pm

I see the “Web Services” page OK in Step 12. How do you make a request to the service? So that you can get the output “Hello world from [name]”?

Reply
1. steve says:
  
  January 7, 2015 at 3:31 pm
  
  Never mind. I had to write a jax-ws client using a proxy and taking advantage of the service's WSDL URL. I could do this either with the “wsimport” command or using Eclipse's New Web Service Client context menu.
  
  Reply
guruprit singh says:

January 8, 2015 at 7:26 am

Thank you.

Reply
ahsan says:

February 4, 2015 at 11:46 am

I am not able to get the step 9. attachment is not available. kindly help

Reply
Patrick says:

March 12, 2015 at 3:01 am

Could you please reupload the attachment?
Nice Blog !

Reply
hariprasad says:

July 15, 2015 at 4:12 pm

Hello, your tutor is nice and clear, but it is out of date. If you refresh it, it would be great.

Reply
raazan says:

September 29, 2015 at 9:53 am

Hi Arpit, thank you very much for your simple tutorials.

can you please help me on java SOAP code for:
request parameters: name, class, rollnumber
reply parameters: total marks in subjects like: english, math, science

Reply
1. Andrew says:
  
  September 15, 2016 at 10:28 am
  
  Step 6 :: be careful of the name of the file, its HelloWorldImpl with a Capiltal “W”
  
  Reply
venu says:

October 4, 2015 at 4:42 pm

please any one can explain topbotom and botomup approach with best examples

adv thanks

Reply
francky74 says:

October 6, 2015 at 9:26 pm

Hi !

Thank you for all those tutos ! they're really nice.

I have a difficulty in the end of this one.
I run tomcat with startup.bat after having pastin the war file into the webapps folder but, when I try to work with the adress you wrote, I have a 404 error.

Could you please precise the step 9 ? which file do we need to import in lib folder ?

Thanks !

Reply
metis says:

October 20, 2015 at 9:57 am

wsgen gives directory not found error

Reply
1. metis says:
  
  October 20, 2015 at 2:30 pm
  
  creating java project gives this error. by creating new dynamic web project, no error has left.
  
  However
  
  Reply
metis says:

October 20, 2015 at 2:32 pm

JAX-WS webservice deployment on tomcat lesson is too poor with respect to other excellent tutorials. Please edit this tutorial. In step 9, assignment link is broken also.

Reply
Venkat says:

November 15, 2015 at 7:57 pm

Hi Arpit:

I have problem running this program.
What jars do we need to add into WEB-INF/lib? The 'attachment' is not active.

Please explain a little more on how to run this program in Tomcat.

Thanks,
Venkat

Reply
Venkat says:

November 19, 2015 at 5:26 pm

I copied the following jar files into WEB-INF/lib and tried to start Tomcat. I got the error: Server Tomcat v7.0 Server at localhost failed to start.
javax.jws-1.0.jar
jaxb-impl.jar
jaxws-api.jar
jaxws-rt.jar
stax-ex.jar
streambuffer.jar

Could you please give me some suggestions?

Thanks,
Venkat

Reply
Venkat says:

November 27, 2015 at 4:54 am

Hi Arpit:

I got the WebService to work with the jars listed below.

gmbal-api-only.jar
ha-api.jar
javax.jws-3.1.1.jar
jaxb-core.jar
jaxb-impl.jar
jaxws-api.jar
jaxws-rt.jar
management-api.jar
policy.jar
stax-ex.jar
streambuffer.jar

Reply
Fred says:

December 4, 2015 at 7:15 am

Your download link is broken,either put it there or remove it altogether

Reply
xine44 says:

January 9, 2016 at 12:13 am

Hi,
thanks for you're work, i've “googled” so many times and what you are doing here is the most helplful i've ever found !

just a little error (uppercase) :
wsgen -s src -d build/classes -cp build/classes org.arpit.javapostsforlearning.webservice.HelloworldImpl
to change so:
wsgen -s src -d build/classes -cp build/classes org.arpit.javapostsforlearning.webservice.HelloWorldImpl

Reply
Murali says:

July 25, 2016 at 2:06 pm

Great post, it helped me a lot thanks

Reply
Carolina says:

November 1, 2017 at 8:41 pm

Thank you very much !!! it was very usefull !!!

Reply