You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by di...@apache.org on 2008/05/01 23:20:38 UTC
svn commit: r652665 [43/45] - in /webservices/axis2/site: ./ 1_4/ 1_4/adb/
1_4/adb/images/ 1_4/images/ 1_4/images/archi-guide/ 1_4/images/userguide/
1_4/jibx/ 1_4/src/ css/ download/0_9/ download/0_91/ download/0_92/
download/0_93/ download/0_94/ downl...
Added: webservices/axis2/site/tools/1_4/CodegenToolReference.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/tools/1_4/CodegenToolReference.html?rev=652665&view=auto
==============================================================================
--- webservices/axis2/site/tools/1_4/CodegenToolReference.html (added)
+++ webservices/axis2/site/tools/1_4/CodegenToolReference.html Thu May 1 14:20:27 2008
@@ -0,0 +1,1177 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - </title>
+ <style type="text/css" media="all">
+ @import url("../../css/maven-base.css");
+ @import url("../../css/maven-theme.css");
+ @import url("../../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../" id="bannerLeft">
+
+ <img src="http://www.apache.org/images/asf_logo_wide.png" alt="" />
+
+ </a>
+ <span id="bannerRight">
+
+ <img src="../../../images/axis.jpg" alt="" />
+
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 2008-05-01
+ </div>
+ <div class="xright"> <a href="../../index.html">Axis2/Java</a>
+ |
+ <a href="../../../c">Axis2/C</a>
+ |
+ <a href="../../../..">Apache WS</a>
+ |
+ <a href="http://www.apache.org" class="externalLink">Apache</a>
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+
+ <h5>Axis2/Java</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../index.html">Home</a>
+ </li>
+ </ul>
+ <h5>Downloads</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../download.cgi">Releases</a>
+ </li>
+
+ <li class="none">
+ <a href="../../modules/index.html">Modules</a>
+ </li>
+
+ <li class="none">
+ <a href="../../tools/index.html">Tools</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../../1_4/contents.html">Version 1.4</a>
+ <ul>
+
+ <li class="none">
+ <a href="../../1_4/toc.html">Table of Contents</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_4/installationguide.html">Installation Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_4/quickstartguide.html">QuickStart Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_4/userguide.html">User Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_4/jaxws-guide.html">JAXWS Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_4/pojoguide.html">POJO Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_4/spring.html">Spring Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_4/webadminguide.html">Web Administrator's Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_4/migration.html">Migration Guide (from Axis1)</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="none">
+ <a href="../../1_3/contents.html">Version 1.3</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_2/contents.html">Version 1.2</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_1_1/contents.html">Version 1.1.1</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_1/contents.html">Version 1.1</a>
+ </li>
+
+ <li class="none">
+ <a href="../../1_0/index.html">Version 1.0</a>
+ </li>
+
+ <li class="none">
+ <a href="../../0_95/index.html">Version 0.95</a>
+ </li>
+
+ <li class="none">
+ <a href="../../0_94/index.html">Version 0.94</a>
+ </li>
+
+ <li class="none">
+ <a href="../../0_93/index.html">Version 0.93</a>
+ </li>
+ </ul>
+ <h5>Resources</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../faq.html">FAQ</a>
+ </li>
+
+ <li class="none">
+ <a href="../../articles.html">Articles</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink">Wiki</a>
+ </li>
+
+ <li class="none">
+ <a href="../../refLib.html">Reference Library</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/api/index.html">Online Java Docs</a>
+ </li>
+ </ul>
+ <h5>Get Involved</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../overview.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="../../svn.html">Checkout the Source</a>
+ </li>
+
+ <li class="none">
+ <a href="../../mail-lists.html">Mailing Lists</a>
+ </li>
+
+ <li class="none">
+ <a href="../../release-process.html">Release Process</a>
+ </li>
+
+ <li class="none">
+ <a href="../../guidelines.html">Developer Guidelines</a>
+ </li>
+
+ <li class="none">
+ <a href="../../siteHowTo.html">Build the Site</a>
+ </li>
+ </ul>
+ <h5>Project Information</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../team-list.html">Project Team</a>
+ </li>
+
+ <li class="none">
+ <a href="../../issue-tracking.html">Issue Tracking</a>
+ </li>
+
+ <li class="none">
+ <a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink">Source Code</a>
+ </li>
+
+ <li class="none">
+ <a href="../../thanks.html">Acknowledgements</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink">License</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../../images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <html xmlns="http://www.w3.org/1999/xhtml"><head><meta name="generator" content="HTML Tidy for Windows (vers 14 June 2007), see www.w3.org"><meta http-equiv="content-type" content="">Code Generator Tool Guide for Command Line and Ant
+Task<link href="../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></head><h1>Code Generator Tool Guide for Command Line and Ant Task</h1><p>The Code Generator tool consists of a command line version and
+an Ant Task. This document will list the command line references
+and Ant task references. Also in detail, this document shows how to
+build file using custom Ant task and invoking the Code Generator
+from Ant.</p>
+<p>This tool is bundled with the <a class="externalLink" href="http://ws.apache.org/axis2/download.cgi">Axis2 Binary
+Distribution</a>
+.</p>
+<h2>Content</h2><ul><li><a href="#intro">Introduction</a>
+</li>
+<li><a href="#cmdline">Command Line Version</a>
+<ul><li><a href="#cmdref">Option Reference</a>
+</li>
+</ul>
+</li>
+<li><a href="#ant">Ant Task</a>
+<ul><li><a href="#antref">Ant Task Reference</a>
+</li>
+<li><a href="#example">Example Build File Using the Custom Ant
+Task</a>
+</li>
+<li><a href="#invoking">Invoking the Code Generator From
+Ant</a>
+</li>
+</ul>
+</li>
+<li><a href="#appendix">Appendix</a>
+</li>
+</ul>
+<a name="intro"></a>
+<h2>Introduction</h2><p>This basic tool is implemented by the WSDL2Code class and just
+for the convenience in the case of Java (which would be the
+majority) there is another WSDL2Java class. One can choose to run
+the main classes directly or use one of the scripts to run the
+WSDL2Code and WSDL2Java appropriately. (the scripts are found in
+the bin directory of the <a href="../../download/1_1/download.html#std-bin">Standard Binary
+Distribution</a>
+)</p>
+<a name="cmdline"></a>
+<h2>Command Line Version</h2><p>For those users who wish to use the command line version of the
+tool, this section will be of value.</p>
+<a name="cmdref"></a>
+<h3>Option Reference</h3><p>Usage WSDL2Code <option_reference></p>
+<p><b>E.g. :- WSDL2Code -uri <Location of WSDL></b>
+</p>
+<table class="bodyTable"><tbody><tr class="a"><td width="20%"><strong>Short Option</strong></td>
+<td width="20%"><strong>Long Option</strong></td>
+<td width="60%"><strong>Description</strong></td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-uri <Location of WSDL></td>
+<td width="20%">None</td>
+<td width="60%">WSDL file location. This should point to a WSDL
+file in the local file system.</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%">-o <output Location></td>
+<td width="20%">--output <output Location></td>
+<td width="60%">Output file location. This is where the files would
+be copied once the code generation is done. If this option is
+omitted the generated files would be copied to the working
+directory.</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-l <language></td>
+<td width="20%">--language <language></td>
+<td width="60%">Output language. Currently the code generator can
+generate code in Java but it has the ability to be extended to
+support other languages.</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%">-p <package name></td>
+<td width="20%">--package <package name></td>
+<td width="60%">The target package name. If omitted, a default
+package (formed using the target namespace of the WSDL) will be
+used.</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-a</td>
+<td width="20%">--async</td>
+<td width="60%">Generate code only for async style. When this
+option is used the generated stubs will have only the asynchronous
+invocation methods. Switched off by default.</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%">-s</td>
+<td width="20%">--sync</td>
+<td width="60%">Generate code only for sync style . When this
+option is used the generated stubs will have only the synchronous
+invocation methods. Switched off by default. When used with the -a
+option, this takes precedence.</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-t</td>
+<td width="20%">--test-case</td>
+<td width="60%">Generates a test case. In the case of Java it would
+be a JUnit test case.</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%">-ss</td>
+<td width="20%">--server-side</td>
+<td width="60%">Generates server side code (i.e. skeletons).
+Default is off.</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-sd</td>
+<td width="20%">--service-description</td>
+<td width="60%">Generates the service descriptor (i.e. server.xml).
+Default is off. Only valid with -ss, the server side code
+generation option.</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%">-d <databinding></td>
+<td width="20%">--databinding-method <databinding></td>
+<td width="60%">Specifies the Databinding framework. Valid values
+are xmlbeans, adb, jibx, and none. Default is adb.</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-g</td>
+<td width="20%">--generate-all</td>
+<td width="60%">Generates all the classes. This option is valid
+only with the -ss (server side code generation) option. When on,
+the client code (stubs) will also be generated along with the
+skeleton.</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%">-u</td>
+<td width="20%">--unpack-classes</td>
+<td width="60%">Unpack classes. This option specifies whether to
+unpack the classes and generate separate classes for the
+databinders.</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-sn <service name></td>
+<td width="20%">--service-name <service name></td>
+<td width="60%">Specifies the service name to be code generated. If
+the service name is not specified, then the first service will be
+picked.</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%">-pn <port name></td>
+<td width="20%">--port-name <port name></td>
+<td width="60%">Specifies the port name to be code generated. If
+the port name is not specified, then the first port (of the
+selected service) will be picked.</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-ns2p</td>
+<td width="20%">--namespace2package</td>
+<td width="60%">Specifies a comma separated list of namespaces and
+packages where the given package will be used in the place of the
+auto generated package for the relevant namespace. The list will be
+the format of ns1=pkg1,ns2=pkg2.</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%">-ssi</td>
+<td width="20%">--serverside-interface</td>
+<td width="60%">Generate an interface for the service
+skeleton.</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-wv</td>
+<td width="20%">--wsdl-version</td>
+<td width="60%">WSDL Version. Valid Options : 2, 2.0, 1.1</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%">-S</td>
+<td width="20%">--source-folder</td>
+<td width="60%">Specify a directory path for generated source</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-R</td>
+<td width="20%">--resource-folder</td>
+<td width="60%">Specify a directory path for generated resources</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%">-em</td>
+<td width="20%">--external-mapping</td>
+<td width="60%">Specify an external mapping file</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-f</td>
+<td width="20%">--flatten-files</td>
+<td width="60%">Flattens the generated files</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%">-uw</td>
+<td width="20%">--unwrap-params</td>
+<td width="60%">Switch on un-wrapping</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-xsdconfig</td>
+<td width="20%"></td>
+<td width="60%">Use XMLBeans .xsdconfig file. Valid only with -d xmlbeans</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%">-ap</td>
+<td width="20%">--all-ports</td>
+<td width="60%">Generate code for all ports</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-or</td>
+<td width="20%">--over-ride</td>
+<td width="60%">Overwrite the existing classes</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%">-b</td>
+<td width="20%">--backword-compatible</td>
+<td width="60%">Generate Axis 1.x backword compatible code</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%">-sp</td>
+<td width="20%">--suppress-prefixes</td>
+<td width="60%">Suppress namespace prefixes (Optimzation that reduces size of soap request/response)</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%"></td>
+<td width="20%">--noBuildXML</td>
+<td width="60%">Don't generate the build.xml in the output directory</td>
+<td></td>
+</tr>
+<tr class="b"><td width="20%"></td>
+<td width="20%">--noWSDL</td>
+<td width="60%">Don't generate WSDL's in the resources directory</td>
+<td></td>
+</tr>
+<tr class="a"><td width="20%"></td>
+<td width="20%">--noMessageReceiver</td>
+<td width="60%">Don't generate a MessageReceiver in the generated sources</td>
+<td></td>
+</tr>
+</tbody></table>
+<p>Apart from these mentioned options one can pass extra options by
+prefixing them with -E (uppercase). These extra options will be
+processed by the extensions. The extra options that can be passed
+are documented separately with the extensions documentation (For
+example with ADB).</p>
+<a name="ant"></a>
+<h2>Ant Task</h2><p>The code generator also comes bundled with an Ant task. The ant
+task is implemented by the org.apache.axis2.tool.ant.AntCodegenTask
+class. Following are the ant task attributes.</p>
+<a name="antref"></a>
+<h3>Ant Task Reference</h3><table class="bodyTable"><tbody><tr class="b"><td>wsdlfilename</td>
+<td>WSDL file location. Maps to the -uri option of the command line
+tool.</td>
+</tr>
+<tr class="a"><td>output</td>
+<td>Output file location. This is where the files would be copied
+once the code generation is done. If this option is omitted the
+generated files would be copied to the working directory. Maps to
+the -o option of the command line tool.</td>
+</tr>
+<tr class="b"><td>language</td>
+<td>Output language. Currently the code generator can generate code
+in Java. Maps to the -l option of the command line tool.</td>
+</tr>
+<tr class="a"><td>packageName</td>
+<td>The target package name. If omitted, a default package (formed
+using the target namespace of the WSDL) will be used. Maps to the
+-p option of the command line tool.</td>
+</tr>
+<tr class="b"><td>databindingName</td>
+<td>Data binding framework name. Maps to the -d option of the
+command line tool. Possible values include "adb", "xmlbeans",
+"jibx".</td>
+</tr>
+<tr class="a"><td>serviceName</td>
+<td>The name of the service in the case of multiple services. Maps
+to -sn options of the command line tool.</td>
+</tr>
+<tr class="b"><td>portName</td>
+<td>The name of the port in the presence of multiple ports. Maps to
+-pn options of the command line tool.</td>
+</tr>
+<tr class="a"><td>asyncOnly</td>
+<td>Generate code only for async style. When this option is used
+the generated stubs will have only the asynchronous invocation
+methods. Defaults to false if omitted. Only true and false are
+applicable as values. Maps to the -a option of the command line
+tool.</td>
+</tr>
+<tr class="b"><td>syncOnly</td>
+<td>Generate code only for sync style. When this option is used the
+generated stubs will have only the synchronous invocation methods.
+Defaults to false if omitted. Only true and false are applicable as
+values. Maps to the -s option of the command line tool.</td>
+</tr>
+<tr class="a"><td>serverSide</td>
+<td>Generates server side code (i.e. skeletons). Only true and
+false are applicable as values. Default is false. Maps to the -ss
+option of the command line tool.</td>
+</tr>
+<tr class="b"><td>testcase</td>
+<td>Generates a test case. Possible values are true and false. Maps
+to the -t options of the command line tool.</td>
+</tr>
+<tr class="a"><td>generateServiceXml</td>
+<td>Generates server side code (i.e. skeletons). Only true and
+false are applicable as values. Default is false. Maps to the -sd
+option of the command line tool.</td>
+</tr>
+<tr class="b"><td>unpackClasses</td>
+<td>Unpacks the generated classes. This forces the databinding
+classes to be generated separately, which otherwise would have been
+generated as inner classes.</td>
+</tr>
+<tr class="a"><td>generateAllClasses</td>
+<td>Generates all the classes including client and server side
+code. Maps to the -g option of the command line tool.</td>
+</tr>
+<tr class="b"><td>namespaceToPackages</td>
+<td>A list of namespace to package mappings.</td>
+</tr>
+<tr class="a"><td>serverSideInterface</td>
+<td>Flag stating whether to generate an interface for the server
+side skeleton.</td>
+</tr>
+<tr class="b"><td>repositoryPath</td>
+<td>Sets the repository path to be used. Maps to the -r option of
+the command line tool.</td>
+</tr>
+<tr class="a"><td>wsdlVersion</td>
+<td>Sets the version of the wsdl that is being used during
+codegeneration. This deafults to 1.1 and one can set this to 2,
+when trying to work with a WSDL 2.0 document. Maps to the -wv
+option of the command line tool.</td>
+</tr>
+<tr class="b"><td>externalMapping</td>
+<td>Location of the external mapping file to be used. Maps to the
+-em option of the command line tool.</td>
+</tr>
+<tr class="a"><td>targetSourceFolderLocation</td>
+<td>Rather than dumping all the code in the same location, one has
+the option to make the sources to be generated in a different
+location, given using this option. Maps to the -S option of the
+command line tool.</td>
+</tr>
+<tr class="b"><td>targetResourcesFolderLocation</td>
+<td>Rather than dumping all the code in the same location, one has
+the option to make the resources to be generated in a different
+location, given using this option. Maps to the -R option of the
+command line tool.</td>
+</tr>
+<tr class="a"><td>unwrap</td>
+<td>This will select between wrapped and unwrapped during code
+generation. Default is set to false. Maps to the -uw option of the
+command line tool.</td>
+</tr>
+</tbody></table>
+<a name="example"></a>
+<h3>Example Build File Using the Custom Ant Task</h3><p>Following is an example ant build file that uses the custom Ant
+task. You can use any wsdl file to test the example. Replace the
+"CombinedService.wsdl" with the name of your wsdl file in the
+following script.</p>
+<pre>
+1 <?xml version="1.0"?>
+ 2 <project name="CodegenExample" default="main" basedir=".">
+ 3
+ 4 <path id="example.classpath">
+ 5 <fileset dir="classes">
+ 6 <include name="**/*.jar" />
+ 7 </fileset>
+ 8 </path>
+ 9
+ 10 <target name="declare" >
+ 11 <taskdef name="codegen"
+ 12 classname="org.apache.axis2.tool.ant.AntCodegenTask"
+ 13 classpathref="example.classpath"/>
+ 15 </target>
+ 16
+ 17 <target name="main" depends="declare">
+ 18 <codegen
+ 19 wsdlfilename="C:\test\wsdl\CombinedService.wsdl"
+ 20 output="C:\output"
+ 21 serverside="true"
+ 22 generateservicexml="true"/>
+ 23 </target>
+ 24
+ 25 </project>
+</pre><p>In the above build script, from line 4 to 8 it sets the
+classpath and includes all the .jar files (which are listed below)
+into the classpath. From line 10 to 15 it creates a target to
+declare a task called "codegen" and sets the appropriate class
+(org.apache.axis2.tool.ant.AntCodegenTask) within the classpath in
+line 12. From line 17 to 23 it creates the "main" target to
+generate the code from the given wsdl. There are some arguments set
+form line 19 to 22. Here in line 19 it sets the location of the
+wsdl. In line 20 it sets the output directory in which the code is
+generated. Line 21 indicates that this build generates the server
+side code(skeleton) and line 22 indicates that the services.xml is
+also generated.</p>
+<p>Notice the main target that uses the "codegen" task which will
+use the org.apache.axis2.tool.ant.AntCodegenTask class and run the
+code generation tool internally while passing the relevant
+arguments and do the proper generation. If a user types</p>
+<p><code>>ant</code> or <code>>ant main</code></p>
+<p>it will generate the server side code and services.xml for the
+given WSDL file (C:\test\wsdl\CombinedService.wsdl -in the above
+instance) and the generated code will be written to the specified
+output path (C:\output - in the above instance).</p>
+<p>For this Ant task to work the following jars need to be in the
+class path.</p>
+<ul><li>axis2-*.jar (from the Axis2 distribution)</li>
+<li>wsdl4j-1.6.2.jar or higher (The WSDL4J implementation jar.
+Bundled with the Axis2 distribution)</li>
+<li>stax-api-1.0.1.jar (The StAX API's that contain the
+javax.xml.namespace.QName class. This jar may be replaced by any
+other jar that contains the javax.xml.namespace.QName
+implementation. However Axis2 uses this class from the
+stax-api-1.0.1.jar which comes bundled with the Axis2
+distribution)</li>
+<li>commons-logging-1.1.jar, neethi-2.0.jar and XmlSchema-1.2.jar
+(from the Axis2 distribution)</li>
+<li>axiom-api-1.2.1.jar and axiom-impl-1.2.1.jar (from the Axis2
+distribution)</li>
+<li>activation-1.1.jar (from the Axis2 distribution)</li>
+<li>wstx-asl-3.1.0.jar (from the Axis2 distribution)</li>
+</ul>
+<a name="invoking"></a>
+<h3>Invoking the Code Generator From Ant</h3><p>Since the users may find altering their ant class path a bit
+daunting they can also follow an easier technique. The code
+generator main class can be invoked directly through the build
+file.</p>
+<p>Below is an example of a full build.xml needed to run WSDL2Java
+and generate the Java source files, compile the sources, and build
+an AAR file ready for deployment (These are done one by one, by
+calling the targets in the build file separately):</p>
+<pre class="code">
+<!DOCTYPE project>
+
+<project name="wsdl2java-example" default="usage" basedir=".">
+
+<property name="project-name" value="wsdl2java-example"/>
+<property file="build.properties"/>
+
+<property name="build" value="build"/>
+<property name="src" value="src"/>
+<property name="build.classes" value="build/classes" />
+
+<path id="axis.classpath">
+<pathelement location="build/classes" />
+<fileset dir="${axis.home}/lib">
+<include name="**/*.jar" />
+</fileset>
+<pathelement location="${build.classes}" />
+</path>
+
+<path id="axis_client.classpath">
+<pathelement location="build/classes" />
+<fileset dir="${axis.home}">
+<include name="**/*.jar" />
+</fileset>
+<fileset dir="lib">
+<include name="*.jar" />
+</fileset>
+<pathelement location="${build.classes}" />
+</path>
+
+<target name="usage" description="Build file usage info (default task)">
+<echo message=" " />
+<echo message="${project-name} " />
+<echo message="-------------------------------------------------------" />
+<echo message=" " />
+<echo message="Available Targets:" />
+<echo message=" " />
+<echo message=" Compiling:" />
+<echo message=" compile - Compiles the WSDL2Java source code" />
+<echo message=" " />
+<echo message=" Compiling client:" />
+<echo message=" compile_client - Compiles the client source code" />
+<echo message=" " />
+<echo message=" Cleaning up:" />
+<echo message=" clean - Delete class files" />
+<echo message=" " />
+<echo message=" WSDL:" />
+<echo message=" wsdl2java - Generate source from WSDL" />
+<echo message=" " />
+<echo message=" AAR:" />
+<echo message=" aar - Generate an .aar for deployment into WEB-INF/services" />
+<echo message=" " />
+<echo message=" Executing:" />
+<echo message=" runLogin - Execute the runLogin client" />
+</target>
+
+<target name="prepare" >
+<mkdir dir="${build.classes}" />
+</target>
+
+<target name="clean" >
+<delete dir="${build}" />
+<delete dir="${dist}" />
+</target>
+
+<target name="compile">
+<echo message="Compiling wsdl2 files"/>
+
+<javac
+srcdir="output"
+destdir="${build.classes}"
+deprecation="true"
+failonerror="true" debug="true">
+
+<classpath refid="axis.classpath"/>
+</javac>
+
+</target>
+
+<target name="wsdl2java" depends="clean,prepare">
+<delete dir="output" />
+<java classname="org.apache.axis2.wsdl.WSDL2Java" fork="true">
+<classpath refid="axis.classpath"/>
+<arg value="-d"/>
+<arg value="xmlbeans"/>
+<arg value="-uri"/>
+<arg file="wsdl/LoginEndpoint.wsdl"/>
+<arg value="-ss"/>
+<arg value="-g"/>
+<arg value="-sd"/>
+<arg value="-o"/>
+<arg file="output"/>
+<arg value="-p"/>
+<arg value="org.example.types"/>
+</java>
+
+<!-- Move the schema folder to classpath-->
+<move todir="${build.classes}">
+<fileset dir="output/resources">
+<include name="**/*schema*/**/*.class"/>
+<include name="**/*schema*/**/*.xsb"/>
+</fileset>
+</move>
+
+</target>
+
+<target name="jar_wsdl" depends="compile">
+<jar jarfile="lib/axis2_example_wsdl.jar" >
+<fileset dir="${build.classes}" />
+</jar>
+</target>
+
+<!-- build an .aar file for axis2 web services -->
+<target name="aar" depends="compile">
+<delete dir="${build.classes}/META-INF" />
+<mkdir dir="${build.classes}/META-INF" />
+<copy todir="${build.classes}/META-INF" >
+<fileset dir="output/resources" >
+<!-- axis2 web services definitions file -->
+<include name="services.xml"/>
+</fileset>
+<fileset dir="wsdl" >
+<include name="LoginEndpoint.wsdl"/>
+</fileset>
+</copy>
+<jar jarfile="dist/LoginEndpoint.aar" >
+<fileset dir="${build.classes}" />
+</jar>
+</target>
+
+<target name="compile_client">
+<echo message="Compiling client files"/>
+
+<javac
+srcdir="src"
+destdir="${build.classes}"
+deprecation="true"
+failonerror="true" debug="true">
+
+<classpath refid="axis.classpath"/>
+</javac>
+
+</target>
+
+<target name="runLogin" depends="prepare,compile_client" description="run simple Login client">
+<java classname="org.client.LoginClient" >
+<classpath refid="axis_client.classpath"/>
+</java>
+</target>
+
+</project>
+</pre><p>Place the above build.xml file in the 'bin' directory of the
+axis2 binary distribution. Then create a build.properties file in
+the same directory and specify the axis.home path pointing to the
+axis2 binary distribution</p>
+<p>E.g. :- axis.home=C://Axis2//axis2-1.1-bin</p>
+<p>The above build.xml example also assumes three empty directories
+exist, 'dist', 'lib', and 'src'.</p>
+<p>Below is a validated WSDL Document following the
+Document/Literal Style. The name of this file matches the name used
+in the WSDL2Java ant task above, LoginEndpoint.wsdl.</p>
+<pre class="code">
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <definitions name="LoginService" targetNamespace="http://login" xmlns:tns="http://login"
+ xmlns="http://schemas.xmlsoap.org/wsdl/" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+ xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:ns2="http://login/types">
+
+ <types>
+ <schema targetNamespace="http://login/types" xmlns:tns="http://login/types"
+ xmlns:soap11-enc="http://schemas.xmlsoap.org/soap/encoding/"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
+ xmlns="http://www.w3.org/2001/XMLSchema">
+ <import namespace="http://schemas.xmlsoap.org/soap/encoding/"/>
+ <element name="returnWebLoginElement">
+ <complexType>
+ <sequence>
+
+ <element ref="tns:soap_session_idElement"/>
+ <element ref="tns:web_user_nameElement"/>
+ </sequence>
+ </complexType>
+ </element>
+ <element name="webLoginElement">
+
+ <complexType>
+ <sequence>
+ <element ref="tns:user_nameElement"/>
+ <element ref="tns:user_passwordElement"/>
+ </sequence>
+ </complexType>
+
+ </element>
+ <element name="user_nameElement" type="xsd:string"/>
+ <element name="user_passwordElement" type="xsd:string"/>
+ <element name="soap_session_idElement" type="xsd:string"/>
+ <element name="web_user_nameElement" type="xsd:string"/>
+ </schema></types>
+
+ <message name="LoginEndpoint_webLogin">
+ <part name="parameters" element="ns2:webLoginElement"/>
+ </message>
+ <message name="LoginEndpoint_webLoginResponse">
+ <part name="result" element="ns2:returnWebLoginElement"/>
+ </message>
+
+ <portType name="LoginEndpoint">
+ <operation name="webLogin">
+ <input message="tns:LoginEndpoint_webLogin" name="LoginEndpoint_webLogin"/>
+ <output message="tns:LoginEndpoint_webLoginResponse" name="LoginEndpoint_webLoginResponse"/>
+ </operation>
+ </portType>
+
+ <binding name="LoginEndpointBinding" type="tns:LoginEndpoint">
+ <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
+ <operation name="webLogin">
+ <soap:operation soapAction="webLogin"/>
+ <input name="LoginEndpoint_webLogin">
+ <soap:body use="literal"/>
+
+ </input>
+ <output name="LoginEndpoint_webLoginResponse">
+ <soap:body use="literal"/>
+ </output>
+ </operation>
+ </binding>
+
+ <service name="LoginService">
+ <port name="LoginEndpointPort" binding="tns:LoginEndpointBinding">
+ <soap:address location="http://localhost:8080/axis2/services/LoginService"/></port>
+ </service></definitions>
+</pre><p>Place the above file, named LoginEndpoint.wsdl, in the directory
+'wsdl' which is also inside the 'bin' directory. Run the wsdl2java
+command via the ant task defined above (>ant wsdl2java), and
+there will be a directory called 'output' created. This directory
+contains the WSDL2Java generated source.</p>
+<p>An important detail is that an XMLBean class file is also
+generated by WSDL2Java, TypeSystemHolder.class. That file is placed
+into build/classes by the above ant task and will be needed to
+compile the generated sources. A frequent problem is users get an
+error such as:</p>
+<p><em><b>ClassNotFoundException : Cannot load SchemaTypeSystem.
+Unable to load class with name
+schemaorg_apache_xmlbeans.system.s68C41DB812F52C975439BA10FE4FEE54.TypeSystemHolder.
+Make sure the generated binary files are on the
+classpath.</b>
+</em></p>
+<p>The TypeSystemHolder.class generated by WSDL2Java must be placed
+in your classpath in order to avoid this error.</p>
+<p>The next step is to modify the generated Skeleton Java Source
+file - the Web service. This file as generated returns null and
+needs to be updated to contain the business logic.</p>
+<p>After the WSDL2Java command runs the file LoginEndpoint.wsdl,
+edit the following file:</p>
+<p>output/src/org/example/types/LoginServiceSkeleton.java. You
+should see the following code:</p>
+<pre class="code">
+/**
+ * LoginServiceSkeleton.java
+ *
+ * This file was auto-generated from WSDL
+ * by the Apache Axis2 version: 1.0-RC4 Apr 28, 2006 (05:23:23 IST)
+ */
+ package org.example.types;
+ /**
+ * LoginServiceSkeleton java skeleton for the axisService
+ */
+ public class LoginServiceSkeleton {
+
+
+ /**
+ * Auto generated method signature
+
+ * @param param0
+
+ */
+ public login.types.ReturnWebLoginElementDocument webLogin
+ (login.types.WebLoginElementDocument param0 )
+
+ {
+ //Todo fill this with the necessary business logic
+ throw new java.lang.UnsupportedOperationException();
+ }
+
+ }
+</pre><p>Replace the contents of this file with the following, which uses
+the complex types generated by WSDL2Java and the example wsdl
+file:</p>
+<pre class="code">
+/**
+ * LoginServiceSkeleton.java
+ *
+ * This file was auto-generated from WSDL
+ * by the Apache Axis2 version: 1.0-RC4 Apr 28, 2006 (05:23:23 IST)
+ */
+ package org.example.types;
+ import login.types.ReturnWebLoginElementDocument;
+ import login.types.ReturnWebLoginElementDocument.*;
+ import login.types.WebLoginElementDocument;
+ import login.types.WebLoginElementDocument.*;
+
+ /**
+ * Auto generated java skeleton for the service by the Axis code generator
+ */
+ public class LoginServiceSkeleton {
+
+ /**
+ * Auto generated method signature
+
+ * @param webLoginElementDocument changed from param0
+
+ */
+ public ReturnWebLoginElementDocument webLogin
+ (WebLoginElementDocument webLoginElementDocument ){
+
+ //Todo fill this with the necessary business logic
+ System.out.println("LoginServiceSkeleton.webLogin reached successfully!");
+
+ // Get parameters passed in
+ WebLoginElement webLoginElement = webLoginElementDocument.getWebLoginElement();
+ String userName = webLoginElement.getUserNameElement();
+ String password = webLoginElement.getUserPasswordElement();
+ System.out.println("LoginServiceSkeleton.webLogin userName: " + userName);
+ System.out.println("LoginServiceSkeleton.webLogin password: " + password);
+
+ // input paramaters would be used here
+
+ // prepare output
+ ReturnWebLoginElementDocument retDoc =
+ ReturnWebLoginElementDocument.Factory.newInstance();
+
+ ReturnWebLoginElement retElement = ReturnWebLoginElement.Factory.newInstance();
+
+ retElement.setWebUserNameElement("joe sixpack");
+ retElement.setSoapSessionIdElement("some_random_string");
+ System.out.println("validate retElement: " + retElement.validate());
+
+ retDoc.setReturnWebLoginElement(retElement);
+ System.out.println("validate retDoc: " + retDoc.validate());
+
+ System.out.println("LoginServiceSkeleton.webLogin returning...");
+
+ return retDoc;
+
+ }
+ }
+</pre><p>The next steps assume the axis2.war has been deployed and has
+expanded in a servlet container.</p>
+<p>Run the 'jar_wsdl' ant task from the example build.xml (>ant
+jar_wsdl), which generates a jar file axis2_example_wsdl.jar in the
+'bin/lib' directory. This jar will be used to compile the client,
+and also will be placed in the servlet container.</p>
+<p>Next, run the 'aar' ant task from the example build.xml (>ant
+aar), which generates the deployable axis2 Web service. Place
+dist/LoginEndpoint.aar into axis2/WEB-INF/services . Place
+lib/axis2_example_wsdl.jar into axis2/WEB-INF/lib . Verify the
+happy axis page loaded the services correctly - there should be the
+service 'LoginEndpoint' with the available operation 'webLogin'
+displayed.</p>
+<p>The last step is to create and run the client. In the src
+directory create the file org.client.LoginClient.java, with the
+contents below:</p>
+<pre class="code">
+package org.client;
+
+ import org.apache.axis2.AxisFault;
+
+ import login.types.ReturnWebLoginElementDocument;
+ import login.types.ReturnWebLoginElementDocument.*;
+ import login.types.WebLoginElementDocument;
+ import login.types.WebLoginElementDocument.*;
+ import org.example.types.LoginServiceStub;
+
+ /**
+ * Login.
+ *
+ */
+ public class LoginClient {
+
+ public static void main(String[] args) {
+ try {
+
+ System.out.println("webLogin, firing...");
+ LoginServiceStub stub = new LoginServiceStub();
+
+ WebLoginElementDocument webLoginElementDocument
+ = WebLoginElementDocument.Factory.newInstance();
+ WebLoginElement webLoginElement =
+ WebLoginElement.Factory.newInstance();
+ webLoginElement.setUserNameElement("joe");
+ webLoginElement.setUserPasswordElement("sixpack");
+
+ webLoginElementDocument.setWebLoginElement(webLoginElement);
+
+ System.out.println("validate: " + webLoginElement.validate());
+ stub.webLogin(webLoginElementDocument);
+
+ ReturnWebLoginElementDocument returnWebLoginElementDocument =
+ stub.webLogin(webLoginElementDocument);
+
+ System.out.println("Client returned");
+
+ ReturnWebLoginElementDocument.ReturnWebLoginElement
+ retElement = returnWebLoginElementDocument.getReturnWebLoginElement();
+
+ System.out.println("WebUserName: " + retElement.getWebUserNameElement());
+ System.out.println("SOAPSessionId: " + retElement.getSoapSessionIdElement());
+ System.out.println("webLogin, completed!!!");
+
+ } catch (AxisFault axisFault) {
+ axisFault.printStackTrace();
+ } catch (Exception ex) {
+ ex.printStackTrace();
+ }
+ }
+ }
+</pre><p>Now run the ant task 'runLogin' (>ant runLogin). The
+following output should appear:</p>
+<pre class="code">
+runLogin:
+ [echo] running the webLogin client
+ [java] webLogin, firing...
+ [java] validate: true
+ [java] Client returned
+ [java] WebUserName: joe sixpack
+ [java] SOAPSessionId: some_random_string
+ [java] webLogin, completed!!!
+</pre><a name="appendix"></a>
+<h2>Appendix</h2><ul><li>Eclipse reference - <a class="externalLink" href="http://www.eclipse.org/">http://www.eclipse.org/</a>
+</li>
+<li>Custom Ant Tasks - <a class="externalLink" href="http://ant.apache.org/manual/develop.html">http://ant.apache.org/manual/develop.html</a>
+</li>
+</ul>
+</html>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2004-2008
+
+ Apache Software Foundation
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: webservices/axis2/site/tools/1_4/eclipse/servicearchiver-plugin.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/tools/1_4/eclipse/servicearchiver-plugin.html?rev=652665&view=auto
==============================================================================
--- webservices/axis2/site/tools/1_4/eclipse/servicearchiver-plugin.html (added)
+++ webservices/axis2/site/tools/1_4/eclipse/servicearchiver-plugin.html Thu May 1 14:20:27 2008
@@ -0,0 +1,431 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - </title>
+ <style type="text/css" media="all">
+ @import url("../../../css/maven-base.css");
+ @import url("../../../css/maven-theme.css");
+ @import url("../../../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../../../css/print.css" type="text/css" media="print" />
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../" id="bannerLeft">
+
+ <img src="http://www.apache.org/images/asf_logo_wide.png" alt="" />
+
+ </a>
+ <span id="bannerRight">
+
+ <img src="../../../../images/axis.jpg" alt="" />
+
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 2008-05-01
+ </div>
+ <div class="xright"> <a href="../../../index.html">Axis2/Java</a>
+ |
+ <a href="../../../../c">Axis2/C</a>
+ |
+ <a href="../../../../..">Apache WS</a>
+ |
+ <a href="http://www.apache.org" class="externalLink">Apache</a>
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+
+ <h5>Axis2/Java</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../../index.html">Home</a>
+ </li>
+ </ul>
+ <h5>Downloads</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../../download.cgi">Releases</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../modules/index.html">Modules</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../tools/index.html">Tools</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../../../1_4/contents.html">Version 1.4</a>
+ <ul>
+
+ <li class="none">
+ <a href="../../../1_4/toc.html">Table of Contents</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/installationguide.html">Installation Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/quickstartguide.html">QuickStart Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/userguide.html">User Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/jaxws-guide.html">JAXWS Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/pojoguide.html">POJO Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/spring.html">Spring Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/webadminguide.html">Web Administrator's Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/migration.html">Migration Guide (from Axis1)</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_3/contents.html">Version 1.3</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_2/contents.html">Version 1.2</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_1_1/contents.html">Version 1.1.1</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_1/contents.html">Version 1.1</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_0/index.html">Version 1.0</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../0_95/index.html">Version 0.95</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../0_94/index.html">Version 0.94</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../0_93/index.html">Version 0.93</a>
+ </li>
+ </ul>
+ <h5>Resources</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../../faq.html">FAQ</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../articles.html">Articles</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink">Wiki</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../refLib.html">Reference Library</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../../1_4/api/index.html">Online Java Docs</a>
+ </li>
+ </ul>
+ <h5>Get Involved</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../../overview.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../svn.html">Checkout the Source</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../mail-lists.html">Mailing Lists</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../release-process.html">Release Process</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../guidelines.html">Developer Guidelines</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../siteHowTo.html">Build the Site</a>
+ </li>
+ </ul>
+ <h5>Project Information</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../../team-list.html">Project Team</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../issue-tracking.html">Issue Tracking</a>
+ </li>
+
+ <li class="none">
+ <a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink">Source Code</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../thanks.html">Acknowledgements</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink">License</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../../../images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <html xmlns="http://www.w3.org/1999/xhtml"><head><meta name="generator" content="HTML Tidy for Windows (vers 14 June 2007), see www.w3.org"><meta http-equiv="content-type" content="">Service Archive Generator Wizard Guide for Eclipse
+Plug-in<link href="../../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></head><h1>Service Archive Generator Wizard Guide for Eclipse Plug-in</h1><p>This document will guide you through the installation and usage
+of the archive generator Eclipse plug-in.</p>
+<p><a class="externalLink" href="http://ws.apache.org/axis2/tools/index.html">[Download Plugin Tool]</a>
+</p>
+<h2>Content</h2><ul><li><a href="#intro">Introduction</a>
+</li>
+<li><a href="#installation">Installation</a>
+</li>
+<li><a href="#operation">Operation</a>
+</li>
+</ul>
+<a name="intro"></a>
+<h2>Introduction</h2><p>As part of the Axis2 tool set, the service archive generator is
+an important tool that allows the generation of service archives
+("aar" file or a "jar" files) that can be deployed as a web
+services to the Axis2.</p>
+<a name="installation"></a>
+<h2>Installation</h2><p>One can easily <a class="externalLink" href="http://ws.apache.org/axis2/tools/index.html">download</a>
+ the
+plugin</p>
+<p>If one needs to build the plug-in from source, Maven2 and Ant
+builds arevailabe. Please refer the readme.txt located at
+module/tools on Axis2 source.</p>
+<p>Once you've obtained the plug-in just unzip the content of the
+plug-in archive to the Eclipse plug-in directory (if it is the
+zipped-binary version) or copy the necessary folders to the Eclipse
+plug-in directory and restart Eclipse.</p>
+<p><strong>NOTE</strong> : This plug-in works on Eclipse version
+3.1 and upwards, also the java version should be 1.4 or higher. The
+provided screen shots may slightly differ with what the user would
+actually see but the functionality has not been changed.</p>
+<a name="operation"></a>
+<h2>Operation</h2><p>If the plug-in is properly installed you should see a new wizard
+under the "New" section. (Use the File -> New -> Other or
+Ctrl + N )</p>
+<p><img src="images/ServiceWizardSelection.jpg" /></p>
+<p>Selecting the wizard and pressing the "Next" button will start
+the service generator wizard. Following is the first page of the
+wizard.</p>
+<p><strong>Page 1:</strong></p>
+<p><img src="images/ServicePage1.jpg" /></p>
+<p>Once the class file folder(which should be a folder in the
+file system) is browsed and selected, the "Next" button will be
+enabled and you can move to the next page. Note that you have the
+option of either including all the files or the class files only of
+the folder on page 1.</p>
+<p><strong>Page 2:</strong></p>
+<p>Page 2 of the wizard as seen below requires you to locate/browse
+the WSDL file. If you do not wish to add a WSDL file to the service
+archive, select skip WSDL, else you can select the location of the
+WSDL file by selecting the select WSDL option.</p>
+<p><img src="images/service_page2.jpg" /></p>
+<p><strong>Page 3:</strong></p>
+<p>Select the services.xml file on this wizard page by browsing or
+select the option of generating service xml automatically, after
+which you can click "Next" button to go to the next page. Notice
+how the browsing option disables when the "Generate service xml
+automatically" check box is ticked.</p>
+<p><img src="images/service_page3.jpg" /></p>
+<p><strong>Page 4:</strong></p>
+<p>The next step is to add the libraries. The library addition page
+looks like this :</p>
+<p><img src="images/service_page5.jpg" /></p>
+<p>The library name (with full path) can be either typed on the
+text box or browsed for using the "Browse" button.</p>
+<p><img src="images/service_page5_browsed.jpg" /></p>
+<p>Once there is a library name with full path on the text box, hit
+the "Add" button to add the library to the list. Added libraries
+should be displayed in the "Added libraries" list box. This way you
+can add as many external libraries as you wish. See the screen
+shots below.</p>
+<p><img src="images/service_page5_hl.jpg" /></p>
+<p><img src="images/service_page5_added.jpg" /></p>
+<p>If any added library needs to be removed, highlight it or in
+other words, select it from the "Added libraries" list and hit on
+the "Remove" button as shown below. Click on the "Next" button to
+proceed to the last page of the wizard if the user did not select
+to auto generate the services.xml file. If user select to auto
+generate the services.xml file then the services.xml option page
+will be displayed.</p>
+<p><img src="images/service_page5_remove.jpg" /></p>
+<p><strong>Page 5:</strong></p>
+<p>This page only appears if the user select to generate the
+services.xml at page 3 of the wizard. If the user have selected a
+services.xml then the user will be directed to the last page of the
+wizard.</p>
+<p>After entering the correct service name and valid fully
+qualified class name, try to load the existing methods of that
+class by clicking the load button.</p>
+<p><img src="images/service_page4_load.jpg" /></p>
+<p>If successfully loaded the user will be presented with a table
+at the bottom of the page with the details of the loaded class. By
+checking and unchecking the user can select the necessary methods
+to include in the services.xml</p>
+<p><img src="images/service_page4_table.jpg" /></p>
+<p>By clicking on the search declared method only check box, the
+user can remove the inherited methods from the class. Click on the
+"Next" button to proceed to the last page of the wizard</p>
+<p><img src="images/service_page4_search_declared.jpg" /></p>
+<p><strong>Page 6:</strong></p>
+<p>The last page of the wizard asks for the output file location
+and the output archive file name. To be able to finish the wizard,
+user must enter valid output file location and output file
+name.</p>
+<p><img src="images/service_page6.jpg" /></p>
+<p>Once all the parameters are filled, hit the "Finish" button to
+complete the wizard and generate the service archive.</p>
+<p><img src="images/success_msg.jpg" /></p>
+<p>If you see the above message, then you've successfully generated
+the service archive! This service archive can be hot deployed
+(deployed at run time) to the axis2</p>
+<h1>Appendix</h1><ul><li>Eclipse reference - <a class="externalLink" href="http://www.eclipse.org/">http://www.eclipse.org/</a>
+</li>
+<li>Custom Ant Tasks - <a class="externalLink" href="http://ant.apache.org/manual/develop.html">http://ant.apache.org/manual/develop.html</a>
+</li>
+</ul>
+</html>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2004-2008
+
+ Apache Software Foundation
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: webservices/axis2/site/tools/1_4/eclipse/wsdl2java-plugin.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/tools/1_4/eclipse/wsdl2java-plugin.html?rev=652665&view=auto
==============================================================================
--- webservices/axis2/site/tools/1_4/eclipse/wsdl2java-plugin.html (added)
+++ webservices/axis2/site/tools/1_4/eclipse/wsdl2java-plugin.html Thu May 1 14:20:27 2008
@@ -0,0 +1,443 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+
+
+
+
+
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - </title>
+ <style type="text/css" media="all">
+ @import url("../../../css/maven-base.css");
+ @import url("../../../css/maven-theme.css");
+ @import url("../../../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../../../css/print.css" type="text/css" media="print" />
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../" id="bannerLeft">
+
+ <img src="http://www.apache.org/images/asf_logo_wide.png" alt="" />
+
+ </a>
+ <span id="bannerRight">
+
+ <img src="../../../../images/axis.jpg" alt="" />
+
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+
+
+
+
+
+
+
+ <div class="xleft">
+ Last Published: 2008-05-01
+ </div>
+ <div class="xright"> <a href="../../../index.html">Axis2/Java</a>
+ |
+ <a href="../../../../c">Axis2/C</a>
+ |
+ <a href="../../../../..">Apache WS</a>
+ |
+ <a href="http://www.apache.org" class="externalLink">Apache</a>
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+
+
+
+
+
+
+
+ <h5>Axis2/Java</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../../index.html">Home</a>
+ </li>
+ </ul>
+ <h5>Downloads</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../../download.cgi">Releases</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../modules/index.html">Modules</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../tools/index.html">Tools</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="expanded">
+ <a href="../../../1_4/contents.html">Version 1.4</a>
+ <ul>
+
+ <li class="none">
+ <a href="../../../1_4/toc.html">Table of Contents</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/installationguide.html">Installation Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/quickstartguide.html">QuickStart Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/userguide.html">User Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/jaxws-guide.html">JAXWS Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/pojoguide.html">POJO Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/spring.html">Spring Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/webadminguide.html">Web Administrator's Guide</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_4/migration.html">Migration Guide (from Axis1)</a>
+ </li>
+ </ul>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_3/contents.html">Version 1.3</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_2/contents.html">Version 1.2</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_1_1/contents.html">Version 1.1.1</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_1/contents.html">Version 1.1</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../1_0/index.html">Version 1.0</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../0_95/index.html">Version 0.95</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../0_94/index.html">Version 0.94</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../0_93/index.html">Version 0.93</a>
+ </li>
+ </ul>
+ <h5>Resources</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../../faq.html">FAQ</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../articles.html">Articles</a>
+ </li>
+
+ <li class="none">
+ <a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink">Wiki</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../refLib.html">Reference Library</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../../1_4/api/index.html">Online Java Docs</a>
+ </li>
+ </ul>
+ <h5>Get Involved</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../../overview.html">Overview</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../svn.html">Checkout the Source</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../mail-lists.html">Mailing Lists</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../release-process.html">Release Process</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../guidelines.html">Developer Guidelines</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../siteHowTo.html">Build the Site</a>
+ </li>
+ </ul>
+ <h5>Project Information</h5>
+ <ul>
+
+ <li class="none">
+ <a href="../../../team-list.html">Project Team</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../issue-tracking.html">Issue Tracking</a>
+ </li>
+
+ <li class="none">
+ <a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink">Source Code</a>
+ </li>
+
+ <li class="none">
+ <a href="../../../thanks.html">Acknowledgements</a>
+ </li>
+
+ <li class="none">
+ <a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink">License</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../../../images/logos/maven-feather.png"></img>
+ </a>
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <html xmlns="http://www.w3.org/1999/xhtml"><head><meta name="generator" content="HTML Tidy for Windows (vers 14 June 2007), see www.w3.org"><meta http-equiv="content-type" content="">Code Generator Wizard Guide for Eclipse Plug-in<link href="../../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></head><h1>Code Generator Wizard Guide for Eclipse Plug-in</h1><p>This document explains the usage of this code generator plug-in
+for Eclipse. In other words, this document will guide you through
+the operations of generating a WSDL file from a Java class and/or
+generating a Java class file from a WSDL file.</p>
+<p><a class="externalLink" href="http://ws.apache.org/axis2/tools/index.html">[Download Plugin Tool]</a>
+</p>
+<h2>Content</h2><ul><li><a href="#intro">Introduction</a>
+</li>
+<li><a href="#installation">Installation</a>
+</li>
+<li><a href="#operation1">Operation - WSDL2Java</a>
+</li>
+<li><a href="#operation2">Operation - Java2WSDL</a>
+</li>
+</ul>
+<a name="intro"></a>
+<h2>Introduction</h2><p>The Axis2 code generator comes built-in with an <a class="externalLink" href="http://www.eclipse.org">Eclipse</a>
+ plug-in. This plug-in can be
+used to generate a WSDL file from a java class (Java2WSDL) and/or a
+java class file from a WSDL (WSDL2Java). First you need to install
+the plug-in. The instructions for the installation process are
+given below.</p>
+<a name="installation"></a>
+<h2>Installation</h2><p>One can easily <a class="externalLink" href="http://ws.apache.org/axis2/tools/index.html">download</a>
+ the
+plugin</p>
+<p>If one needs to build the plug-in from source, Maven2 and Ant
+builds arevailabe. Please refer the readme.txt located at
+module/tools on Axis2 source.</p>
+<p>Once you've obtained the plug-in just unzip the content of the
+plug-in archive to the Eclipse plug-in directory (if it is the
+zipped-binary version) or copy the necessary folders to the Eclipse
+plug-in directory and restart Eclipse.</p>
+<p><strong>NOTE</strong> : This plug-in works on Eclipse version
+3.1 and upwards, also the java version should be 1.4 or higher. The
+provided screen shots may slightly differ with what the user would
+actually see but the functionality has not been changed.</p>
+<a name="operation1"></a>
+<h2>Operation - WSDL2Java</h2><p>If the plug-in is properly installed you should see a new wizard
+under the "New" section.(use the File -> New -> Other or Ctrl
++ N )</p>
+<p><img src="images/wsdl2java-screen0.png" /></p>
+<p>Selecting the wizard and pressing the "Next" button will start
+the code generator wizard. Following is the first wizard page.</p>
+<p><strong>Page 1:</strong></p>
+<p><img src="images/wsdl2java-screen1.png" /></p>
+<p>Selecting the "Generate Java source code from WSDL file" option
+and clicking "Next" leads to the following page.</p>
+<p><strong>WSDL2Java Page 2 :</strong></p>
+<p><img src="images/wsdl2java-screen2.png" /></p>
+<p>To move on to the next page the WSDL file location must be
+given. The "Browse" button can be used to easily browse for a file
+rather than typing the whole path.</p>
+<p><strong>WSDL2Java Page 3 :</strong></p>
+<p>Once the WSDL file is selected, the next page will take you to
+the page from where <strong>codegen options</strong> are to be
+selected. By far this is the most important page in this wizard.
+This page determines the characteristics of the code being
+generated.</p>
+<p>Novices need not worry about these options since the most common
+options are defaulted, but advanced users will find it very easy to
+turn the knobs using these options.</p>
+<p><img src="images/wsdl2java-screen3.png" /></p>
+<p>What advanced users can do is select custom from the select
+codegen options drop down list and then change/edit the fields that
+you need.</p>
+<p><img src="images/wsdl2java-screen31.png" /></p>
+<p>Once the options are selected, only the final step of the code
+generation is left which is the selection of the output file
+location.</p>
+<p><strong>WSDL2Java Page 4 :</strong></p>
+<p>Here you can select the output file path by typing or browsing
+using the "Browse" button. You have the option of browsing only
+eclipse workspace projects by selecting the "Add the source to a
+project on current eclipse workspace" radio button. Or else you
+have the option to save the codegen resutls to file system</p>
+<p><img src="images/wsdl2java-screen4.png" /></p>
+<p>Here also you have the option to add some value to the codegen
+results. If you have enabled the check box "Add Axis2 libraries to
+the codegen result project" then all other controls below will get
+enabled. What you can do is point the downloaded Axis2_HOME
+location via the "Browse" button. Then you can verify the
+availability of the Axis2 libs by clicking on the "Check Libs"
+button. If all goes well then you can add the axis 2 libs to the
+codegen results location. Another option is available to generate a
+jar file if the user needs to add the codegen results to a project
+as a compiled jar file to the selected locations lib directory.</p>
+<p><img src="images/wsdl2java-screen41.png" /></p>
+<p>When the output file location is selected, the "Finish" button
+will be enabled. Clicking the "Finish" button will generate the
+code and a message box will pop up acknowledging the success. Well
+Done! You've successfully completed Axis2 code generation.</p>
+<a name="operation2"></a>
+<h2>Operation - Java2WSDL</h2><p><strong>Page 1:</strong></p>
+<p>For this operation you need to select the option which says
+"Generate a WSDL from a Java source file"</p>
+<p><img src="images/java2wsdl-screen0.png" /></p>
+<p>Then click the "Next" button which will lead to the next page
+below.</p>
+<p><strong>Java2WSDL Page 2:</strong></p>
+<p><img src="images/java2wsdl-screen1.png" /></p>
+<p>In this page one needs to select the class to be exposed and the
+relevant jar files /classes to be loaded as the classpath. After
+the libraries have been set, the "Test Class Loading" button must
+be clicked in order to test whether the class is loadable. Unless
+the class loading is successful proceeding to the "Next" button
+will not be enabled.</p>
+<p>Once the classloading is successful and "Next" button is clicked
+the page below will appear.</p>
+<p><strong>Java2WSDL Page 3:</strong></p>
+<p>This page allows the parameters to be modified by setting the
+options for the generator.</p>
+<p><img src="images/java2wsdl-screen2.png" /></p>
+<p><strong>Java2WSDL Page 4:</strong></p>
+<p>Here you can select the output file path by typing or browsing
+using the "Browse" button. You have the option of browsing only
+Eclipse workspace projects by selecting the "Add the source to a
+project on current eclipse workspace" radio button . Or else you
+have the option to save the codegen resutls to file system. Once
+the output file location and the output WSDL file name is added you
+can click the "Finish" button to complete generation.</p>
+<p><img src="images/java2wsdl-screen3.png" /></p>
+<p>If a message box pops up acknowledging the success, then you've
+successfully completed the Java2WSDL code generation.</p>
+<h1>Appendix</h1><ul><li>Eclipse reference - <a class="externalLink" href="http://www.eclipse.org/">http://www.eclipse.org/</a>
+</li>
+<li>Custom Ant Tasks - <a class="externalLink" href="http://ant.apache.org/manual/develop.html">http://ant.apache.org/manual/develop.html</a>
+</li>
+</ul>
+</html>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">©
+ 2004-2008
+
+ Apache Software Foundation
+
+
+
+
+
+
+
+
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org