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 ch...@apache.org on 2006/05/02 15:32:56 UTC
svn commit: r398937 - in /webservices/axis2/trunk/java/xdocs/latest:
index.html jibx/jibx-codegen-integration.html
tools/eclipse/servicearchiver-plugin.html
Author: chatra
Date: Tue May 2 06:32:27 2006
New Revision: 398937
URL: http://svn.apache.org/viewcvs?rev=398937&view=rev
Log:
upgrading tools docs
Modified:
webservices/axis2/trunk/java/xdocs/latest/index.html
webservices/axis2/trunk/java/xdocs/latest/jibx/jibx-codegen-integration.html
webservices/axis2/trunk/java/xdocs/latest/tools/eclipse/servicearchiver-plugin.html
Modified: webservices/axis2/trunk/java/xdocs/latest/index.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/latest/index.html?rev=398937&r1=398936&r2=398937&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/index.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/index.html Tue May 2 06:32:27 2006
@@ -133,7 +133,9 @@
<tr>
<td><a href="jibx/jibx-codegen-integration.html">JiBX Integration With
Axis2</a></td>
- <td></td>
+ <td>Guide to using JiBX with Axis2 in order to expose existing Java
+ code as a Web service and to implement a client for an existing Web
+ service</td>
</tr>
<tr>
<td><a href="security-module.html">WS-Security How-to</a></td>
Modified: webservices/axis2/trunk/java/xdocs/latest/jibx/jibx-codegen-integration.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/latest/jibx/jibx-codegen-integration.html?rev=398937&r1=398936&r2=398937&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/jibx/jibx-codegen-integration.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/jibx/jibx-codegen-integration.html Tue May 2 06:32:27 2006
@@ -7,101 +7,129 @@
<body>
<h1>JiBX Integration With Axis2</h1>
+<p>This document will explain the usage of JiBX with Axis2 in order to expose
+existing Java code as a Web service and to implement a client for an existing
+Web service (or the service stubs for implementing the service).</p>
+
+<h2>Content</h2>
+<ul>
+ <li><a href="#intro">Introduction</a></li>
+ <li><a href="#java">Starting from Java</a></li>
+ <li><a href="#wsdl">Starting from WSDL</a></li>
+ <li><a href="#codegen">Axis2 JiBX Code Generation</a></li>
+ <li><a href="#coming">Coming Attractions</a></li>
+</ul>
+<a name="intro"></a>
+
<h2>Introduction</h2>
<p><a href="http://www.jibx.org">JiBX data binding</a> supports fast and
-flexible conversions between plain old Java objects (POJOs) and XML. JiBX uses a
-mapped binding approach that's based on a binding definition document you
-provide. This lets you customize the way your Java objects are converted to and
-from XML. These features make JiBX especially useful if you're developing a Web
-service based on existing Java code.</p>
-
-<p>Axis2 supports using JiBX with your web services, including generating the
-necessary linkage code for both client and server side. However, the Axis2
-support for JiBX doesn't currently include code generation from the schema for a
-web service - you need to provide your own data classes and JiBX binding
-definition, and you also need to make sure that the binding definition matches
-the XML structures defined for your web service. The JiBX project provides some
-basic tools to help with code generation from schema, binding generation from
-Java classes, and schema generation from the combination of Java classes and a
-binding definition. In the future improved versions of these tools will be
-integrated directly into the Axis2 framework support, but for now you're on your
-own with this part of the setup.</p>
-
-<p>You can use JiBX data binding both to expose existing Java code as a service,
-and to build a client for an existing service. This document runs through the
-sequence of steps involved for each of these cases, just to help users
-understand the basic approach to working with JiBX in Axis2. You can find full
-instructions on the standard JiBX parts of this sequence on the
-<a href="http://www.jibx.org">JiBX web site</a>.</p>
+flexible conversions between plain old Java objects (POJOs) and XML. JiBX
+uses a mapped binding approach that's based on a binding definition document
+you provide. This lets you customize the way your Java objects are converted
+to and from XML. These features make JiBX especially useful if you're
+developing a Web service based on existing Java code.</p>
+
+<p>Axis2 supports using JiBX with your Web services, including generating the
+necessary linkage code for both client and server sides. However, the Axis2
+support for JiBX doesn't currently include code generation from the schema
+for a Web service - you need to provide your own data classes and JiBX
+binding definition, and you also need to make sure that the binding
+definition matches the XML structures defined for your Web service. The JiBX
+project provides some basic tools to help with code generation from schema,
+binding generation from Java classes, and schema generation from the
+combination of Java classes and a binding definition. In the future, improved
+versions of these tools will be integrated directly into the Axis2 framework
+support, but for now you're on your own with this part of the setup.</p>
+
+<p>You can use JiBX data binding both to expose existing Java code as a
+service, and to build a client for an existing service. This document runs
+through the sequence of steps involved for each of these cases, just to help
+users understand the basic approach to working with JiBX in Axis2. You can
+find full instructions on the standard JiBX parts of this sequence on the <a
+href="http://www.jibx.org">JiBX web site</a>.</p>
+<a name="java"></a>
<h2>Starting from Java</h2>
<p>Here's the sequence of steps for using JiBX with Axis2 to expose existing
-Java code as a web service:</p>
+Java code as a Web service:</p>
+<ol>
+ <li>Create a JiBX binding definition for the data being transferred by the
+ Web service</li>
+ <li>Create a schema that matches the XML defined by your binding (you may
+ be able to use the JiBX schema generator to help with this)</li>
+ <li>Create a WSDL document for your service, with the schema embedded or
+ imported.</li>
+ <li>Generate Axis2 server-side linkage code using WSDL2Java with the WSDL
+ and your binding definition</li>
+ <li>Run the JiBX binding compiler on your Java classes to add the actual
+ binding code</li>
+ <li>Include the <i>axis2-jibx.jar</i> in your runtime classpath, along with
+ the <i>jibx-runtime.jar</i> (normally done by including these in the
+ <i>axis2/WEB-INF/lib</i> directory)</li>
+</ol>
+<p><strong>The above is assuming:</strong></p>
<ol>
-<li>Create a JiBX binding definition for the data being transferred by the web
-service</li>
-<li>Create a schema that matches the XML defined by your binding (you may be
-able to use the JiBX schema generator to help with this)</li>
-<li>Create a WSDL document for your service, with the schema embedded or
-imported</li>
-<li>Generate Axis2 server-side linkage code using WSDL2Java with the WSDL and
-your binding definition</li>
-<li>Run the JiBX binding compiler on your Java classes to add the actual binding
-code</li>
-<li>Include the <i>axis2-jibx.jar</i> in your runtime classpath, along with the
-<i>jibx-runtime.jar</i> (normally done by including these in the
-<i>axis2/WEB-INF/lib</i> directory)</li>
+ <li>Your code already provides methods to implement the operations you want
+ to expose as a Web service</li>
+ <li>These methods each take a single parameter object that's unique to the
+ method</li>
+ <li>Each return a single response object.</li>
</ol>
-<p>The above is assuming your code already provides methods to implement the
-operations you want to expose as a web service, that these methods each take a
-single parameter object that's unique to the method and each return a single
-response object. If this is <i>not</i> the case, you'll also need to create
-wrapper classes and perhaps wrapper methods for now. See the
-<a href="./jibx-example.html">JiBX example</a> for more details on this.</p>
+<p>If this is <i>not</i> the case, you'll also need to create wrapper classes
+and perhaps wrapper methods for now. See the <a
+href="./jibx-example.html">JiBX example</a> for more details on this.</p>
+<a name="wsdl"></a>
<h2>Starting from WSDL</h2>
-<p>Here's the sequence of steps for using JiBX with Axis2 to implement a client
-for an existing web service (or the service stubs for implementing the
+<p>Here's the sequence of steps for using JiBX with Axis2 to implement a
+client for an existing Web service (or the service stubs for implementing the
service):</p>
-
<ol>
-<li>Create Java classes for the data being transferred by the web service, and a
-JiBX binding definition that maps these classes to the schema defined by the web
-service (you may be able to use the JiBX xsd2jibx tool to help with this)</li>
-<li>Generate Axis2 client linkage code using WSDL2Java with the WSDL and your
-binding definition</li>
-<li>Run the JiBX binding compiler on your Java classes to add the actual binding
-code</li>
-<li>Include the <i>axis2-jibx.jar</i> in your runtime classpath, along with the
-<i>jibx-runtime.jar</i></li>
+ <li>Create Java classes for the data being transferred by the Web service,
+ and a JiBX binding definition that maps these classes to the schema
+ defined by the Web service (you may be able to use the JiBX xsd2jibx tool
+ to help with this)</li>
+ <li>Generate Axis2 client linkage code using WSDL2Java with the WSDL and
+ your binding definition</li>
+ <li>Run the JiBX binding compiler on your Java classes to add the actual
+ binding code</li>
+ <li>Include the <i>axis2-jibx.jar</i> in your runtime classpath, along with
+ the <i>jibx-runtime.jar</i></li>
</ol>
+<a name="codegen"></a>
-<h2>Axis2 JiBX code generation</h2>
+<h2>Axis2 JiBX Code Generation</h2>
-<p>To run the WSDL2Java tool for JiBX data binding you need to specify
-<i>-d jibx</i> to select JiBX binding. You also need an additional parameter,
-<i>-Ebindingfile {file}</i> (where <i>{file}</i> is the file path to your JiBX
-binding definition). Finally, you need to have the <i>axis2-jibx.jar</i>, the
-<i>jibx-bind-1.1beta2.jar</i>, and the <i>jibx-run-1.1beta2.jar</i> files from
-your Axis2 distribution included in the WSDL2Java classpath.</p>
+<p>To run the WSDL2Java tool for JiBX data binding you need:</p>
+<ol>
+ <li>To specify <i>-d jibx</i> to select JiBX binding.</li>
+ <li>You also need an additional parameter, <i>-Ebindingfile {file}</i>
+ (where <i>{file}</i> is the file path to your JiBX binding
+ definition).</li>
+ <li>Finally, you need to have the <i>axis2-jibx.jar</i>, the
+ <i>jibx-bind-1.1beta2.jar</i>, and the <i>jibx-run-1.1beta2.jar</i> files
+ from your Axis2 distribution included in the WSDL2Java classpath.</li>
+</ol>
+<a name="coming"></a>
-<h2>Coming attractions</h2>
+<h2>Coming Attractions</h2>
<p>Soon after the release of Axis2 1.0 the JiBX support will be extended to
-support automatic handling of "wrapped" doc/lit services. This will dramatically
-reduce the number of classes that need to be defined for working with simple
-services, and simplify both starting from Java and starting from WSDL. The full
-JiBX 1.1 release will also provide much improved support for code generation
-from schemas, and for binding+schema generation from code, and these features
-will be integrated into the Axis2 JiBX support. Check the
-<a href="http://www.jibx.org">JiBX project site</a> for updates on both JiBX 1.1
+support automatic handling of "wrapped" doc/lit services. This will
+dramatically reduce the number of classes that need to be defined for working
+with simple services, and simplify both starting from Java and starting from
+WSDL. </p>
+
+<p>The full JiBX 1.1 release will also provide much improved support for code
+generation from schemas, and for binding+schema generation from code, and
+these features will be integrated into the Axis2 JiBX support. Check the <a
+href="http://www.jibx.org">JiBX project site</a> for updates on both JiBX 1.1
and the Axis2 JiBX support.</p>
-
<hr>
</body>
</html>
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=398937&r1=398936&r2=398937&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 06:32:27 2006
@@ -25,37 +25,50 @@
<p>As part of the Axis2 tool set, the service archive generator is an
important tool that allows the generation of service archives ("aar" file or
-a "jar" files) that can be deployed as a Web services to the Axis2. </p>
+a "jar" files) that can be deployed as a Web services to the Axis2.</p>
<a name="installation"></a>
<h2>Installation</h2>
<p>Download the binary version of the plug-in and extract the content of the
-zip file into the Eclipse installation folder. (The plug-in will actually go
-into the plugins directory in the Eclipse installation root). Restarting
-Eclipse will set the plug-in automatically.</p>
+zip file into the eclipse installation folder. (The plug-in will actually go
+into the plugins directory in the eclipse installation root). Restarting
+eclipse will set the plug-in automatically.</p>
<a name="operation"></a>
<h2>Operation</h2>
<p>If the plug-in is properly installed you should see a new wizard under the
-"New" section.(use the File -> New -> Other or Ctrl + N )</p>
+"New" section. (Use the File -> New -> Other or Ctrl + N )</p>
<p align="center"><img border="0" src="images/ServiceWizardSelection.jpg"></p>
-<p>Selecting the wizard and pressing the next button will start the service
-generator wizard. Following is the first wizard page.</p>
+<p>Selecting the wizard and pressing the Next button will start the service
+generator wizard. Following is the first page of the wizard.</p>
+
+<p><strong>Page 1:</strong></p>
<p align="center"><img border="0" src="images/ServicePage1.jpg"></p>
-<p>Once the class file folder is given (which should be a folder in the file
-system) the next button will be enabled. Page 2 of the wizard requires you to
-locate the wsdl file. Note that the WSDL file cannot be skipped in this
-version of the tool</p>
+<p>Once the class file folder (which should be a folder in the file system)
+is browsed and selected, the Next button will be enabled and you can move to
+the next page. Note that you have the option of either including all the
+files or the class files only of the folder on page 1.</p>
+
+<p><strong>Page 2:</strong></p>
+
+<p>Page 2 of the wizard as seen below requires you to locate/browse the wsdl
+file. Note that the WSDL file cannot be skipped in this version of the
+tool.</p>
<p align="center"><img border="0" src="images/service_page2.jpg"></p>
-<p align="center">Select the service.XML file in the next wizard page</p>
+<p><strong>Page 3:</strong></p>
+
+<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>
<p align="center"><img border="0" src="images/service_page3.jpg"></p>
<!--
@@ -79,6 +92,8 @@
-->
+<p><strong>Page 4:</strong></p>
+<!--START-->
<p>The next step is to add the libraries. The library addition page looks
like this</p>