You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by di...@apache.org on 2007/07/14 06:37:36 UTC
svn commit: r556222 [20/22] - in /webservices/axis2/trunk/java/xdocs: ./
@axis2_version_dir@/ @axis2_version_dir@/adb/ @axis2_version_dir@/jibx/
@axis2_version_dir@/src/ download/0_9/ download/0_91/ download/0_92/
download/0_93/ download/0_94/ download...
Copied: webservices/axis2/trunk/java/xdocs/siteHowTo.xml (from r556217, webservices/axis2/trunk/java/xdocs/siteHowTo.html)
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/siteHowTo.xml?view=diff&rev=556222&p1=webservices/axis2/trunk/java/xdocs/siteHowTo.html&r1=556217&p2=webservices/axis2/trunk/java/xdocs/siteHowTo.xml&r2=556222
==============================================================================
--- webservices/axis2/trunk/java/xdocs/siteHowTo.html (original)
+++ webservices/axis2/trunk/java/xdocs/siteHowTo.xml Fri Jul 13 21:37:26 2007
@@ -1,67 +1,66 @@
-<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one
- ~ or more contributor license agreements. See the NOTICE file
- ~ distributed with this work for additional information
- ~ regarding copyright ownership. The ASF licenses this file
- ~ to you under the Apache License, Version 2.0 (the
- ~ "License"); you may not use this file except in compliance
- ~ with the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing,
- ~ software distributed under the License is distributed on an
- ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~ KIND, either express or implied. See the License for the
- ~ specific language governing permissions and limitations
- ~ under the License.
- -->
-<html>
-<head>
- <meta http-equiv="content-type" content="">
- <title>How To Build Axis Project's Website</title>
- <link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all">
-</head>
-
-<body>
-<h1>How to Build the Axis2 Project's Website</h1>
-
-<h2>Installing Maven</h2>
-
-<p>The Axis 2.0 website build system solely depends on <a
-href="http://maven.apache.org/">Maven</a>. The build has been specifically
-tested to work with Maven version 1.0.1. To install Maven, download the
-distributions and follow the instructions in the documentation. Make sure you
-don't forget to put MAVEN_HOME/bin directory in the path.</p>
-
-<h2>Checking out Axis 2.0</h2>
-
-<p>Checkout the <a
-href="http://svn.apache.org/repos/asf/webservices/axis2/trunk/java">latest
-source</a> using your favorite SVN client. If you are a committer, get a <a
-href="https://svn.apache.org/repos/asf/webservices/axis2/trunk/java">commiter
-check out.</a></p>
-
-<h2>Building the Site</h2>
-
-<p>Type <i>maven multiproject</i> at the root of your project folder. It will
-take some time to build the whole site. The built site will be available
-under targets/docs.</p>
-
-<h2>FAQ</h2>
-<ol>
- <li>How can I update a document in the site ?<br>
- Get a commiter check out. All the documents are in HTML format under the
- xdocs folder, and you can change only the documents found under this
- folder. Change the relevant file and run maven "html2xdoc:transform". New
- documentation will be available under the target folder.</li>
- <li>How can I add a new document?<br>
- Put the new document in the xdocs folder. Change the navigation.xml found
- under the xdocs folder by adding a link to the newly added document.
- Re-generate the site.<br>
- Please make sure you have not included any of the illegal characters and
- your document should be well formed.</li>
-</ol>
-
-</body>
-</html>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~ with the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<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="" />
+<title>How To Build Axis Project's Website</title>
+<link href="css/axis-docs.css" rel="stylesheet" type="text/css"
+media="all" />
+</head>
+<body>
+<h1>How to Build the Axis2 Project's Website</h1>
+<h2>Installing Maven</h2>
+<p>The Axis 2.0 website build system solely depends on <a href=
+"http://maven.apache.org/">Maven</a>. The build has been
+specifically tested to work with Maven version 1.0.1. To install
+Maven, download the distributions and follow the instructions in
+the documentation. Make sure you don't forget to put MAVEN_HOME/bin
+directory in the path.</p>
+<h2>Checking out Axis 2.0</h2>
+<p>Checkout the <a href=
+"http://svn.apache.org/repos/asf/webservices/axis2/trunk/java">latest
+source</a> using your favorite SVN client. If you are a committer,
+get a <a href=
+"https://svn.apache.org/repos/asf/webservices/axis2/trunk/java">commiter
+check out.</a></p>
+<h2>Building the Site</h2>
+<p>Type <i>maven multiproject</i> at the root of your project
+folder. It will take some time to build the whole site. The built
+site will be available under targets/docs.</p>
+<h2>FAQ</h2>
+<ol>
+<li>How can I update a document in the site ?<br />
+Get a commiter check out. All the documents are in HTML format
+under the xdocs folder, and you can change only the documents found
+under this folder. Change the relevant file and run maven
+"html2xdoc:transform". New documentation will be available under
+the target folder.</li>
+<li>How can I add a new document?<br />
+Put the new document in the xdocs folder. Change the navigation.xml
+found under the xdocs folder by adding a link to the newly added
+document. Re-generate the site.<br />
+Please make sure you have not included any of the illegal
+characters and your document should be well formed.</li>
+</ol>
+</body>
+</html>
Copied: webservices/axis2/trunk/java/xdocs/svn.xml (from r556217, webservices/axis2/trunk/java/xdocs/svn.html)
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/svn.xml?view=diff&rev=556222&p1=webservices/axis2/trunk/java/xdocs/svn.html&r1=556217&p2=webservices/axis2/trunk/java/xdocs/svn.xml&r2=556222
==============================================================================
--- webservices/axis2/trunk/java/xdocs/svn.html (original)
+++ webservices/axis2/trunk/java/xdocs/svn.xml Fri Jul 13 21:37:26 2007
@@ -1,134 +1,134 @@
-<!--
- ~ Licensed to the Apache Software Foundation (ASF) under one
- ~ or more contributor license agreements. See the NOTICE file
- ~ distributed with this work for additional information
- ~ regarding copyright ownership. The ASF licenses this file
- ~ to you under the Apache License, Version 2.0 (the
- ~ "License"); you may not use this file except in compliance
- ~ with the License. You may obtain a copy of the License at
- ~
- ~ http://www.apache.org/licenses/LICENSE-2.0
- ~
- ~ Unless required by applicable law or agreed to in writing,
- ~ software distributed under the License is distributed on an
- ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- ~ KIND, either express or implied. See the License for the
- ~ specific language governing permissions and limitations
- ~ under the License.
- -->
-<html>
-<head>
- <meta http-equiv="content-type" content="">
- <title>Developing Apache Axis2</title>
- <link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all">
-</head>
-
-<body lang="en">
-<h1>Developing Apache Axis2</h1>
-
-<p>This document provides information on how to use SVN to get an SVN
-checkout/update, make commits to the repository, etc., in the process of
-contributing to Apache projects (specifically Axis2). Instructions on
-configuring IDEs for development and using Maven to build the project is also
-included here.</p>
-
-<h2>Content</h2>
-<ul>
- <li><a href="#svn">Working with Subversion (SVN)</a></li>
- <li><a href="#checkout">Checkout Axis2 from Subversion</a></li>
- <li><a href="#maven">Installing Maven 1</a></li>
- <li><a href="#ide">Configuring your IDE</a></li>
-</ul>
-<a name="svn"></a>
-
-<h2>Working with Subversion (SVN)</h2>
-
-<p>The Axis2 development team uses Subversion (SVN) for source control.
-Subversion is a compelling replacement for CVS, developed under the auspices
-of the Tigris community and licensed under an Apache compatible license. To
-learn more about Subversion or to download the latest distribution, visit the
-<a href="http:///subversion.tigris.org" target="_blank">Subversion project
-site</a>. If you are looking for guidance on setting up and installing
-Subversion, please read the ASF <a
-href="http://www.apache.org/dev/version-control.html" target="_blank">Source
-Code Repositories page</a>.</p>
-<a name="checkout"></a>
-
-<h2>Checkout Axis2 from Subversion</h2>
-
-<p>To check out the latest version of Axis2 from the Foundation's Subversion
-repository, you must use one of the following URLs depending on your level of
-access to the Axis2 source code:</p>
-<ul>
- <li><b>If you are not a committer:</b> <a
- href="http://svn.apache.org/repos/asf/webservices/axis2/trunk/java"
- target="_blank">http://svn.apache.org/repos/asf/webservices/axis2/trunk/java</a></li>
- <li><b>If you are a committer:</b> <a
- href="https://svn.apache.org/repos/asf/webservices/axis2/trunk/java"
- target="_blank">https://svn.apache.org/repos/asf/webservices/axis2/trunk/java</a></li>
-</ul>
-If you are a committer, make sure that you have selected an svnpasswd. To do
-this, you must log into svn.apache.org. For more information, please read the
-ASF <a href="http://www.apache.org/dev/version-control.html"
-target="_blank">Source Code Repositories page</a>.
-
-<p>Once you have successfully installed Subversion, you can check out Axis2
-trunk by following these steps:</p>
-<ol type="1">
- <li>Run <strong>svn co <repository URL> axis2</strong> where the
- repository URL is one of the URLs from the previous list.</li>
- <li>This step will check out the latest version of the Axis2 Java codebase
- to a directory named "axis2". The second parameter to the <strong>svn
- co</strong> selects a directory to create on your local machine. If you
- want to checkout Axis2 to a different directory, feel free to change
- axis2 to any other directory name.</li>
- <li>To update your working copy to the latest version from the repository,
- execute the <strong>svn update</strong> command.</li>
- <li>If you would like to submit a patch, you can execute <strong>svn
- diff</strong> to create a unified diff for submission to the Axis2 JIRA
- issue tracker.</li>
-</ol>
-<a name="maven"></a>
-
-<h2>Installing Maven 1</h2>
-
-<p>Axis2's build is based on Maven 1. Maven is a build system that allows
-for the reuse of common build projects across multiple projects. For
-information about obtaining, installing, and configuring Maven 1, please see
-the <a href="http://maven.apache.org" target="_blank">Maven project page</a>.
-To use Maven to build the Axis2 project, follow these simple steps:</p>
-<ol type="1">
- <li>Install <a href="http://maven.apache.org/maven-1.x/"
- target="_blank">Maven1</a>. Refer to the <a
- href="http://maven.apache.org/maven-1.x/start/install.html">instructions</a>.
- <ul>
- <li>Create a MAVEN_HOME environment variable.</li>
- <li>Add MAVEN_HOME/bin to your PATH</li>
- </ul>
- </li>
- <li>Go to the axis2 folder in the command prompt and type
- <strong>maven</strong>.</li>
- <li>Maven will then automatically download all the jars, compile, test and
- build the Axis2 deliverables.</li>
-</ol>
-<a name="ide"></a>
-
-<h2>Configuring your IDE</h2>
-
-<p>The Axis2 development team uses a variety of development tools from vi to
-emacs to eclipse to Intellij/IDEA. The following section is not an
-endorsement of a specific set of tools, it is simply meant as a pointer to
-ease the process of getting started with Axis2 development.</p>
-<ul>
- <li><strong>Intellij IDEA-</strong> type <strong>maven
- idea:multiproject</strong>. Generates the necessary IDEA .ipr, .iml and
- .iws project files</li>
- <li><strong>eclipse</strong>- type <strong>maven multiproject:goal
- -Dgoal=eclipse</strong> Then in Eclipse, setup a Classpath Variable for
- MAVEN_REPO, and select File > Import > Existing Projects into
- Workspace > Select root directory. Selecting the root of the Axis
- source discovers all the modules and allows them to be imported as
- individual projects at once.</li>
-</ul>
-</body>
-</html>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~ with the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+<!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>
+<meta name="generator" content=
+"HTML Tidy for Windows (vers 14 June 2007), see www.w3.org" />
+<meta http-equiv="content-type" content="" />
+<title>Developing Apache Axis2</title>
+<link href="css/axis-docs.css" rel="stylesheet" type="text/css"
+media="all" />
+</head>
+<body lang="en" xml:lang="en">
+<h1>Developing Apache Axis2</h1>
+<p>This document provides information on how to use SVN to get an
+SVN checkout/update, make commits to the repository, etc., in the
+process of contributing to Apache projects (specifically Axis2).
+Instructions on configuring IDEs for development and using Maven to
+build the project is also included here.</p>
+<h2>Content</h2>
+<ul>
+<li><a href="#svn">Working with Subversion (SVN)</a></li>
+<li><a href="#checkout">Checkout Axis2 from Subversion</a></li>
+<li><a href="#maven">Installing Maven 1</a></li>
+<li><a href="#ide">Configuring your IDE</a></li>
+</ul>
+<a name="svn" id="svn"></a>
+<h2>Working with Subversion (SVN)</h2>
+<p>The Axis2 development team uses Subversion (SVN) for source
+control. Subversion is a compelling replacement for CVS, developed
+under the auspices of the Tigris community and licensed under an
+Apache compatible license. To learn more about Subversion or to
+download the latest distribution, visit the <a href=
+"http:///subversion.tigris.org" target="_blank">Subversion project
+site</a>. If you are looking for guidance on setting up and
+installing Subversion, please read the ASF <a href=
+"http://www.apache.org/dev/version-control.html" target=
+"_blank">Source Code Repositories page</a>.</p>
+<a name="checkout" id="checkout"></a>
+<h2>Checkout Axis2 from Subversion</h2>
+<p>To check out the latest version of Axis2 from the Foundation's
+Subversion repository, you must use one of the following URLs
+depending on your level of access to the Axis2 source code:</p>
+<ul>
+<li><b>If you are not a committer:</b> <a href=
+"http://svn.apache.org/repos/asf/webservices/axis2/trunk/java"
+target=
+"_blank">http://svn.apache.org/repos/asf/webservices/axis2/trunk/java</a></li>
+<li><b>If you are a committer:</b> <a href=
+"https://svn.apache.org/repos/asf/webservices/axis2/trunk/java"
+target=
+"_blank">https://svn.apache.org/repos/asf/webservices/axis2/trunk/java</a></li>
+</ul>
+If you are a committer, make sure that you have selected an
+svnpasswd. To do this, you must log into svn.apache.org. For more
+information, please read the ASF <a href=
+"http://www.apache.org/dev/version-control.html" target=
+"_blank">Source Code Repositories page</a>.
+<p>Once you have successfully installed Subversion, you can check
+out Axis2 trunk by following these steps:</p>
+<ol type="1">
+<li>Run <strong>svn co <repository URL> axis2</strong> where
+the repository URL is one of the URLs from the previous list.</li>
+<li>This step will check out the latest version of the Axis2 Java
+codebase to a directory named "axis2". The second parameter to the
+<strong>svn co</strong> selects a directory to create on your local
+machine. If you want to checkout Axis2 to a different directory,
+feel free to change axis2 to any other directory name.</li>
+<li>To update your working copy to the latest version from the
+repository, execute the <strong>svn update</strong> command.</li>
+<li>If you would like to submit a patch, you can execute
+<strong>svn diff</strong> to create a unified diff for submission
+to the Axis2 JIRA issue tracker.</li>
+</ol>
+<a name="maven" id="maven"></a>
+<h2>Installing Maven 1</h2>
+<p>Axis2's build is based on Maven 1. Maven is a build system that
+allows for the reuse of common build projects across multiple
+projects. For information about obtaining, installing, and
+configuring Maven 1, please see the <a href=
+"http://maven.apache.org" target="_blank">Maven project page</a>.
+To use Maven to build the Axis2 project, follow these simple
+steps:</p>
+<ol type="1">
+<li>Install <a href="http://maven.apache.org/maven-1.x/" target=
+"_blank">Maven1</a>. Refer to the <a href=
+"http://maven.apache.org/maven-1.x/start/install.html">instructions</a>.
+<ul>
+<li>Create a MAVEN_HOME environment variable.</li>
+<li>Add MAVEN_HOME/bin to your PATH</li>
+</ul>
+</li>
+<li>Go to the axis2 folder in the command prompt and type
+<strong>maven</strong>.</li>
+<li>Maven will then automatically download all the jars, compile,
+test and build the Axis2 deliverables.</li>
+</ol>
+<a name="ide" id="ide"></a>
+<h2>Configuring your IDE</h2>
+<p>The Axis2 development team uses a variety of development tools
+from vi to emacs to eclipse to Intellij/IDEA. The following section
+is not an endorsement of a specific set of tools, it is simply
+meant as a pointer to ease the process of getting started with
+Axis2 development.</p>
+<ul>
+<li><strong>Intellij IDEA-</strong> type <strong>maven
+idea:multiproject</strong>. Generates the necessary IDEA .ipr, .iml
+and .iws project files</li>
+<li><strong>eclipse</strong>- type <strong>maven multiproject:goal
+-Dgoal=eclipse</strong> Then in Eclipse, setup a Classpath Variable
+for MAVEN_REPO, and select File > Import > Existing Projects
+into Workspace > Select root directory. Selecting the root of
+the Axis source discovers all the modules and allows them to be
+imported as individual projects at once.</li>
+</ul>
+</body>
+</html>
Copied: webservices/axis2/trunk/java/xdocs/tools/1_3/CodegenToolReference.xml (from r556217, webservices/axis2/trunk/java/xdocs/tools/1_3/CodegenToolReference.html)
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/tools/1_3/CodegenToolReference.xml?view=diff&rev=556222&p1=webservices/axis2/trunk/java/xdocs/tools/1_3/CodegenToolReference.html&r1=556217&p2=webservices/axis2/trunk/java/xdocs/tools/1_3/CodegenToolReference.xml&r2=556222
==============================================================================
--- webservices/axis2/trunk/java/xdocs/tools/1_3/CodegenToolReference.html (original)
+++ webservices/axis2/trunk/java/xdocs/tools/1_3/CodegenToolReference.xml Fri Jul 13 21:37:26 2007
@@ -16,353 +16,356 @@
~ specific language governing permissions and limitations
~ under the License.
-->
-<html>
+<!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>
- <meta http-equiv="content-type" content="">
- <title>Code Generator Tool Guide for Command Line and Ant Task</title>
- <link href="../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all" />
+<meta name="generator" content=
+"HTML Tidy for Windows (vers 14 June 2007), see www.w3.org" />
+<meta http-equiv="content-type" content="" />
+<title>Code Generator Tool Guide for Command Line and Ant
+Task</title>
+<link href="../../css/axis-docs.css" rel="stylesheet" type=
+"text/css" media="all" />
</head>
-
-<body lang="en">
+<body lang="en" xml:lang="en">
<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
- href="http://ws.apache.org/axis2/download.cgi">Axis2 Binary
- Distribution</a>.</p>
-
+<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 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>
+<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>
-<a name="intro"></a>
-
+</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" id="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>
-
+<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" id="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>
-
+<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" id="cmdref"></a>
<h3>Option Reference</h3>
-
<p>Usage WSDL2Code <option_reference></p>
-
<p><b>E.g. :- WSDL2Code -uri <Location of WSDL></b></p>
-
-<table border="1" cellpadding="0" cellspacing="0"
- style="border-collapse: collapse" width="100%" id="AutoNumber1">
+<table border="1" cellpadding="0" cellspacing="0" style=
+"border-collapse: collapse" width="100%" id="AutoNumber1">
<tbody>
<tr>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <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>
- <td width="20%">-ssi</td>
- <td width="20%">--serverside-interface</td>
- <td width="60%">Generate an interface for the service skeleton.</td>
- <td></td>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
+<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>
</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>
-
+<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" id="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>
-
+<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" id="antref"></a>
<h3>Ant Task Reference</h3>
-
-<table border="1" cellpadding="0" cellspacing="0"
- style="border-collapse: collapse" width="100%" id="AutoNumber2">
+<table border="1" cellpadding="0" cellspacing="0" style=
+"border-collapse: collapse" width="100%" id="AutoNumber2">
<tbody>
<tr>
- <td>wsdlfilename</td>
- <td>WSDL file location. Maps to the -uri option of the command line
- tool.</td>
+<td>wsdlfilename</td>
+<td>WSDL file location. Maps to the -uri option of the command line
+tool.</td>
</tr>
<tr>
- <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>
+<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>
- <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>
+<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>
- <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>
+<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>
- <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>
+<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>
- <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>
+<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>
- <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>
+<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>
- <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>
+<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>
- <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>
+<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>
- <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>
+<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>
- <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>
+<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>
- <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>
+<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>
- <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>
+<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>
- <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>
+<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>
- <td>namespaceToPackages</td>
- <td>A list of namespace to package mappings.</td>
+<td>namespaceToPackages</td>
+<td>A list of namespace to package mappings.</td>
</tr>
<tr>
- <td>serverSideInterface</td>
- <td>Flag stating whether to generate an interface for the server side
- skeleton.</td>
+<td>serverSideInterface</td>
+<td>Flag stating whether to generate an interface for the server
+side skeleton.</td>
</tr>
<tr>
- <td>repositoryPath</td>
- <td>Sets the repository path to be used. Maps to the -r option of
- the command line tool. </td>
+<td>repositoryPath</td>
+<td>Sets the repository path to be used. Maps to the -r option of
+the command line tool.</td>
</tr>
<tr>
- <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>
+<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>
- <td>externalMapping</td>
- <td>Location of the external mapping file to be used. Maps to the -em option of
- the command line tool.</td>
+<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>
- <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>
+<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>
- <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>
+<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>
- <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>
+<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>
-
+<a name="example" id="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"?>
+<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">
@@ -385,62 +388,60 @@
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>
-
+ 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>
+<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>
+<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>
-
+<a name="invoking" id="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>
+<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=".">
@@ -590,21 +591,20 @@
</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>
-
+</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"?>
+<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"
@@ -673,37 +673,34 @@
<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">/**
+ </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
@@ -730,11 +727,13 @@
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">/**
+ }
+</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
@@ -790,26 +789,26 @@
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;
+ }
+</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;
@@ -861,36 +860,27 @@
ex.printStackTrace();
}
}
- }</pre>
-
-<p>Now run the ant task 'runLogin' (>ant runLogin). The following output
- should appear:</p>
-<pre class="code">runLogin:
+ }
+</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>
-
+ [java] webLogin, completed!!!
+</pre>
+<a name="appendix" id="appendix"></a>
<h2>Appendix</h2>
<ul>
- <li>Eclipse reference - <a href="http://www.eclipse.org/">
- http://www.eclipse.org/</a></li>
- <li>Custom Ant Tasks - <a href="http://ant.apache.org/manual/develop.html">
- http://ant.apache.org/manual/develop.html</a></li>
+<li>Eclipse reference - <a href=
+"http://www.eclipse.org/">http://www.eclipse.org/</a></li>
+<li>Custom Ant Tasks - <a href=
+"http://ant.apache.org/manual/develop.html">http://ant.apache.org/manual/develop.html</a></li>
</ul>
-
-<p></p>
-
-<p></p>
-
-<p></p>
-
-<p></p>
-
-<p></p>
</body>
</html>
Copied: webservices/axis2/trunk/java/xdocs/tools/1_3/eclipse/servicearchiver-plugin.xml (from r556217, webservices/axis2/trunk/java/xdocs/tools/1_3/eclipse/servicearchiver-plugin.html)
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/tools/1_3/eclipse/servicearchiver-plugin.xml?view=diff&rev=556222&p1=webservices/axis2/trunk/java/xdocs/tools/1_3/eclipse/servicearchiver-plugin.html&r1=556217&p2=webservices/axis2/trunk/java/xdocs/tools/1_3/eclipse/servicearchiver-plugin.xml&r2=556222
==============================================================================
--- webservices/axis2/trunk/java/xdocs/tools/1_3/eclipse/servicearchiver-plugin.html (original)
+++ webservices/axis2/trunk/java/xdocs/tools/1_3/eclipse/servicearchiver-plugin.xml Fri Jul 13 21:37:26 2007
@@ -16,90 +16,85 @@
~ specific language governing permissions and limitations
~ under the License.
-->
-<html>
+<!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>
- <meta http-equiv="content-type" content="">
- <title>Service Archive Generator Wizard Guide for Eclipse Plug-in</title>
- <link href="../../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all" />
+<meta name="generator" content=
+"HTML Tidy for Windows (vers 14 June 2007), see www.w3.org" />
+<meta http-equiv="content-type" content="" />
+<title>Service Archive Generator Wizard Guide for Eclipse
+Plug-in</title>
+<link href="../../../css/axis-docs.css" rel="stylesheet" type=
+"text/css" media="all" />
</head>
-
-<body lang="en">
+<body lang="en" xml:lang="en">
<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 href="http://ws.apache.org/axis2/tools/index.html"
-target="_blank">[Download Plugin Tool]</a></p>
-
+<p>This document will guide you through the installation and usage
+of the archive generator Eclipse plug-in.</p>
+<p><a href="http://ws.apache.org/axis2/tools/index.html" target=
+"_blank">[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>
+<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>
-
+<a name="intro" id="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>
-
+<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" id="installation"></a>
<h2>Installation</h2>
-
-<p>One can easily <a 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>
-
+<p>One can easily <a 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" id="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 align="center"><img border="0" 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>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 align="center"><img border="0" 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 align="center"><img border="0" 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 align="center"><img border="0" 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 align="center"><img border="0" src="images/service_page2.jpg"></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 align="center"><img border="0" 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 align="center"><img border="0" src="images/service_page3.jpg"></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 align="center"><img border="0" src=
+"images/service_page3.jpg" /></p>
<!--
<p>Note that The service XML file can be generated if needed. To proceed
to the service generation page, check the "generate automatically" checkbox. </p>
@@ -120,84 +115,76 @@
<p>Once the method selection is complete the wizard has enough information to generate a basic services.xml file. If further customization is required, there's no choice but to manually edit it!</p>
-->
-
<p><strong>Page 4:</strong></p>
<!--START-->
-
-<p>The next step is to add the libraries. The library addition page looks
-like this : </p>
-
-<p align="center"><img border="0" 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 align="center"><img border="0" 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 align="center"><img border="0" src="images/service_page5_hl.jpg"></p>
-
-<p align="center"><img border="0" 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 align="center"><img border="0" src="images/service_page5_remove.jpg"></p>
-
+<p>The next step is to add the libraries. The library addition page
+looks like this :</p>
+<p align="center"><img border="0" 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 align="center"><img border="0" 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 align="center"><img border="0" src=
+"images/service_page5_hl.jpg" /></p>
+<p align="center"><img border="0" 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 align="center"><img border="0" 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 align="center"><img border="0" 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 align="center"><img border="0" 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 align="center"><img border="0" src="images/service_page4_search_declared.jpg"></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 align="center"><img border="0" 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 align="center"><img border="0" 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 align="center"><img border="0" 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></p>
-
-<p align="center"><img border="0" 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 align="center"><img border="0" 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>
-
+<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 align="center"><img border="0" 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 align="center"><img border="0" 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 href="http://www.eclipse.org/" target="_blank">
- http://www.eclipse.org/</a></li>
- <li>Custom Ant Tasks - <a href="http://ant.apache.org/manual/develop.html"
- target="_blank"> http://ant.apache.org/manual/develop.html</a></li>
+<li>Eclipse reference - <a href="http://www.eclipse.org/" target=
+"_blank">http://www.eclipse.org/</a></li>
+<li>Custom Ant Tasks - <a href=
+"http://ant.apache.org/manual/develop.html" target=
+"_blank">http://ant.apache.org/manual/develop.html</a></li>
</ul>
</body>
</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org