View source for Creating Web service and Web service client using Ant tasks

{| width="100%" cellspacing="5" cellpadding="2"
| width="60%" align="left" | <br /><font class="indexsub">Running Web service scenarios using Ant</font>
| width="40%" |
[[Image:Wtplogosmall.png]]
|}

{| width="100%" cellspacing="5" cellpadding="2"
| valign="top" |
'''By Joan Haggarty'''<br /> June 23, 2008 <br /><br />
|-
| colspan="2" bgcolor="#0080c0" align="left" valign="top" | '''<font color="#ffffff" face="Arial,Helvetica">Introduction</font>'''
|-
| valign="top" | <br />
|-
| valign="top" |
This document is one of a series of tutorials to demonstrate the use of the Web Services tools in the Web Tools Platform Project with the '''WTP 3.0 drivers'''.
|-
| valign="top" |
This tutorial shows how to run Web services scenarios (top down web service, bottom up web service and client generation) without the web service wizard by way of an Ant task.
|-
| valign="top" |
The Ant task can be invoked in one of two ways:
# From the command line on Windows from the '''wsant.bat''' file or from the command line on Linux using the '''wsant.sh''' script. This method runs Eclipse headless. Customization of the batch file to reflect your environment is necessary.
# From within Eclipse, the Ant file such as '''axis_tdjava.xml''' can be invoked directly as an Ant build file. The objective of this tutorial is to show how to configure the batch file, Ant file and properties files in addition to invoking the Ant task. The scenario will use the top down service generation scenario to invoke the task inside the Eclipse workbench and then inovke the task from the command line to generate the client for the generated web service.
|-
| colspan="2" bgcolor="#0080c0" align="left" valign="top" | '''<font color="#ffffff" face="Arial,Helvetica">Set up</font>'''
|-
| valign="top" | <br />
|-
| valign="top" |
Before creating the Web service, there are two prerequisites:
|-
| valign="top" |
# [http://www.eclipse.org/webtools/jst/components/ws/1.0/tutorials/InstallTomcat/InstallTomcat.html Install Apache Tomcat]
# [http://www.eclipse.org/webtools/jst/components/ws/1.0/tutorials/CreateWebProject/CreateWebProject.html  Create a dynamic Web project] called '''testProject''' .
|-
| colspan="2" bgcolor="#0080c0" align="left" valign="top" | '''<font color="#ffffff" face="Arial,Helvetica">Service Generation - Using the Ant Task inside Eclipse</font>'''
|-
| valign="top" |
First, import the Ant files into the Eclipse workbench.
# Within, WTP, create a simple project called '''AntTest'''.
# Once you have created the simple project, use the main menu and select: '''File > New > Other > Web Services > Ant Files'''. Click '''Next'''. <br />[[Image:Ws_antimport1.jpg]]<br />
# Browse to the '''AntTest''' project, choose '''Web Service Runtime''' as '''Apache Axis''' and '''Server''' as '''Top Down Java bean Web Service'''<br />[[Image:Ws_antimport2.png]]<br />
# Click '''Finish'''.
# Under the '''Other Projects''' in the '''Project Explorer''' view, three files have been imported into the '''AntTest''' project folder:
#* '''axis_tdjava.xml '''- the Ant file
#* '''axis_tdjava.properties '''- a sample Ant properties file for generating web services for the Axis runtime
|-
| valign="top" |
Next, import the sample WSDL file [http://www.eclipse.org/webtools/jst/components/ws/1.0/tutorials/WebServiceAntTask/srcfiles/AreaService.wsdl AreaService.wsdl] file into the WebContent folder of the dynamic web project '''testProject'''.
|-
| valign="top" |
No matter where the task is invoked, required input needs to be provided to the Ant task by way of properties and a reference to the properties file updated from the Ant file. The properties file must specify the resource that will be used to generate the service. In this example, we will point to the '''AreaService.wsdl''' file in the '''testProject''' web project. The type of scenario needs to be specified as well. In this case, the scenario will be <code>service</code>.
|-
| valign="top" |
# Go to the '''AntTest''' project under '''Other Projects''' in the '''Project Explorer''' view. Open and edit the '''axis_tdjava.xml''' Ant script so that <code>property file="axis_tdjava.properties"</code>. This indicates to the Ant task that you want to generate a service as opposed to a client. Remove any other property file settings from the '''axis_tdjava.xml''' file
# Save the '''axis_tdjava.xml''' file.
# Edit the '''axis_tdjava.properties''' file. Check that <code>scenarioType=service</code> and set InitialSelection to a workspace relative path that points to the AreaService.wsdl: <code>InitialSelection=/testProject/WebContent/AreaService.wsdl</code>. '''Note:'''At this point, delete all of the other properties in the properties file. Only scenarioType and InitialSelection properties are required. The remaining properties in the properties file are examples and should be deleted if not explicitly set by the user. The Ant task will default the remaining properties based on the dynamic project settings and the scenarioType setting.
# Save the '''axis_tdjava.properties''' file.
# Right click on the '''axis_tdjava.xml''' file and select '''Run As > Ant Build...'''
# In the Ant dialog, click on the '''JRE''' tab and choose the radio button '''Run in the same JRE as the workspace'''. Click '''Apply''' and then '''Run'''<br />[[Image:Ws_antdialog.jpg]]<br />
# Once the generation is complete, you will get a <tt>Build Successful</tt> message in the console. '''AreaServiceSOAP.wsdl''' should have been generated into the project's '''WebContent\wsdl''' folder as well as the Java code in the '''src''' folder for the '''testProject''' web project in the '''org.tempuri.AreaService''' package -
#* AreaService_PortType.java
#* AreaService_Service.java
#* AreaService_ServiceLocator.java
#* AreaServiceSOAPImpl.java
#* AreaServiceSOAPSkeleton.java
#* AreaServiceSOAPStub.java
#* Dimensions.java 
#You will also see deployment descriptors were generated in the '''WebContent/WEB-INF/org/tempuri/AreaService''' folder:
#* undeploy.wsdd
#* deploy.wsdd
|-
| valign="top" | '''Note:'''
|-
| valign="top" | '''InitialSelection'''
|-
| valign="top" | <br />
|-
| colspan="2" bgcolor="#0080c0" align="left" valign="top" | '''<font color="#ffffff" face="Arial,Helvetica">Client Generation - Using the Ant Task at the Command Line</font>'''
|-
| valign="top" |
Typically, you would use either the Eclipse or the command line mechanism to invoke the Ant task, not both. However, for the purposes of showing how the Ant tasks can be invoked, we'll switch out to the command line to demonstrate generating the client code. The next task is to generate a client for the AreaService web service using the same project and the WSDL file generated using the <tt>wsgen</tt> Ant task within Eclipse earlier.
|-
| valign="top" |
# Navigate to the plugins directory of your WTP installation. Change to the '''org.eclipse.wst.command.env''' plugin directory and then go to the '''ant''' folder.  The actual name of the plugin could be different from driver to driver, for example: '''D:\wtp30\eclipse\plugins\org.eclipse.wst.command.env_1.0.305.v200805281530\ant'''.  Also, if you unzipped the WTP driver manually, the plugin could be in the '''dropins''' directory.
# The following files should exist there:
#* wsant.bat
#* wsgen.xml
#* axisservice.properties
#* axisclient.properties
# Make backup copies of the files if you wish.
# Open the '''wsgen.xml''' Ant file and edit so that <code>property file="axisclient.properties"</code>. Remove any other property file references in the file such as axisservice.properties.
# Save the '''wsgen.xml '''
# Edit the '''axisclient.properties''' file. Check that <code>scenarioType=client</code> and set the InitialSelection property to a workspace relative path pointing to the AreaServiceSOAP.wsdl that was generated in the previous section of this tutorial. <code>InitialSelection=/testProject/WebContent/wsdl/AreaServiceSOAP.wsdl</code>. '''Note:'''At this point, delete all of the other properties in the properties file. Only scenarioType and InitialSelection properties are required. The remaining properties in the properties file are examples and should be deleted if not explicitly set by the user. The Ant task will default the remaining properties based on the dynamic project settings and the scenarioType setting.
# Save the '''axisclient.properties file'''.
# Next, edit the '''wsant.bat''' file. Set the local environment variables to reflect your system configuration inluding the location of your JRE, the Eclipse launcher.jar (for example, <code>set LAUNCHER_JAR="%SHARED_DIRECTORY%\plugins\org.eclipse.equinox.launcher_1.0.100.v20080509-1800.jar</code>),  and the workspace containing the web project and '''AreaServiceSOAP.wsdl''' file.
# Save the '''wsant.bat''' file.
# Run '''wsant.bat''' by typing wsant at the command line.
# When the generation is complete, look at the '''wsgen.txt''' file for output.
# At the command line or back in WTP, navigate to the testProject src folder to find the client '''AreaServiceProxy.java''' code that was generated.
|}