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 [42/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...
Modified: webservices/axis2/site/tools/1_3/eclipse/wsdl2java-plugin.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/tools/1_3/eclipse/wsdl2java-plugin.html?rev=652665&r1=652664&r2=652665&view=diff
==============================================================================
--- webservices/axis2/site/tools/1_3/eclipse/wsdl2java-plugin.html (original)
+++ webservices/axis2/site/tools/1_3/eclipse/wsdl2java-plugin.html Thu May 1 14:20:27 2008
@@ -271,144 +271,144 @@
</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>
-<meta http-equiv="content-type" content=""></meta>
-Code Generator Wizard Guide for Eclipse Plug-in
-<link href="../../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></link>
-</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 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>
-The Axis2 code generator comes built-in with an <a 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.
-<a name="installation"></a>
-<h2>Installation</h2>
-One can easily <a href="http://ws.apache.org/axis2/tools/index.html">download</a> the
-plugin
-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.
-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><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 border="0" src="images/wsdl2java-screen0.png"></img></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"></img></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.png"></img></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 border="0" src="images/wsdl2java-screen3.png"></img></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 border="0" src="images/wsdl2java-screen31.png"></img></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 border="0" src="images/wsdl2java-screen4.png"></img></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 border="0" src="images/wsdl2java-screen41.png"></img></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 border="0" src="images/java2wsdl-screen0.png"></img></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.png"></img></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 border="0" src="images/java2wsdl-screen2.png"></img></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 border="0" src="images/java2wsdl-screen3.png"></img></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 href="http://ant.apache.org/manual/develop.html">http://ant.apache.org/manual/develop.html</a></li>
-</ul>
-
+ <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>
+<meta http-equiv="content-type" content=""></meta>
+Code Generator Wizard Guide for Eclipse Plug-in
+<link href="../../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></link>
+</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 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>
+The Axis2 code generator comes built-in with an <a 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.
+<a name="installation"></a>
+<h2>Installation</h2>
+One can easily <a href="http://ws.apache.org/axis2/tools/index.html">download</a> the
+plugin
+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.
+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><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 border="0" src="images/wsdl2java-screen0.png"></img></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"></img></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.png"></img></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 border="0" src="images/wsdl2java-screen3.png"></img></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 border="0" src="images/wsdl2java-screen31.png"></img></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 border="0" src="images/wsdl2java-screen4.png"></img></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 border="0" src="images/wsdl2java-screen41.png"></img></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 border="0" src="images/java2wsdl-screen0.png"></img></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.png"></img></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 border="0" src="images/java2wsdl-screen2.png"></img></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 border="0" src="images/java2wsdl-screen3.png"></img></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 href="http://ant.apache.org/manual/develop.html">http://ant.apache.org/manual/develop.html</a></li>
+</ul>
+
</html>
</div>
</div>
Modified: webservices/axis2/site/tools/1_3/idea/Idea_plug-in_userguide.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/tools/1_3/idea/Idea_plug-in_userguide.html?rev=652665&r1=652664&r2=652665&view=diff
==============================================================================
--- webservices/axis2/site/tools/1_3/idea/Idea_plug-in_userguide.html (original)
+++ webservices/axis2/site/tools/1_3/idea/Idea_plug-in_userguide.html Thu May 1 14:20:27 2008
@@ -271,328 +271,328 @@
</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>
-<meta http-equiv="content-type" content="text/html; charset=us-ascii"></meta>
-<meta content="text/html; charset=iso-8859-1"></meta>
-Axis2 Plug-in Guide for IntelliJ IDEA
-<meta name="generator" content="Bluefish 1.0.6"></meta>
-<link href="../../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></link>
-</head>
-
-<h1>Axis2 Plug-in Guide for IntelliJ IDEA</h1>
-<p>This document explains the installation and usage of Axis2
-plug-in for IntelliJ IDEA.</p>
-<p><a href="http://ws.apache.org/axis2/tools/index.html">[Download
-Plug-in]</a></p>
-<h2>Content</h2>
-<ul>
-<li><a href="#intro">Introduction</a></li>
-<li><a href="#installation">Installation</a></li>
-<li><a href="#WSDL2Java_Code_Generation">WSDL2Java Code
-Generation</a></li>
-<li><a href="#Create_Service_Archive">Create a Service Archive</a>
-<ul>
-<li><a href="#sub12">Sub Wizard 1 & Sub Wizard 2</a></li>
-<li><a href="#sub3">Sub Wizard 3</a></li>
-</ul>
-</li>
-</ul>
-<a name="intro"></a>
-<h2>Introduction</h2>
-The Axis2 plug-in for IntelliJ IDEA helps users to create
-service archives which can be deployed in Axis2, and generate java
-classes files from WSDL files. The following section describes the
-installation procedure followed by the usage of the plug-in.
-<b>Note:</b> This plug-in is made up with <a href="http://apidoc.org/docset/16">IDEA Open API</a> which will be
-compatible with idea version since build 4121. The plugin also be
-compatible with all the builds after build number 4121 and 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.
-<a name="installation"></a>
-<h2>Installation</h2>
-First <a href="http://ws.apache.org/axis2/tools/index.html">download</a> the
-plug-in which is a zipped file, and extract it into plugins
-directory which is located in the directory where IDEA is
-installed. If a previous version of the plug-in resides in this
-directory you will have to delete it prior to extracting the new
-zip file. If you have extracted the file correctly you would see a
-directory called axis2-idea-plugin.
-Next step is to restart IDEA so that the changes can take place.
-If the plug-in has been installed correctly, you will see following
-icons in IDEA when it is restarted.
-<img alt="Figure 1" src="images/idea-icons.jpg"></img>
-Also if you right-click on the IDEA editor you would see a link
-to the same plug-in.
-<p><img alt="Figure2" src="images/idea-popup.jpg"></img></p>
-<p>When you click on either one of them, a window (Page 1) will
-appear asking you to select one of the following two options.</p>
-<ol type="1">
-<li><a href="#Create_Service_Archive">Create a service
-archive</a></li>
-<li><a href="#WSDL2Java_Code_Generation">WSDL2Java code
-generation</a></li>
-</ol>
-<strong>Page 1:</strong>
-<img alt="Figure3" src="images/fig1.jpg"></img>
-<p>If you want to create a service archive obviously you must
-select "Create a service archive" option. Like wise, if u want to
-generate java class file from a WSDL file you must select the radio
-button option "WSDL2Java code generation".</p>
-<h2><a name="WSDL2Java_Code_Generation">WSDL2Java Code Generation</a></h2>
-<p>Select "WSDL2Java code generation" and click on the button "OK"
-to generate code from a WSDL file. Then the following window will
-appear.</p>
-<p><strong>WSDL2Java Page 2:</strong></p>
-<p><img alt="Figure4" src="images/fig2.jpg"></img></p>
-<p>Once the WSDL file is selected you will be able to move onto the
-next page. The "Browse" button can be used to easily browse for a
-file rather than having to type the whole path.</p>
-<p>Once the WSDL file is selected, click on the "Next" button which
-will take you to the page below.</p>
-<p><strong>WSDL2Java Page 3:</strong></p>
-<p>This page gives the user the option of selecting default or
-custom code generation options. There are three default code
-generation options in all. The first enables the user to generate
-both client and server code under default configurations while the
-second generates just the client side under default configurations.
-The third option generates server side code under default
-configurations.</p>
-<p><strong>Note:</strong></p>
-<ul>
-<li>When client side code is generated under default configurations
-it generates the stub, compiles it, packages it as a jar (the name
-of the jar will be <service name >-jar) places it in a lib
-folder (If there is no lib folder, it is created) under the IDEA
-project that is opened. This jar that's generated will also be
-added as a project library to the current active IDEA project.</li>
-<li>When server code is generated under default configurations it
-generates the server side code and also generates a default
-service.xml. The user will then be taken to page 5.</li>
-<li>When both server and client side is generated under default
-configurations the client stub is added are a jar to the current
-IDEA project and the user is taken to page 5.</li>
-</ul>
-<img alt="Figure5" src="images/fig19.jpg"></img>
-<strong>WSDL2Java Page 4:</strong>
-<strong>Codegen options</strong> are to be selected here. By far
-this is the most important page in this wizard, which determines
-the characteristics of the code being generated.
-<p><img alt="Figure5" src="images/fig18.jpg"></img></p>
-<p><strong>Here's some information on the options for
-selection:</strong></p>
-<ul>
-<li>Output language can be Java, C#. But we have not fully tested
-C# codegeneration, therefore, it is better to select Java as output
-language.</li>
-<li>If the WSDL comprises of several services, the user can select
-the service for which the code should be generated for.</li>
-<li>If the WSDL comprises of several ports for a particullar
-service, the user can select the port which the code should be
-generated for.</li>
-<li>The default data binding type is adb (Axis2 Data Binding).
-Although the tool is capable of providing XML beans, due to class
-loading issues in XML beans, current implementation only generate
-code with OM and ADB.</li>
-<li>As for the package name of the generated code, you can set the
-name as you wish.</li>
-<li>Users can select the one out of the three options- "Generate
-Client Side", "Generate Server Side" and "Generate All". The user
-will be able to select further options based on his options
-selected here. These sub options are explained below.</li>
-<li>
-<ul>
-<li>If user selects "Generate Client Side", he can further select
-the service invocation style. Since Axis2 supports both synchronous
-and asynchronous client programming model, the tool has provided a
-way to selecting the invocation style.</li>
-<li>If user selects "Generate Server Side", he can also generate a
-default service XML file. If the user selects "Generate an
-interface for skeleton" option then it only generates an interface
-for the server side. If so the user has to implement this
-interface. If this option is not selected, the skeleton class is
-generated, which the user can fill in later on.</li>
-<li>If user selects "Generate All" option, then all the classes
-will be generated in the referenced schemas by the WSDL
-irrespective of elements referred by the WSDL, along with the
-client side code.</li>
-</ul>
-</li>
-<li>The dafault behaviour of the code generator is to map
-namespaces to package names logically, but if the user wishes to
-change the package names of the generated classes, he can do so by
-changing the values in the Namespace to Packagename mapping
-table.</li>
-</ul>
-With these enhanced options novices need not worry about the
-options that can be set as the default options cover the most
-common cases. Advanced users will find it very easy to turn the
-knobs using the custom generation option.
-<strong>WSDL2Java Page 5:</strong>
-<img alt="Figure6" src="images/fig3.jpg"></img>
-Here uses have the option of adding the generated code directly
-to their working IDEA project or choose a custom location. If the
-user decides to add it to the current IDEA project he/she will have
-to choose the module and the source directory that the code should
-be generated to.
-Alternatively the user can browse and select the output
-location/path (the location at which the code is to be generated)
-using the "Browse" button. Because of the "Browse" button you do
-not need to type in the output file path.
-<img alt="Fig4" src="images/fig4.jpg"></img>
-Once an output location is selected you can click on "Finish"
-button which will generate the java class file. If code generation
-is successful then a message box will appear acknowledging this
-fact a shown above.
-<a name="Create_Service_Archive"></a>
-<h2>Create a Service Archive</h2>
-Select the "Create a service archive" radio button on Page 1 of
-Axis2 IDEA plug-in wizard.
-<strong>Page 1:</strong>
-<img alt="Fig5" src="images/fig1.jpg"></img>
-<p><strong>Service Archive Page 2:</strong></p>
-<p>The page below will appear asking the user to select the archive
-type</p>
-<p><img alt="fig6" src="images/fig6.jpg"></img></p>
-<p>In Axis2, the user can deploy a single service or a service
-group. Therefore, you can select either "Single service archive" or
-"Service group archive" for the archive type you want to
-create.</p>
-<p>If you already have a services.xml you can skip some of the
-steps in the wizard by selecting the radio button option "I already
-have services.xml" and clicking on "Next" button. If you do not
-have the services.xml, select the radio button option "Generate
-services.xml" and click on the "Next" button, in which case the
-tool will create the services.xml for you.</p>
-<p>Depending on the options you selected on this page there can be
-three sub wizards:</p>
-<ol type="1">
-<li><a href="#sub12">Sub wizard 1</a> (Generate single service and
-its services.xml)</li>
-<li><a href="#sub12">Sub wizard 2</a> (Generate service group and
-its services.xml)</li>
-<li><a href="#sub3">Sub wizard 3</a> (Generate service/service
-group using already existing services.xml)</li>
-</ol>
-1 & 2 follow the same set of steps except for some looping
-mechanism in the middle of the wizard.
-<a name="sub12"></a>
-<h3>Sub Wizard 1 and Sub Wizard 2</h3>
-<strong>Service Archive (sub wizards 1 & 2) Page
-3:</strong>
-From this page you have to select the location of the service
-classes directory (the location of the compiled classes). You do
-not need to type path, simply browse and select.
-<p><img alt="fig7" src="images/fig7.jpg"></img></p>
-<p>When you click on "Next" button, wizard will move to the page
-below</p>
-<p><strong>Service Archive (sub wizards 1 & 2) Page
-4:</strong></p>
-<p>Here you select service specific external libraries (third party
-libraries) and service WSDL files. If you want to add multiple WSDL
-files to a single service type you can do that as well.</p>
-<p><img alt="fig8" src="images/fig8.jpg"></img></p>
-<p>To add libraries first click on the browse button to browse for
-library files and then click on the "Add" button. Once added the
-selected file will appear in the list box.</p>
-<p>To add WSDLs, first click on the browse button to browse for
-WSDL file and then click the "Add" button to add the file to the
-list.</p>
-<p>After adding external libraries and service WSDL files click on
-the "Next" button to move to next page.</p>
-<p><strong>Service Archive (sub wizards 1 & 2) Page
-5:</strong></p>
-<p>This page allows you to select service implementation class. In
-the case of service group, same page will be looped to select
-multiple service implementation classes. This process is explained
-in detail below.</p>
-<p>Select a service implementation class by browsing and clicking
-on the "Load" button to load all the public methods in that class,
-after which you can select the methods that you want to publish
-using the check boxes.</p>
-<p><strong>Note :</strong> If you do not select the correct class
-path from the "Class location selection" window, the public methods
-which are available in the selected class file will not be
-loaded.</p>
-<p><img alt="fig10" src="images/fig10.jpg"></img></p>
-<p>In "Service Name" text box you can type the name of the service
-you want, but remember that the service name should be unique
-throughout the system.</p>
-<p>When you have completed this particular service click on the
-button "Next". In the case of a service group when you click on the
-"Next" button for that particular service the following dialog box
-will appear with option to add more service(s) to a service
-group.</p>
-<p><img alt="fig11" src="images/fig11.jpg"></img></p>
-<p>If you click on "Yes", you have to follow the same procedure to
-add some other service(s) to service group.</p>
-<p>If you click on "No", the button "Next" will be enabled and you
-can go to next page.</p>
-<p><a name="Note"><strong><em>Note: From this point
-onwards the steps are similar to all the sub
-wizards.</em></strong></a></p>
-<p><strong>Service Archive (sub wizards 1 & 2) Page
-6:</strong></p>
-<p>This page displays the services.xml file, either the one given
-by you (in the case of I already have services.xml)
-or the one generated by the system (in the case of "generate
-services.xml")</p>
-<p><img alt="fig12" src="images/fig12.jpg"></img></p>
-<p>This page is editable and provide a way to add parameters and
-module references to any level.</p>
-<p><strong>Note :</strong> When you click on either the
-"+Parameter" or the "+ModuleRef" buttons remember that
-corresponding text will be added to the current mouse position.
-Therefore, click on the location you want to add the parameter or
-module references and then click relevant button (+Parameter or
-+ModuleRef).</p>
-<p><strong>+Parameter button:</strong></p>
-<p>If you click on the "+Parameter" button a window will appear
-asking to give parameter name and parameter value.</p>
-<p><img alt="fig13" src="images/fig13.jpg"></img></p>
-<p>Note that you can also manually add parameters (without clicking
-on the "+Parameter" button ) to any where in the document as you
-wish.</p>
-<p><strong>+ModuleRef button:</strong></p>
-<p>Likewise, adding module references can be done by clicking on
-the "+ModuleRef" button in the page. You have to type the name of
-the module to be engaged as shown in the following figure.</p>
-<p><img alt="fig14" src="images/fig14.jpg"></img></p>
-<p>When you complete this page press the "Next" button to go to
-final page.</p>
-<p><strong>Service Archive (sub wizards 1 & 2) Page
-7:</strong></p>
-<p><img alt="fig15" src="images/fig15.jpg"></img></p>
-<p>Next step is to select output file location, the location in
-which archive file should be created.</p>
-<p>In the "Archive Name" text box, type the name of the archive
-file you want to place. This name will finally become the service
-group name.</p>
-<p><strong>Note :</strong> Do not include file extension when you
-type archive name. System will generate that for you.</p>
-<p>When you are done, click the "Finish" button. If everything has
-been done successfully you will see following message.</p>
-<p><img alt="fig16" src="images/fig16.jpg"></img></p>
-<p><strong><em>Note: Pages 6 & 7 of sub wizards 1 & 2 are
-common to sub wizard 3 from its page 3 onwards.</em></strong></p>
-<a name="sub3"></a>
-<h3>Sub Wizard 3</h3>
-<p>In the case where services.xml is already available, the steps
-are as follows:</p>
-<p><strong>Service Archive (sub wizard 3) Page 3:</strong></p>
-<p><img alt="fig17" src="images/fig17.jpg"></img></p>
-<p>This page allows you to select both location of services.xml and
-the location of service classes directory. Click on the "Select"
-buttons and browse the file system to find required document and
-location.</p>
-<p>Click on the "Next" button which will take you to a page which
-allows you to add third party libraries and WSDL's in the same
-manner as "Sub Wizard 1 & Sub Wizard 2" section's <a href="#Note">Page 6 - Edit service descriptors</a>. Note that Sub Wizard
-3 from this point takes the same pages as 6 to 7 of Sub Wizards 1
-& 2.</p>
-
+ <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>
+<meta http-equiv="content-type" content="text/html; charset=us-ascii"></meta>
+<meta content="text/html; charset=iso-8859-1"></meta>
+Axis2 Plug-in Guide for IntelliJ IDEA
+<meta name="generator" content="Bluefish 1.0.6"></meta>
+<link href="../../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></link>
+</head>
+
+<h1>Axis2 Plug-in Guide for IntelliJ IDEA</h1>
+<p>This document explains the installation and usage of Axis2
+plug-in for IntelliJ IDEA.</p>
+<p><a href="http://ws.apache.org/axis2/tools/index.html">[Download
+Plug-in]</a></p>
+<h2>Content</h2>
+<ul>
+<li><a href="#intro">Introduction</a></li>
+<li><a href="#installation">Installation</a></li>
+<li><a href="#WSDL2Java_Code_Generation">WSDL2Java Code
+Generation</a></li>
+<li><a href="#Create_Service_Archive">Create a Service Archive</a>
+<ul>
+<li><a href="#sub12">Sub Wizard 1 & Sub Wizard 2</a></li>
+<li><a href="#sub3">Sub Wizard 3</a></li>
+</ul>
+</li>
+</ul>
+<a name="intro"></a>
+<h2>Introduction</h2>
+The Axis2 plug-in for IntelliJ IDEA helps users to create
+service archives which can be deployed in Axis2, and generate java
+classes files from WSDL files. The following section describes the
+installation procedure followed by the usage of the plug-in.
+<b>Note:</b> This plug-in is made up with <a href="http://apidoc.org/docset/16">IDEA Open API</a> which will be
+compatible with idea version since build 4121. The plugin also be
+compatible with all the builds after build number 4121 and 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.
+<a name="installation"></a>
+<h2>Installation</h2>
+First <a href="http://ws.apache.org/axis2/tools/index.html">download</a> the
+plug-in which is a zipped file, and extract it into plugins
+directory which is located in the directory where IDEA is
+installed. If a previous version of the plug-in resides in this
+directory you will have to delete it prior to extracting the new
+zip file. If you have extracted the file correctly you would see a
+directory called axis2-idea-plugin.
+Next step is to restart IDEA so that the changes can take place.
+If the plug-in has been installed correctly, you will see following
+icons in IDEA when it is restarted.
+<img alt="Figure 1" src="images/idea-icons.jpg"></img>
+Also if you right-click on the IDEA editor you would see a link
+to the same plug-in.
+<p><img alt="Figure2" src="images/idea-popup.jpg"></img></p>
+<p>When you click on either one of them, a window (Page 1) will
+appear asking you to select one of the following two options.</p>
+<ol type="1">
+<li><a href="#Create_Service_Archive">Create a service
+archive</a></li>
+<li><a href="#WSDL2Java_Code_Generation">WSDL2Java code
+generation</a></li>
+</ol>
+<strong>Page 1:</strong>
+<img alt="Figure3" src="images/fig1.jpg"></img>
+<p>If you want to create a service archive obviously you must
+select "Create a service archive" option. Like wise, if u want to
+generate java class file from a WSDL file you must select the radio
+button option "WSDL2Java code generation".</p>
+<h2><a name="WSDL2Java_Code_Generation">WSDL2Java Code Generation</a></h2>
+<p>Select "WSDL2Java code generation" and click on the button "OK"
+to generate code from a WSDL file. Then the following window will
+appear.</p>
+<p><strong>WSDL2Java Page 2:</strong></p>
+<p><img alt="Figure4" src="images/fig2.jpg"></img></p>
+<p>Once the WSDL file is selected you will be able to move onto the
+next page. The "Browse" button can be used to easily browse for a
+file rather than having to type the whole path.</p>
+<p>Once the WSDL file is selected, click on the "Next" button which
+will take you to the page below.</p>
+<p><strong>WSDL2Java Page 3:</strong></p>
+<p>This page gives the user the option of selecting default or
+custom code generation options. There are three default code
+generation options in all. The first enables the user to generate
+both client and server code under default configurations while the
+second generates just the client side under default configurations.
+The third option generates server side code under default
+configurations.</p>
+<p><strong>Note:</strong></p>
+<ul>
+<li>When client side code is generated under default configurations
+it generates the stub, compiles it, packages it as a jar (the name
+of the jar will be <service name >-jar) places it in a lib
+folder (If there is no lib folder, it is created) under the IDEA
+project that is opened. This jar that's generated will also be
+added as a project library to the current active IDEA project.</li>
+<li>When server code is generated under default configurations it
+generates the server side code and also generates a default
+service.xml. The user will then be taken to page 5.</li>
+<li>When both server and client side is generated under default
+configurations the client stub is added are a jar to the current
+IDEA project and the user is taken to page 5.</li>
+</ul>
+<img alt="Figure5" src="images/fig19.jpg"></img>
+<strong>WSDL2Java Page 4:</strong>
+<strong>Codegen options</strong> are to be selected here. By far
+this is the most important page in this wizard, which determines
+the characteristics of the code being generated.
+<p><img alt="Figure5" src="images/fig18.jpg"></img></p>
+<p><strong>Here's some information on the options for
+selection:</strong></p>
+<ul>
+<li>Output language can be Java, C#. But we have not fully tested
+C# codegeneration, therefore, it is better to select Java as output
+language.</li>
+<li>If the WSDL comprises of several services, the user can select
+the service for which the code should be generated for.</li>
+<li>If the WSDL comprises of several ports for a particullar
+service, the user can select the port which the code should be
+generated for.</li>
+<li>The default data binding type is adb (Axis2 Data Binding).
+Although the tool is capable of providing XML beans, due to class
+loading issues in XML beans, current implementation only generate
+code with OM and ADB.</li>
+<li>As for the package name of the generated code, you can set the
+name as you wish.</li>
+<li>Users can select the one out of the three options- "Generate
+Client Side", "Generate Server Side" and "Generate All". The user
+will be able to select further options based on his options
+selected here. These sub options are explained below.</li>
+<li>
+<ul>
+<li>If user selects "Generate Client Side", he can further select
+the service invocation style. Since Axis2 supports both synchronous
+and asynchronous client programming model, the tool has provided a
+way to selecting the invocation style.</li>
+<li>If user selects "Generate Server Side", he can also generate a
+default service XML file. If the user selects "Generate an
+interface for skeleton" option then it only generates an interface
+for the server side. If so the user has to implement this
+interface. If this option is not selected, the skeleton class is
+generated, which the user can fill in later on.</li>
+<li>If user selects "Generate All" option, then all the classes
+will be generated in the referenced schemas by the WSDL
+irrespective of elements referred by the WSDL, along with the
+client side code.</li>
+</ul>
+</li>
+<li>The dafault behaviour of the code generator is to map
+namespaces to package names logically, but if the user wishes to
+change the package names of the generated classes, he can do so by
+changing the values in the Namespace to Packagename mapping
+table.</li>
+</ul>
+With these enhanced options novices need not worry about the
+options that can be set as the default options cover the most
+common cases. Advanced users will find it very easy to turn the
+knobs using the custom generation option.
+<strong>WSDL2Java Page 5:</strong>
+<img alt="Figure6" src="images/fig3.jpg"></img>
+Here uses have the option of adding the generated code directly
+to their working IDEA project or choose a custom location. If the
+user decides to add it to the current IDEA project he/she will have
+to choose the module and the source directory that the code should
+be generated to.
+Alternatively the user can browse and select the output
+location/path (the location at which the code is to be generated)
+using the "Browse" button. Because of the "Browse" button you do
+not need to type in the output file path.
+<img alt="Fig4" src="images/fig4.jpg"></img>
+Once an output location is selected you can click on "Finish"
+button which will generate the java class file. If code generation
+is successful then a message box will appear acknowledging this
+fact a shown above.
+<a name="Create_Service_Archive"></a>
+<h2>Create a Service Archive</h2>
+Select the "Create a service archive" radio button on Page 1 of
+Axis2 IDEA plug-in wizard.
+<strong>Page 1:</strong>
+<img alt="Fig5" src="images/fig1.jpg"></img>
+<p><strong>Service Archive Page 2:</strong></p>
+<p>The page below will appear asking the user to select the archive
+type</p>
+<p><img alt="fig6" src="images/fig6.jpg"></img></p>
+<p>In Axis2, the user can deploy a single service or a service
+group. Therefore, you can select either "Single service archive" or
+"Service group archive" for the archive type you want to
+create.</p>
+<p>If you already have a services.xml you can skip some of the
+steps in the wizard by selecting the radio button option "I already
+have services.xml" and clicking on "Next" button. If you do not
+have the services.xml, select the radio button option "Generate
+services.xml" and click on the "Next" button, in which case the
+tool will create the services.xml for you.</p>
+<p>Depending on the options you selected on this page there can be
+three sub wizards:</p>
+<ol type="1">
+<li><a href="#sub12">Sub wizard 1</a> (Generate single service and
+its services.xml)</li>
+<li><a href="#sub12">Sub wizard 2</a> (Generate service group and
+its services.xml)</li>
+<li><a href="#sub3">Sub wizard 3</a> (Generate service/service
+group using already existing services.xml)</li>
+</ol>
+1 & 2 follow the same set of steps except for some looping
+mechanism in the middle of the wizard.
+<a name="sub12"></a>
+<h3>Sub Wizard 1 and Sub Wizard 2</h3>
+<strong>Service Archive (sub wizards 1 & 2) Page
+3:</strong>
+From this page you have to select the location of the service
+classes directory (the location of the compiled classes). You do
+not need to type path, simply browse and select.
+<p><img alt="fig7" src="images/fig7.jpg"></img></p>
+<p>When you click on "Next" button, wizard will move to the page
+below</p>
+<p><strong>Service Archive (sub wizards 1 & 2) Page
+4:</strong></p>
+<p>Here you select service specific external libraries (third party
+libraries) and service WSDL files. If you want to add multiple WSDL
+files to a single service type you can do that as well.</p>
+<p><img alt="fig8" src="images/fig8.jpg"></img></p>
+<p>To add libraries first click on the browse button to browse for
+library files and then click on the "Add" button. Once added the
+selected file will appear in the list box.</p>
+<p>To add WSDLs, first click on the browse button to browse for
+WSDL file and then click the "Add" button to add the file to the
+list.</p>
+<p>After adding external libraries and service WSDL files click on
+the "Next" button to move to next page.</p>
+<p><strong>Service Archive (sub wizards 1 & 2) Page
+5:</strong></p>
+<p>This page allows you to select service implementation class. In
+the case of service group, same page will be looped to select
+multiple service implementation classes. This process is explained
+in detail below.</p>
+<p>Select a service implementation class by browsing and clicking
+on the "Load" button to load all the public methods in that class,
+after which you can select the methods that you want to publish
+using the check boxes.</p>
+<p><strong>Note :</strong> If you do not select the correct class
+path from the "Class location selection" window, the public methods
+which are available in the selected class file will not be
+loaded.</p>
+<p><img alt="fig10" src="images/fig10.jpg"></img></p>
+<p>In "Service Name" text box you can type the name of the service
+you want, but remember that the service name should be unique
+throughout the system.</p>
+<p>When you have completed this particular service click on the
+button "Next". In the case of a service group when you click on the
+"Next" button for that particular service the following dialog box
+will appear with option to add more service(s) to a service
+group.</p>
+<p><img alt="fig11" src="images/fig11.jpg"></img></p>
+<p>If you click on "Yes", you have to follow the same procedure to
+add some other service(s) to service group.</p>
+<p>If you click on "No", the button "Next" will be enabled and you
+can go to next page.</p>
+<p><a name="Note"><strong><em>Note: From this point
+onwards the steps are similar to all the sub
+wizards.</em></strong></a></p>
+<p><strong>Service Archive (sub wizards 1 & 2) Page
+6:</strong></p>
+<p>This page displays the services.xml file, either the one given
+by you (in the case of I already have services.xml)
+or the one generated by the system (in the case of "generate
+services.xml")</p>
+<p><img alt="fig12" src="images/fig12.jpg"></img></p>
+<p>This page is editable and provide a way to add parameters and
+module references to any level.</p>
+<p><strong>Note :</strong> When you click on either the
+"+Parameter" or the "+ModuleRef" buttons remember that
+corresponding text will be added to the current mouse position.
+Therefore, click on the location you want to add the parameter or
+module references and then click relevant button (+Parameter or
++ModuleRef).</p>
+<p><strong>+Parameter button:</strong></p>
+<p>If you click on the "+Parameter" button a window will appear
+asking to give parameter name and parameter value.</p>
+<p><img alt="fig13" src="images/fig13.jpg"></img></p>
+<p>Note that you can also manually add parameters (without clicking
+on the "+Parameter" button ) to any where in the document as you
+wish.</p>
+<p><strong>+ModuleRef button:</strong></p>
+<p>Likewise, adding module references can be done by clicking on
+the "+ModuleRef" button in the page. You have to type the name of
+the module to be engaged as shown in the following figure.</p>
+<p><img alt="fig14" src="images/fig14.jpg"></img></p>
+<p>When you complete this page press the "Next" button to go to
+final page.</p>
+<p><strong>Service Archive (sub wizards 1 & 2) Page
+7:</strong></p>
+<p><img alt="fig15" src="images/fig15.jpg"></img></p>
+<p>Next step is to select output file location, the location in
+which archive file should be created.</p>
+<p>In the "Archive Name" text box, type the name of the archive
+file you want to place. This name will finally become the service
+group name.</p>
+<p><strong>Note :</strong> Do not include file extension when you
+type archive name. System will generate that for you.</p>
+<p>When you are done, click the "Finish" button. If everything has
+been done successfully you will see following message.</p>
+<p><img alt="fig16" src="images/fig16.jpg"></img></p>
+<p><strong><em>Note: Pages 6 & 7 of sub wizards 1 & 2 are
+common to sub wizard 3 from its page 3 onwards.</em></strong></p>
+<a name="sub3"></a>
+<h3>Sub Wizard 3</h3>
+<p>In the case where services.xml is already available, the steps
+are as follows:</p>
+<p><strong>Service Archive (sub wizard 3) Page 3:</strong></p>
+<p><img alt="fig17" src="images/fig17.jpg"></img></p>
+<p>This page allows you to select both location of services.xml and
+the location of service classes directory. Click on the "Select"
+buttons and browse the file system to find required document and
+location.</p>
+<p>Click on the "Next" button which will take you to a page which
+allows you to add third party libraries and WSDL's in the same
+manner as "Sub Wizard 1 & Sub Wizard 2" section's <a href="#Note">Page 6 - Edit service descriptors</a>. Note that Sub Wizard
+3 from this point takes the same pages as 6 to 7 of Sub Wizards 1
+& 2.</p>
+
</html>
</div>
</div>
Modified: webservices/axis2/site/tools/1_3/maven-plugins/maven-aar-plugin.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/tools/1_3/maven-plugins/maven-aar-plugin.html?rev=652665&r1=652664&r2=652665&view=diff
==============================================================================
--- webservices/axis2/site/tools/1_3/maven-plugins/maven-aar-plugin.html (original)
+++ webservices/axis2/site/tools/1_3/maven-plugins/maven-aar-plugin.html Thu May 1 14:20:27 2008
@@ -271,185 +271,185 @@
</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>
-<meta http-equiv="content-type" content=""></meta>
-Maven2 AAR Plug-in Guide
-<link href="../../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></link>
-</head>
-
-<h1>Maven2 AAR Plug-in Guide</h1>
-<h2>Introduction</h2>
-<p>This plugin generates an Axis 2 service file (AAR file).</p>
-<p><a href="http://ws.apache.org/axis2/tools/index.html">[Download Plugin Tool]</a></p>
-<h2>Goals</h2>
-<p>The AAR plugin allows the packaging of an Axis 2 service aar in
-3 different modes:</p>
-<ol type="1">
-<li><b>aar (default)</b>: generates the aar artifact</li>
-<li><b>inplace</b> : package the aar in the source tree</li>
-<li><b>exploded</b> : package an exploded aar application</li>
-</ol>
-Each mode is materialized by a goal. For instance, to generate
-an exploded aar from the current project, one would type
-<pre>
-mvn aar:exploded
-</pre>
-<h2>Configuration</h2>
-All AAR plugin goals takes the following configuration
-parameters as input:
-<table class="bodyTable">
-<tbody>
-<tr class="a">
-<td><strong>Parameter Name</strong></td>
-<td><strong>Default Value</strong></td>
-<td><strong>Description</strong></td>
-</tr>
-<tr class="b">
-<td>aarDirectory</td>
-<td>${project.build.directory}/aar</td>
-<td>Directory where the aar file is built</td>
-</tr>
-<tr class="a">
-<td>classesDirectory</td>
-<td>${project.build.outputDirectory}</td>
-<td>Directory with compiled classes and resources</td>
-</tr>
-<tr class="b">
-<td>fileSets</td>
-<td></td>
-<td>Additional file sets, which are being added to the archive. See
-"<a href="#file_sets">File Sets</a>" below for an example</td>
-</tr>
-<tr class="a">
-<td>servicesXmlFile</td>
-<td></td>
-<td>Location of the services.xml file. By default, it is assumed
-that the file is already present in classesDirectory/META-INF and
-no special processing is required</td>
-</tr>
-<tr class="b">
-<td>wsdlFile</td>
-<td></td>
-<td>Location of the WSDL file. By default, it is assumed that the
-file is already present in classesDirectory/META-INF and no special
-processing is required</td>
-</tr>
-<tr class="a">
-<td>wsdlFileName</td>
-<td>service.wsdl</td>
-<td>Name, to which the WSDL file should be mapped</td>
-</tr>
-</tbody>
-</table>
-<h3>The aar Goal</h3>
-The aar goal allows the following additional parameters:
-<table class="bodyTable">
-<tbody>
-<tr class="b">
-<td><strong>Parameter Name</strong></td>
-<td><strong>Default Value</strong></td>
-<td><strong>Description</strong></td>
-</tr>
-<tr class="a">
-<td>outputDirectory</td>
-<td>${project.build.directory}</td>
-<td>Directory where to generate the AAR file</td>
-</tr>
-<tr class="b">
-<td>aarName</td>
-<td>${project.build.finalName}</td>
-<td>The generated AAR files name</td>
-</tr>
-<tr class="a">
-<td>archive</td>
-<td></td>
-<td>A Maven archive configuration. This allows, for example, to
-configure the MANIFEST.MF file</td>
-</tr>
-<tr class="b">
-<td>classifier</td>
-<td></td>
-<td>A classifier, which should be added to the generated AAR files
-name. Setting this parameter has the side effect, that the artifact
-is treated as an attachment and not as the projects primary
-artifact</td>
-</tr>
-<tr class="a">
-<td>primaryArtifact</td>
-<td>true</td>
-<td>Setting this property to false disables installation or
-deployment of the artifact as the projects primary artifact</td>
-</tr>
-</tbody>
-</table>
-<a name="file_sets"></a>
-<h3>File Sets</h3>
-<p>Additional file sets may be configured for inclusion into the
-AAR file. A file set looks as follows:</p>
-<pre>
-
- <fileSets>
- <fileSet>
- <directory>src/aar/files</directory>
- <outputDirectory>META-INF/docs</outputDirectory>
- <includes>
- <include>**/*.html</include>
-
- </includes>
- </fileSet>
- <fileSet>
- <directory>src/aar/files</directory>
- <outputDirectory>META-INF/etc</outputDirectory>
-
- <excludes>
- <exclude>**/*.html</exclude>
- </excludes>
- </fileSet>
- </fileSets>
-
-</pre>
-<p>The example specifies, that the contents of the directory
-src/aar/files shall be added to the AAR file. HTML files will go
-into META-INF/docs, all other files to META-INF/etc.</p>
-<p>A file set is configured through the following configuration
-parameters:</p>
-<table class="bodyTable">
-<tbody>
-<tr class="b">
-<td><strong>Parameter Name</strong></td>
-<td><strong>Description</strong></td>
-</tr>
-<tr class="a">
-<td>directory</td>
-<td>The directory, from which to read the file set. This parameter
-is required</td>
-</tr>
-<tr class="b">
-<td>outputDirectory</td>
-<td>The target directory within the AAR file. Defaults to the AAR
-files root directory</td>
-</tr>
-<tr class="a">
-<td>includes</td>
-<td>Configures the set of files, which shall be included into the
-AAR file. Defaults to **/*</td>
-</tr>
-<tr class="b">
-<td>excludes</td>
-<td>Configures a set of files, which shall be excluded from the
-file set. Defaults to the Maven default excludes (**/*~,
-**/cvs/**/*, **/.svn/**/*, etc.)</td>
-</tr>
-<tr class="a">
-<td>skipDefaultExcludes</td>
-<td>If this parameter is set to true, then no default excludes are
-being used</td>
-</tr>
-</tbody>
-</table>
-
+ <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>
+<meta http-equiv="content-type" content=""></meta>
+Maven2 AAR Plug-in Guide
+<link href="../../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></link>
+</head>
+
+<h1>Maven2 AAR Plug-in Guide</h1>
+<h2>Introduction</h2>
+<p>This plugin generates an Axis 2 service file (AAR file).</p>
+<p><a href="http://ws.apache.org/axis2/tools/index.html">[Download Plugin Tool]</a></p>
+<h2>Goals</h2>
+<p>The AAR plugin allows the packaging of an Axis 2 service aar in
+3 different modes:</p>
+<ol type="1">
+<li><b>aar (default)</b>: generates the aar artifact</li>
+<li><b>inplace</b> : package the aar in the source tree</li>
+<li><b>exploded</b> : package an exploded aar application</li>
+</ol>
+Each mode is materialized by a goal. For instance, to generate
+an exploded aar from the current project, one would type
+<pre>
+mvn aar:exploded
+</pre>
+<h2>Configuration</h2>
+All AAR plugin goals takes the following configuration
+parameters as input:
+<table class="bodyTable">
+<tbody>
+<tr class="a">
+<td><strong>Parameter Name</strong></td>
+<td><strong>Default Value</strong></td>
+<td><strong>Description</strong></td>
+</tr>
+<tr class="b">
+<td>aarDirectory</td>
+<td>${project.build.directory}/aar</td>
+<td>Directory where the aar file is built</td>
+</tr>
+<tr class="a">
+<td>classesDirectory</td>
+<td>${project.build.outputDirectory}</td>
+<td>Directory with compiled classes and resources</td>
+</tr>
+<tr class="b">
+<td>fileSets</td>
+<td></td>
+<td>Additional file sets, which are being added to the archive. See
+"<a href="#file_sets">File Sets</a>" below for an example</td>
+</tr>
+<tr class="a">
+<td>servicesXmlFile</td>
+<td></td>
+<td>Location of the services.xml file. By default, it is assumed
+that the file is already present in classesDirectory/META-INF and
+no special processing is required</td>
+</tr>
+<tr class="b">
+<td>wsdlFile</td>
+<td></td>
+<td>Location of the WSDL file. By default, it is assumed that the
+file is already present in classesDirectory/META-INF and no special
+processing is required</td>
+</tr>
+<tr class="a">
+<td>wsdlFileName</td>
+<td>service.wsdl</td>
+<td>Name, to which the WSDL file should be mapped</td>
+</tr>
+</tbody>
+</table>
+<h3>The aar Goal</h3>
+The aar goal allows the following additional parameters:
+<table class="bodyTable">
+<tbody>
+<tr class="b">
+<td><strong>Parameter Name</strong></td>
+<td><strong>Default Value</strong></td>
+<td><strong>Description</strong></td>
+</tr>
+<tr class="a">
+<td>outputDirectory</td>
+<td>${project.build.directory}</td>
+<td>Directory where to generate the AAR file</td>
+</tr>
+<tr class="b">
+<td>aarName</td>
+<td>${project.build.finalName}</td>
+<td>The generated AAR files name</td>
+</tr>
+<tr class="a">
+<td>archive</td>
+<td></td>
+<td>A Maven archive configuration. This allows, for example, to
+configure the MANIFEST.MF file</td>
+</tr>
+<tr class="b">
+<td>classifier</td>
+<td></td>
+<td>A classifier, which should be added to the generated AAR files
+name. Setting this parameter has the side effect, that the artifact
+is treated as an attachment and not as the projects primary
+artifact</td>
+</tr>
+<tr class="a">
+<td>primaryArtifact</td>
+<td>true</td>
+<td>Setting this property to false disables installation or
+deployment of the artifact as the projects primary artifact</td>
+</tr>
+</tbody>
+</table>
+<a name="file_sets"></a>
+<h3>File Sets</h3>
+<p>Additional file sets may be configured for inclusion into the
+AAR file. A file set looks as follows:</p>
+<pre>
+
+ <fileSets>
+ <fileSet>
+ <directory>src/aar/files</directory>
+ <outputDirectory>META-INF/docs</outputDirectory>
+ <includes>
+ <include>**/*.html</include>
+
+ </includes>
+ </fileSet>
+ <fileSet>
+ <directory>src/aar/files</directory>
+ <outputDirectory>META-INF/etc</outputDirectory>
+
+ <excludes>
+ <exclude>**/*.html</exclude>
+ </excludes>
+ </fileSet>
+ </fileSets>
+
+</pre>
+<p>The example specifies, that the contents of the directory
+src/aar/files shall be added to the AAR file. HTML files will go
+into META-INF/docs, all other files to META-INF/etc.</p>
+<p>A file set is configured through the following configuration
+parameters:</p>
+<table class="bodyTable">
+<tbody>
+<tr class="b">
+<td><strong>Parameter Name</strong></td>
+<td><strong>Description</strong></td>
+</tr>
+<tr class="a">
+<td>directory</td>
+<td>The directory, from which to read the file set. This parameter
+is required</td>
+</tr>
+<tr class="b">
+<td>outputDirectory</td>
+<td>The target directory within the AAR file. Defaults to the AAR
+files root directory</td>
+</tr>
+<tr class="a">
+<td>includes</td>
+<td>Configures the set of files, which shall be included into the
+AAR file. Defaults to **/*</td>
+</tr>
+<tr class="b">
+<td>excludes</td>
+<td>Configures a set of files, which shall be excluded from the
+file set. Defaults to the Maven default excludes (**/*~,
+**/cvs/**/*, **/.svn/**/*, etc.)</td>
+</tr>
+<tr class="a">
+<td>skipDefaultExcludes</td>
+<td>If this parameter is set to true, then no default excludes are
+being used</td>
+</tr>
+</tbody>
+</table>
+
</html>
</div>
</div>
Modified: webservices/axis2/site/tools/1_3/maven-plugins/maven-java2wsdl-plugin.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/tools/1_3/maven-plugins/maven-java2wsdl-plugin.html?rev=652665&r1=652664&r2=652665&view=diff
==============================================================================
--- webservices/axis2/site/tools/1_3/maven-plugins/maven-java2wsdl-plugin.html (original)
+++ webservices/axis2/site/tools/1_3/maven-plugins/maven-java2wsdl-plugin.html Thu May 1 14:20:27 2008
@@ -271,122 +271,122 @@
</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>
-<meta http-equiv="content-type" content=""></meta>
-Maven2 Java2WSDL Plug-in Guide
-<link href="../../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></link>
-</head>
-
-<h1>Maven2 Java2WSDL Plug-in Guide</h1>
-<h2>Introduction</h2>
-<p>This plugin takes as input a Java class and generates a WSDL,
-which describes a Web service for invoking the classes methods.</p>
-<p><a href="http://ws.apache.org/axis2/tools/index.html">[Download Plugin Tool]</a></p>
-<h2>Goals</h2>
-<p>The Java2WSDL plugin offers a single goal:</p>
-<ul>
-<li>java2wsdl (default): Reads a java class and generates a WSDL
-for invoking the classes methods as a Web service.</li>
-</ul>
-To run the plugin, add the following section to your <a href="http://maven.apache.org/guides/introduction/introduction-to-the-pom.html">
-POM</a> (Project Object Model):
-<pre>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.axis2.maven2</groupId>
- <artifactId>axis2-java2wsdl-maven-plugin</artifactId>
- <configuration>
- <className>com.foo.myservice.MyHandler</className>
- </configuration>
- <executions>
- <execution>
- <goals>
- <goal>java2wsdl</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
-
-</pre>
-<p>The plugin will be invoked automatically in the
-generate-resources phase. You can also invoke it directly from the
-command line by running the command:</p>
-<pre>
-mvn java2wsdl:java2wsdl
-</pre>
-<h3>The Java2WSDL Goal</h3>
-<p>By default, the plugin reads the given Java class and creates a
-file
-<strong>target/generated-resources/java2wsdl/service.xml</strong>.
-The Java class is given by the configuration element
-<strong>className</strong> above.</p>
-<h2>Configuration</h2>
-<p>The Java2WSDL goal takes the following parameters as input. All
-parameters can be set from the command line by using properties.
-For example, the parameter "className" may be set using the
-property "axis2.java2wsdl.className". If the parameter isn't set
-via property or in the POM, then a default value applies.</p>
-<table class="bodyTable">
-<tbody>
-<tr class="a">
-<td><strong>Parameter name</strong></td>
-<td><strong>Command line property</strong></td>
-<td><strong>Description</strong></td>
-<td><strong>Default value</strong></td>
-</tr>
-<tr class="b">
-<td>className</td>
-<td>${axis2.java2wsdl.className}</td>
-<td>Fully qualified name of the class, which is being read and
-transformed into a WSDL</td>
-<td></td>
-</tr>
-<tr class="a">
-<td>outputFileName</td>
-<td>${axis2.java2wsdl.outputFileName}</td>
-<td>Path of the generated service file.</td>
-<td></td>
-</tr>
-<tr class="b">
-<td>schemaTargetNamespace</td>
-<td>${axis2.java2wsdl.schemaTargetNamespace}</td>
-<td>Target namespace of the generated schema.</td>
-<td></td>
-</tr>
-<tr class="a">
-<td>schemaTargetNamespacePrefix</td>
-<td>${axis2.java2wsdl.schemaTargetNamespacePrefix}</td>
-<td>Prefix, which is being associated with the schemas target
-namespace.</td>
-<td></td>
-</tr>
-<tr class="b">
-<td>serviceName</td>
-<td>${axis2.java2wsdl.serviceName}</td>
-<td>Name of the generated Web service.</td>
-<td>Unqualified name of the input class.</td>
-</tr>
-<tr class="a">
-<td>targetNamespace</td>
-<td>${axis2.java2wsdl.targetNamespace}</td>
-<td>Target namespace of the generated WSDL</td>
-<td>Default namespace</td>
-</tr>
-<tr class="b">
-<td>targetNamespacePrefix</td>
-<td>${axis2.java2wsdl.targetNamespacePrefix}</td>
-<td>Prefix, which is being associated with the target
-namespace</td>
-<td></td>
-</tr>
-</tbody>
-</table>
-
+ <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>
+<meta http-equiv="content-type" content=""></meta>
+Maven2 Java2WSDL Plug-in Guide
+<link href="../../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></link>
+</head>
+
+<h1>Maven2 Java2WSDL Plug-in Guide</h1>
+<h2>Introduction</h2>
+<p>This plugin takes as input a Java class and generates a WSDL,
+which describes a Web service for invoking the classes methods.</p>
+<p><a href="http://ws.apache.org/axis2/tools/index.html">[Download Plugin Tool]</a></p>
+<h2>Goals</h2>
+<p>The Java2WSDL plugin offers a single goal:</p>
+<ul>
+<li>java2wsdl (default): Reads a java class and generates a WSDL
+for invoking the classes methods as a Web service.</li>
+</ul>
+To run the plugin, add the following section to your <a href="http://maven.apache.org/guides/introduction/introduction-to-the-pom.html">
+POM</a> (Project Object Model):
+<pre>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.axis2.maven2</groupId>
+ <artifactId>axis2-java2wsdl-maven-plugin</artifactId>
+ <configuration>
+ <className>com.foo.myservice.MyHandler</className>
+ </configuration>
+ <executions>
+ <execution>
+ <goals>
+ <goal>java2wsdl</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+
+</pre>
+<p>The plugin will be invoked automatically in the
+generate-resources phase. You can also invoke it directly from the
+command line by running the command:</p>
+<pre>
+mvn java2wsdl:java2wsdl
+</pre>
+<h3>The Java2WSDL Goal</h3>
+<p>By default, the plugin reads the given Java class and creates a
+file
+<strong>target/generated-resources/java2wsdl/service.xml</strong>.
+The Java class is given by the configuration element
+<strong>className</strong> above.</p>
+<h2>Configuration</h2>
+<p>The Java2WSDL goal takes the following parameters as input. All
+parameters can be set from the command line by using properties.
+For example, the parameter "className" may be set using the
+property "axis2.java2wsdl.className". If the parameter isn't set
+via property or in the POM, then a default value applies.</p>
+<table class="bodyTable">
+<tbody>
+<tr class="a">
+<td><strong>Parameter name</strong></td>
+<td><strong>Command line property</strong></td>
+<td><strong>Description</strong></td>
+<td><strong>Default value</strong></td>
+</tr>
+<tr class="b">
+<td>className</td>
+<td>${axis2.java2wsdl.className}</td>
+<td>Fully qualified name of the class, which is being read and
+transformed into a WSDL</td>
+<td></td>
+</tr>
+<tr class="a">
+<td>outputFileName</td>
+<td>${axis2.java2wsdl.outputFileName}</td>
+<td>Path of the generated service file.</td>
+<td></td>
+</tr>
+<tr class="b">
+<td>schemaTargetNamespace</td>
+<td>${axis2.java2wsdl.schemaTargetNamespace}</td>
+<td>Target namespace of the generated schema.</td>
+<td></td>
+</tr>
+<tr class="a">
+<td>schemaTargetNamespacePrefix</td>
+<td>${axis2.java2wsdl.schemaTargetNamespacePrefix}</td>
+<td>Prefix, which is being associated with the schemas target
+namespace.</td>
+<td></td>
+</tr>
+<tr class="b">
+<td>serviceName</td>
+<td>${axis2.java2wsdl.serviceName}</td>
+<td>Name of the generated Web service.</td>
+<td>Unqualified name of the input class.</td>
+</tr>
+<tr class="a">
+<td>targetNamespace</td>
+<td>${axis2.java2wsdl.targetNamespace}</td>
+<td>Target namespace of the generated WSDL</td>
+<td>Default namespace</td>
+</tr>
+<tr class="b">
+<td>targetNamespacePrefix</td>
+<td>${axis2.java2wsdl.targetNamespacePrefix}</td>
+<td>Prefix, which is being associated with the target
+namespace</td>
+<td></td>
+</tr>
+</tbody>
+</table>
+
</html>
</div>
</div>
Modified: webservices/axis2/site/tools/1_3/maven-plugins/maven-wsdl2code-plugin.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/tools/1_3/maven-plugins/maven-wsdl2code-plugin.html?rev=652665&r1=652664&r2=652665&view=diff
==============================================================================
--- webservices/axis2/site/tools/1_3/maven-plugins/maven-wsdl2code-plugin.html (original)
+++ webservices/axis2/site/tools/1_3/maven-plugins/maven-wsdl2code-plugin.html Thu May 1 14:20:27 2008
@@ -271,187 +271,187 @@
</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>
-<meta http-equiv="content-type" content=""></meta>
-Maven2 WSDL2Code Plug-in Guide
-<link href="../../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></link>
-</head>
-
-<h1>Maven2 WSDL2Code Plug-in Guide</h1>
-<h2>Introduction</h2>
-<p>This plugin takes as input a WSDL and generates client and
-server stubs for calling or implementing a Web service matching the
-WSDL.</p>
-<p><a href="http://ws.apache.org/axis2/tools/index.html">[Download Plugin Tool]</a></p>
-<h2>Goals</h2>
-<p>The WSDl2Code offers a single goal:</p>
-<ul>
-<li>wsdl2code (default): Reads the WSDL and generates code.</li>
-</ul>
-To run the plugin, add the following section to your <a href="http://maven.apache.org/guides/introduction/introduction-to-the-pom.html">
-POM</a> (Project Object Model):
-<pre>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.axis2.maven2</groupId>
- <artifactId>axis2-wsdl2code-maven-plugin</artifactId>
- <executions>
- <execution>
- <goals>
- <goal>wsdl2code</goal>
- </goals>
- </execution>
- </executions>
- <configuration>
- <packageName>com.foo.myservice</packageName>
- </configuration>
- </plugin>
- </plugins>
- </build>
-</pre>
-<p>The plugin will be invoked automatically in the generate-sources
-phase. You can also invoke it directly from the command line by
-running the command</p>
-<pre>
-mvn wsdl2code:wsdl2code
-</pre>
-<h3>The WSDL2Code Goal</h3>
-<p>By default, the plugin reads the file
-<strong>src/main/axis2/service.wsdl</strong>. Sources for the Java
-programming language and the ADB data binding are generated into
-<strong>target/generated-sources/axis2/wsdl2code</strong>. Note the
-configuration element <strong>packageName</strong> above, which
-sets the package name, thus a subdirectory.</p>
-<h2>Configuration</h2>
-<p>The WSDL2Code goal takes the following parameters as input. All
-parameters can be set from the command line by using properties.
-For example, the parameter "generateServerSide" may be set using
-the property "axis2.wsdl2code.generateServerSide". If the parameter
-isn't set via property or in the POM, then a default value
-applies.</p>
-<table class="bodyTable">
-<tbody>
-<tr class="a">
-<td><strong>Parameter Name</strong></td>
-<td><strong>Command Line Property</strong></td>
-<td><strong>Description</strong></td>
-<td><strong>Default Value</strong></td>
-</tr>
-<tr class="b">
-<td>databindingName</td>
-<td>${axis2.wsdl2code.databindingName}</td>
-<td>Data binding framework, which is being used by the generated
-sources.</td>
-<td>adb</td>
-</tr>
-<tr class="a">
-<td>generateAllClasses</td>
-<td>${axis2.wsdl2code.generateAllClasses}</td>
-<td>Whether to generate simply all classes. This is only valid in
-conjunction with "generateServerSide".</td>
-<td>false</td>
-</tr>
-<tr class="b">
-<td>generateServerSide</td>
-<td>${axis2.wsdl2code.generateServerSide}</td>
-<td>Whether server side sources are being generated.</td>
-<td>false</td>
-</tr>
-<tr class="a">
-<td>generateServerSideInterface</td>
-<td>${axis2.wsdl2code.generateServerSideInterface}</td>
-<td>Whether to generate the server side interface.</td>
-<td>false</td>
-</tr>
-<tr class="b">
-<td>generateServicesXml</td>
-<td>${axis2.wsdl2code.generateServicesXml}</td>
-<td>Whether a "services.xml" file is being generated.</td>
-<td>false</td>
-</tr>
-<tr class="a">
-<td>generateTestcase</td>
-<td>${axis2.wsdl2code.generateTestCase}</td>
-<td>Whether a test case is being generated.</td>
-<td>false</td>
-</tr>
-<tr class="b">
-<td>language</td>
-<td>${axis2.wsdl2code.language}</td>
-<td>Programming language of the generated sources.</td>
-<td>java</td>
-</tr>
-<tr class="a">
-<td>namespaceToPackages</td>
-<td>${axis2.wsdl2code.namespaceToPackages}</td>
-<td>Map of namespace URI to packages in the format
-uri1=package1,uri2=package2,... Using this parameter is
-discouraged. In general, you should use the namespaceUris
-parameter. However, the latter cannot be set on the command
-line.</td>
-<td></td>
-</tr>
-<tr class="b">
-<td>namespaceURIs</td>
-<td></td>
-<td>Map of namespace URI to packages. Example:
-<namespaceURIs> <namespaceURI>
-<uri>uri1</uri> <package>package1</package>
-</namespaceURI> ........ </namespaceURI></td>
-<td></td>
-</tr>
-<tr class="a">
-<td>outputDirectory</td>
-<td>${axis2.wsdl2code.target}</td>
-<td>Target directory, where sources are being
-target/generated-sources/axis2/wsdl2code generated.</td>
-<td></td>
-</tr>
-<tr class="b">
-<td>packageName</td>
-<td>${axis2.wsdl2code.package}</td>
-<td>Package name of the generated sources.</td>
-<td></td>
-</tr>
-<tr class="a">
-<td>portName</td>
-<td>${axis2.wsdl2code.portName}</td>
-<td>Port name, for which sources are being generated. By default,
-sources are generated for all ports.</td>
-<td></td>
-</tr>
-<tr class="b">
-<td>serviceName</td>
-<td>${axis2.wsdl2code.serviceName}</td>
-<td>Service name, for which sources are being generated. By
-default, sources are generated for all services.</td>
-<td></td>
-</tr>
-<tr class="a">
-<td>syncMode</td>
-<td>${axis2.wsdl2code.syncMode}</td>
-<td>Sync mode, for which sources are being generated; either of
-"sync", "async", or "both" (default).</td>
-<td>both</td>
-</tr>
-<tr class="b">
-<td>unpackClasses</td>
-<td>${axis2.wsdl2code.unpackClasses}</td>
-<td>Whether to unpack classes.</td>
-<td></td>
-</tr>
-<tr class="a">
-<td>wsdlFile</td>
-<td>${axis2.wsdl2code.wsdl}</td>
-<td>Location of the WSDL file, which is read as input</td>
-<td>src/main/axis2/service.wsdl</td>
-</tr>
-</tbody>
-</table>
-
+ <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>
+<meta http-equiv="content-type" content=""></meta>
+Maven2 WSDL2Code Plug-in Guide
+<link href="../../../css/axis-docs.css" rel="stylesheet" type="text/css" media="all"></link>
+</head>
+
+<h1>Maven2 WSDL2Code Plug-in Guide</h1>
+<h2>Introduction</h2>
+<p>This plugin takes as input a WSDL and generates client and
+server stubs for calling or implementing a Web service matching the
+WSDL.</p>
+<p><a href="http://ws.apache.org/axis2/tools/index.html">[Download Plugin Tool]</a></p>
+<h2>Goals</h2>
+<p>The WSDl2Code offers a single goal:</p>
+<ul>
+<li>wsdl2code (default): Reads the WSDL and generates code.</li>
+</ul>
+To run the plugin, add the following section to your <a href="http://maven.apache.org/guides/introduction/introduction-to-the-pom.html">
+POM</a> (Project Object Model):
+<pre>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.axis2.maven2</groupId>
+ <artifactId>axis2-wsdl2code-maven-plugin</artifactId>
+ <executions>
+ <execution>
+ <goals>
+ <goal>wsdl2code</goal>
+ </goals>
+ </execution>
+ </executions>
+ <configuration>
+ <packageName>com.foo.myservice</packageName>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+</pre>
+<p>The plugin will be invoked automatically in the generate-sources
+phase. You can also invoke it directly from the command line by
+running the command</p>
+<pre>
+mvn wsdl2code:wsdl2code
+</pre>
+<h3>The WSDL2Code Goal</h3>
+<p>By default, the plugin reads the file
+<strong>src/main/axis2/service.wsdl</strong>. Sources for the Java
+programming language and the ADB data binding are generated into
+<strong>target/generated-sources/axis2/wsdl2code</strong>. Note the
+configuration element <strong>packageName</strong> above, which
+sets the package name, thus a subdirectory.</p>
+<h2>Configuration</h2>
+<p>The WSDL2Code goal takes the following parameters as input. All
+parameters can be set from the command line by using properties.
+For example, the parameter "generateServerSide" may be set using
+the property "axis2.wsdl2code.generateServerSide". If the parameter
+isn't set via property or in the POM, then a default value
+applies.</p>
+<table class="bodyTable">
+<tbody>
+<tr class="a">
+<td><strong>Parameter Name</strong></td>
+<td><strong>Command Line Property</strong></td>
+<td><strong>Description</strong></td>
+<td><strong>Default Value</strong></td>
+</tr>
+<tr class="b">
+<td>databindingName</td>
+<td>${axis2.wsdl2code.databindingName}</td>
+<td>Data binding framework, which is being used by the generated
+sources.</td>
+<td>adb</td>
+</tr>
+<tr class="a">
+<td>generateAllClasses</td>
+<td>${axis2.wsdl2code.generateAllClasses}</td>
+<td>Whether to generate simply all classes. This is only valid in
+conjunction with "generateServerSide".</td>
+<td>false</td>
+</tr>
+<tr class="b">
+<td>generateServerSide</td>
+<td>${axis2.wsdl2code.generateServerSide}</td>
+<td>Whether server side sources are being generated.</td>
+<td>false</td>
+</tr>
+<tr class="a">
+<td>generateServerSideInterface</td>
+<td>${axis2.wsdl2code.generateServerSideInterface}</td>
+<td>Whether to generate the server side interface.</td>
+<td>false</td>
+</tr>
+<tr class="b">
+<td>generateServicesXml</td>
+<td>${axis2.wsdl2code.generateServicesXml}</td>
+<td>Whether a "services.xml" file is being generated.</td>
+<td>false</td>
+</tr>
+<tr class="a">
+<td>generateTestcase</td>
+<td>${axis2.wsdl2code.generateTestCase}</td>
+<td>Whether a test case is being generated.</td>
+<td>false</td>
+</tr>
+<tr class="b">
+<td>language</td>
+<td>${axis2.wsdl2code.language}</td>
+<td>Programming language of the generated sources.</td>
+<td>java</td>
+</tr>
+<tr class="a">
+<td>namespaceToPackages</td>
+<td>${axis2.wsdl2code.namespaceToPackages}</td>
+<td>Map of namespace URI to packages in the format
+uri1=package1,uri2=package2,... Using this parameter is
+discouraged. In general, you should use the namespaceUris
+parameter. However, the latter cannot be set on the command
+line.</td>
+<td></td>
+</tr>
+<tr class="b">
+<td>namespaceURIs</td>
+<td></td>
+<td>Map of namespace URI to packages. Example:
+<namespaceURIs> <namespaceURI>
+<uri>uri1</uri> <package>package1</package>
+</namespaceURI> ........ </namespaceURI></td>
+<td></td>
+</tr>
+<tr class="a">
+<td>outputDirectory</td>
+<td>${axis2.wsdl2code.target}</td>
+<td>Target directory, where sources are being
+target/generated-sources/axis2/wsdl2code generated.</td>
+<td></td>
+</tr>
+<tr class="b">
+<td>packageName</td>
+<td>${axis2.wsdl2code.package}</td>
+<td>Package name of the generated sources.</td>
+<td></td>
+</tr>
+<tr class="a">
+<td>portName</td>
+<td>${axis2.wsdl2code.portName}</td>
+<td>Port name, for which sources are being generated. By default,
+sources are generated for all ports.</td>
+<td></td>
+</tr>
+<tr class="b">
+<td>serviceName</td>
+<td>${axis2.wsdl2code.serviceName}</td>
+<td>Service name, for which sources are being generated. By
+default, sources are generated for all services.</td>
+<td></td>
+</tr>
+<tr class="a">
+<td>syncMode</td>
+<td>${axis2.wsdl2code.syncMode}</td>
+<td>Sync mode, for which sources are being generated; either of
+"sync", "async", or "both" (default).</td>
+<td>both</td>
+</tr>
+<tr class="b">
+<td>unpackClasses</td>
+<td>${axis2.wsdl2code.unpackClasses}</td>
+<td>Whether to unpack classes.</td>
+<td></td>
+</tr>
+<tr class="a">
+<td>wsdlFile</td>
+<td>${axis2.wsdl2code.wsdl}</td>
+<td>Location of the WSDL file, which is read as input</td>
+<td>src/main/axis2/service.wsdl</td>
+</tr>
+</tbody>
+</table>
+
</html>
</div>
</div>
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org