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 ch...@apache.org on 2006/05/03 08:41:22 UTC
svn commit: r399173 - in /webservices/axis2/trunk/java/xdocs/latest/tools:
CodegenToolReference.html eclipse/servicearchiver-plugin.html
eclipse/wsdl2java-plugin.html idea/Idea_plug-in_userguide.html
Author: chatra
Date: Tue May 2 23:41:22 2006
New Revision: 399173
URL: http://svn.apache.org/viewcvs?rev=399173&view=rev
Log:
updated tool docs for 1.0
Modified:
webservices/axis2/trunk/java/xdocs/latest/tools/CodegenToolReference.html
webservices/axis2/trunk/java/xdocs/latest/tools/eclipse/servicearchiver-plugin.html
webservices/axis2/trunk/java/xdocs/latest/tools/eclipse/wsdl2java-plugin.html
webservices/axis2/trunk/java/xdocs/latest/tools/idea/Idea_plug-in_userguide.html
Modified: webservices/axis2/trunk/java/xdocs/latest/tools/CodegenToolReference.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/latest/tools/CodegenToolReference.html?rev=399173&r1=399172&r2=399173&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/tools/CodegenToolReference.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/tools/CodegenToolReference.html Tue May 2 23:41:22 2006
@@ -12,6 +12,9 @@
references. Also in detail, this document shows how to build file using
custom Ant task and invoking the Code Generator from Ant.</p>
+<p><a href="http://ws.apache.org/axis2/tools/index.html"
+target="_blank">[Download Tool]</a></p>
+
<h2>Content</h2>
<ul>
<li><a href="#intro">Introduction</a></li>
@@ -78,7 +81,7 @@
<td width="20%">--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>
+ support other languages</td>
<td></td>
</tr>
<tr>
Modified: webservices/axis2/trunk/java/xdocs/latest/tools/eclipse/servicearchiver-plugin.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/latest/tools/eclipse/servicearchiver-plugin.html?rev=399173&r1=399172&r2=399173&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/tools/eclipse/servicearchiver-plugin.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/tools/eclipse/servicearchiver-plugin.html Tue May 2 23:41:22 2006
@@ -4,7 +4,7 @@
<title>Service Archive Generator Wizard - Eclipse Plug-in</title>
</head>
-<body>
+<body lang="en">
<h1>Service Archive Generator Wizard - eclipse Plug-in</h1>
<p>This document will guide you through the installation and usage of the
@@ -68,12 +68,12 @@
<p>Select the service.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 selecting the 'Generate service xml automatically'. '</p>
+when selecting the 'Generate service xml automatically' option.</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 generaion page, check the "generate automatically" checkbox. </p>
+to the service generation page, check the "generate automatically" checkbox. </p>
<p align="center"><img border="0" src="service_page3_hl.jpg"></p>
<p>If the automatic mode is not selected then the wizard
@@ -84,7 +84,7 @@
wish to give this service.
For the implementation class type in the fully qualified class name and hit the load button to view the operations</p>
<p align="center"><img border="0" src="service_page4_load.JPG" ></p>
-<p> The loaded operations should be displayed in a table. Once this is displayed you can filter the methods by selecting/deselcting the methods using the checkbox at each row.</p>
+<p> The loaded operations should be displayed in a table. Once this is displayed you can filter the methods by selecting/deselecting the methods using the checkbox at each row.</p>
<p align="center"><img border="0" src="service_page4_table.JPG" width="500" height="500"></p>
<p>Further filtering can be achieved by using the "search declared methods" only checkbox</p>
<p align="center"><img border="0" src="service_page4_search_declared.JPG" ></p>
@@ -94,50 +94,56 @@
<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>
+browsed for using the Browse button.</p>
<p align="center"><img border="0" src="images/service_page5_browsed.jpg"></p>
-<p>Hit the Add button to add the library to the list. The added libraries
-should be displayed in the list box</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 library needs to be removed, highlight it in the list and hit
-remove. Click next to proceed to the last page of the wizard</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 Remove button as shown
+below. Click next to proceed to the last page of the wizard.</p>
<p align="center"><img border="0" src="images/service_page5_remove.jpg"></p>
-<p>The last page of the wizard asks for the output location and the output
-archive name.</p>
+<p><strong>Page 5:</strong></p>
+
+<p>The last page of the wizard asks for the output file location and the
+output archive 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
+<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 to the axis2</p>
+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> 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/" 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>
-<hr>
</body>
</html>
Modified: webservices/axis2/trunk/java/xdocs/latest/tools/eclipse/wsdl2java-plugin.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/latest/tools/eclipse/wsdl2java-plugin.html?rev=399173&r1=399172&r2=399173&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/tools/eclipse/wsdl2java-plugin.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/tools/eclipse/wsdl2java-plugin.html Tue May 2 23:41:22 2006
@@ -4,14 +4,62 @@
<title>Code Generator Wizard - Eclipse Plug-in</title>
</head>
-<body>
+<body lang="en">
<h1>Code Generator Wizard - 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 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="#operation1">Operation - WSDL2Java</a></li>
+ <li><a href="#operation2">Operation - Java2WSDL</a></li>
+</ul>
+<ul>
+</ul>
+<a name="intro"></a>
+
<h2>Introduction</h2>
<p>The Axis2 code generator comes built-in with an <a
-href="http://www.eclipse.org">eclipse</a> plug-in. This document explains the
-usage of this code generator plug-in.</p>
+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
+instruction for installation are given below.</p>
+<a name="installation"></a>
+
+<h2>Installation</h2>
+
+<p>The easiest way to obtain the plug-in would be the binary distribution.
+The packages plug-in would be available from the tools section of the
+downloads page</p>
+
+<p>If one needs to build the plugin from source it is not as trivial as
+running the Maven build. The reason is that the plug-in depends heavily on
+the Eclipse classes, which are only available in an Eclipse environment. The
+recommended procedure is to run the create-project.xml (in the "modules\tool"
+directory of the source distribution) build file which will create two
+folders (the other one for the Service Archiver tool) and copy the necessary
+files to relevant folders. Then Eclipse should be configured to open the
+contents in a PDE project. Please go through the Eclipse documentation to
+learn how to open projects in the PDE format.</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. 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>
@@ -23,68 +71,99 @@
<p>Selecting the wizard and pressing the Next button will start the code
generator wizard. Following is the first wizard page.</p>
-<p><img border="0" src="images/wsdl2java-screen1.jpg"></p>
+<p><strong>Page 1:</strong></p>
+
+<p><img src="images/wsdl2java-screen1.jpg"></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 border="0" src="images/wsdl2java-screen2.jpg"></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
+Browse button can be used to easily browse for a file rather than typing the
whole path.</p>
-<p>Once the WSDL file is selected, codegen options are to be selected. By far
-this is the most important page in this wizard, which determines the
-characteristics of the code being generated. 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><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 border="0" src="images/wsdl2java-screen3.jpg"></p>
-<p>Once the options are taken care of, only the final step of the code
-generation is left. it is the selection of the output file location.</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 workspace projects by
+selecting the 'Browse Workspace projects only' 'checkbox.</p>
<p><img border="0" src="images/wsdl2java-screen4.jpg"></p>
<p>When the output file location is selected, the Finish button will be
-enabled. Pressing the finish button will generate the code and a message box
+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>
+completed Axis2 code generation.</p>
+<a name="operation2"></a>
<h2>Operation - Java2WSDL</h2>
-<p>Select the option which says generate a WSDL file from the Java file</p>
+<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 border="0" src="images/java2wsdl-screen0.jpg"></p>
-<p>Selecting that option leade to the next page</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 border="0" src="images/java2wsdl-screen1.jpg"></p>
-<p>In this page one need to select the class to be exposed and the relevant
-jar files /classes to be loaded as the classpath. After the libraries has
-been set the test classloading must be pushed in order to test whether the
-class is loadable. Unless the class loading is successful proceeding to the
-next screen is not possible!</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 the next screen allows the parameters
-to be modified</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 border="0" src="images/java2wsdl-screen2.jpg"></p>
-<p>After that the output location and the WSDL file name can be selected</p>
+<p><strong>Java2WSDL Page 4:</strong></p>
+
+<p>Output file location can be browsed using the Browse button. Note that by
+selecting 'browse Workspace projects only' check box you can browse for
+workspace projects only. Once output file location and output WSDL file name
+is add you can click the Finish button to complete generation.</p>
<p><img border="0" src="images/java2wsdl-screen3.jpg"></p>
-<p>You are now done with generating a WSDL file from a java class and its
-that simple!</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 href="http://www.eclipse.org/">
http://www.eclipse.org/</a></li>
- <li>Custom Ant Tasks - <a
+ <li>Custom Ant Tasks  - <a
href="http://ant.apache.org/manual/develop.html">
http://ant.apache.org/manual/develop.html</a></li>
</ul>
Modified: webservices/axis2/trunk/java/xdocs/latest/tools/idea/Idea_plug-in_userguide.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/latest/tools/idea/Idea_plug-in_userguide.html?rev=399173&r1=399172&r2=399173&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/tools/idea/Idea_plug-in_userguide.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/tools/idea/Idea_plug-in_userguide.html Tue May 2 23:41:22 2006
@@ -11,7 +11,7 @@
<body lang="en">
<h1>IntelliJ IDEA Plug-ins</h1>
-<p><a href="http://ws.apache.org/axis2/download.cgi">[Download]</a></p>
+<p><a href="http://ws.apache.org/axis2/tools/index.html">[Download]</a></p>
<h2>Introduction</h2>