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 2007/05/04 09:23:24 UTC
svn commit: r535120 - in /webservices/axis2/site/1_2: adb/adb-advanced.html
adb/adb-codegen-integration.html adb/adb-howto.html adb/adb-tweaking.html
mail-configuration.html mail-transport.html tcp-transport.html
transport_howto.html
Author: chatra
Date: Fri May 4 00:23:23 2007
New Revision: 535120
URL: http://svn.apache.org/viewvc?view=rev&rev=535120
Log:
made changes reflected in patches on https://issues.apache.org/jira/browse/AXIS2-2565 and https://issues.apache.org/jira/browse/AXIS2-2575
Modified:
webservices/axis2/site/1_2/adb/adb-advanced.html
webservices/axis2/site/1_2/adb/adb-codegen-integration.html
webservices/axis2/site/1_2/adb/adb-howto.html
webservices/axis2/site/1_2/adb/adb-tweaking.html
webservices/axis2/site/1_2/mail-configuration.html
webservices/axis2/site/1_2/mail-transport.html
webservices/axis2/site/1_2/tcp-transport.html
webservices/axis2/site/1_2/transport_howto.html
Modified: webservices/axis2/site/1_2/adb/adb-advanced.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/1_2/adb/adb-advanced.html?view=diff&rev=535120&r1=535119&r2=535120
==============================================================================
--- webservices/axis2/site/1_2/adb/adb-advanced.html (original)
+++ webservices/axis2/site/1_2/adb/adb-advanced.html Fri May 4 00:23:23 2007
@@ -28,14 +28,14 @@
<a href="http://www.apache.org" class="externalLink" title="External Link">Apache </a>
</div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuAxis2_Java"><h5>Axis2/Java</h5><ul><li class="none"><a href="../../index.html">Home</a></li></ul></div><div id="menuDownloads"><h5>Downloads</h5><ul><li class="none"><a href="../../download.cgi">Releases</a></li><li class="none"><a href="../../modules/index.html">Modules</a></li><li class="none"><a href="../../tools/index.html">Tools</a></li></ul></div><div id="menuDocumentation"><h5>Documentation</h5><ul><li class="expanded"><a href="../../1_2/contents.html">Version 1.2</a><ul><li class="none"><a href="../../1_2/toc.html">Table of Contents</a></li><li class="none"><a href="../../1_2/installationguide.html">Installation Guide</a></li><li class="none"><a href="../../1_2/quickstartguide.html">QuickStart Guide</a></li><li class="none"><a href="../../1_2/userguide.html">User Guide</a></li><li class="none"><a href="../../1_2/pojoguide.html">POJO Guide</a></li><li class="none"
><a href="../../1_2/spring.html">Spring Guide</a></li><li class="none"><a href="../../1_2/webadminguide.html">Web Administrator's Guide</a></li><li class="none"><a href="../../1_2/migration.html">Migration Guide (from Axis1)</a></li></ul></li><li class="none"><a href="../../1_1_1/contents.html">Version 1.1.1</a></li><li class="none"><a href="../../1_1/contents.html">Version 1.1</a></li><li class="none"><a href="../../1_0/index.html">Version 1.0</a></li><li class="none"><a href="../../0_95/index.html">Version 0.95</a></li><li class="none"><a href="../../0_94/index.html">Version 0.94</a></li><li class="none"><a href="../../0_93/index.html">Version 0.93</a></li></ul></div><div id="menuResources"><h5>Resources</h5><ul><li class="none"><a href="../../faq.html">FAQ</a></li><li class="none"><a href="../../articles.html">Articles</a></li><li class="none"><a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink" title="External Link">Wiki</a></li><li class="none"><a h
ref="../../refLib.html">Reference Library</a></li><li class="none"><a href="http://ws.apache.org/axis2/1_2/api/index.html" class="externalLink" title="External Link">Online Java Docs</a></li></ul></div><div id="menuGet_Involved"><h5>Get Involved</h5><ul><li class="none"><a href="../../overview.html">Overview</a></li><li class="none"><a href="../../svn.html">Checkout the Source</a></li><li class="none"><a href="../../mail-lists.html">Mailing Lists</a></li><li class="none"><a href="../../guidelines.html">Developer Guidelines</a></li><li class="none"><a href="../../siteHowTo.html">Build the Site</a></li></ul></div><div id="menuProject_Information"><h5>Project Information</h5><ul><li class="none"><a href="../../team-list.html">Project Team</a></li><li class="none"><a href="../../issue-tracking.html">Issue Tracking</a></li><li class="none"><a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink" title="External Link">Source Code</a
></li><li class="none"><a href="../../thanks.html">Acknowledgements</a></li><li class="none"><a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="External Link">License</a></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="../../images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><a name="Advanced_Axis2_Databinding_Framework_Features"></a><h2>Advanced Axis2 Databinding Framework Features</h2><p>The aim of this section is provide an insight into the newly added
-advanced features of Axis2 Databinding (ADB) Framework.</p><div class="subsection"><a name="Content"></a><h3>Content</h3><ul>
+advanced features of the Axis2 Databinding (ADB) Framework.</p><div class="subsection"><a name="Content"></a><h3>Content</h3><ul>
<li><a href="#typeSupport">xsi:type Support</a></li>
<li><a href="#helper">Helper Mode</a></li>
- <li><a href="#more">More Stuff on ADB?</a></li>
-</ul><p><a name="typeSupport"></a></p></div><div class="subsection"><a name="xsi:type_Support"></a><h3>xsi:type Support</h3><p>This is implemented by adding a extension maping class. The code that
+ <li><a href="#more">Additional ADB Topics</a></li>
+</ul><p><a name="typeSupport"></a></p></div><div class="subsection"><a name="xsi:type_Support"></a><h3>xsi:type Support</h3><p>This is implemented by adding a extension mapping class. The code that
calls the extension mapper is generated inside the Factory.parse method of
-the beans and gets active when the xsi:type attribute is present. The
-following code fragment shows how the generated type mapper looks like : </p>
+the beans and gets activated when the xsi:type attribute is present. The
+following code fragment shows what the generated type mapper looks like : </p>
<div class="source"><pre> public static java.lang.Object getTypeObject(java.lang.String namespaceURI,
java.lang.String typeName,
javax.xml.stream.XMLStreamReader reader) throws java.lang.Exception{
@@ -51,8 +51,8 @@
</pre></div>
<p>Inside every Factory.parse method, the extension mapper gets called when a
xsi:type attribute is encountered <strong>and</strong> that type is not the
-type that is being parsed.</p><p>The following code fragment shows how the ADB deserialize method calls the
-mapper class : </p>
+type that is currently being parsed.</p><p>The following code fragment shows how the ADB deserialize method calls the
+mapper class: </p>
<div class="source"><pre>
if (reader.getAttributeValue("http://www.w3.org/2001/XMLSchema-instance","type")!=null){
java.lang.String fullTypeName = reader.getAttributeValue("http://www.w3.org/2001/XMLSchema-instance",
@@ -73,9 +73,10 @@
}
</pre></div>
- <p>This should make the xsi:type based parsing possible and should
-result in proper xsi:type based serializations at runtime.</p><p>This is automatically done but the package name for the mapper class can
-be set as an CompilerOption.</p>
+ <p>This makes xsi:type based parsing possible and results
+in proper xsi:type based serializations at runtime.</p><p>By default, the mapping package is derived from the targetnamespace of the
+first schema that is encountered. The package name can also be explicitly set
+by a CompilerOption:</p>
<div class="source"><pre>
CompilerOptions compilerOptions = new CompilerOptions();
compilerOptions.setWriteOutput(true);
@@ -92,24 +93,24 @@
</pre></div>
- <p>When the mapping package is not specified it is derived from the
-targetnamespace of the first schema that is encountered.</p><p><a name="helper"></a></p></div><div class="subsection"><a name="Helper_mode"></a><h3>Helper mode</h3><p>Helper mode is a fairly new feature. In the helper mode, the beans are
+ <p><a name="helper"></a></p></div><div class="subsection"><a name="Helper_mode"></a><h3>Helper mode</h3><p>Helper mode is a fairly new feature. In the helper mode, the beans are
plain Java beans and all the deserialization/serialization code is moved to a
helper class. For example, the simple schema mentioned in the ADB-howto
-document will yield four classes for the two that has been previously seen.</p><ol>
+document will yield four classes instead of the two previously generated:</p><ol>
<li>MyElement.java</li>
<li>MyElementHelper.java</li>
<li>SOAPStruct.java</li>
<li>SOAPStructHelper.java</li>
-</ol><p>The helpers basically contain all the code that went into the ADBBeans.
-Hence the beans in the helper mode are pretty much readable than the rest.
-Also note that the helper mode is available only if you are in the unpacked
-mode. The code generator by default does not expand the classes.</p><p>Helper mode can be switched on by using the setHelperMode method
-in CompilerOptions : </p>
+</ol><p>The helpers basically contain all the serialization code that otherwise
+would go into the ADBBeans. Hence the beans in the helper mode are much
+more simplified. Also note that the helper mode is available only if you
+are in unpacked mode. The code generator by default does not expand
+the classes.</p><p>Helper mode can be switched on by using the setHelperMode method
+in CompilerOptions: </p>
<div class="source"><pre>
</pre></div>
- <p><a name="more"></a></p></div><div class="subsection"><a name="More_Stuff_on_ADB_"></a><h3>More Stuff on ADB?</h3><ul>
+ <p><a name="more"></a></p></div><div class="subsection"><a name="Additional_ADB_Topics"></a><h3>Additional ADB Topics</h3><ul>
<li><a href="adb-tweaking.html">Tweaking the ADB Code Generator</a>-
explains available mechanisms to extend ADB and possibly adopt it to
compile schemas to support other languages.</li>
Modified: webservices/axis2/site/1_2/adb/adb-codegen-integration.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/1_2/adb/adb-codegen-integration.html?view=diff&rev=535120&r1=535119&r2=535120
==============================================================================
--- webservices/axis2/site/1_2/adb/adb-codegen-integration.html (original)
+++ webservices/axis2/site/1_2/adb/adb-codegen-integration.html Fri May 4 00:23:23 2007
@@ -27,7 +27,7 @@
<a href="http://www.apache.org" class="externalLink" title="External Link">Apache </a>
- </div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuAxis2_Java"><h5>Axis2/Java</h5><ul><li class="none"><a href="../../index.html">Home</a></li></ul></div><div id="menuDownloads"><h5>Downloads</h5><ul><li class="none"><a href="../../download.cgi">Releases</a></li><li class="none"><a href="../../modules/index.html">Modules</a></li><li class="none"><a href="../../tools/index.html">Tools</a></li></ul></div><div id="menuDocumentation"><h5>Documentation</h5><ul><li class="expanded"><a href="../../1_2/contents.html">Version 1.2</a><ul><li class="none"><a href="../../1_2/toc.html">Table of Contents</a></li><li class="none"><a href="../../1_2/installationguide.html">Installation Guide</a></li><li class="none"><a href="../../1_2/quickstartguide.html">QuickStart Guide</a></li><li class="none"><a href="../../1_2/userguide.html">User Guide</a></li><li class="none"><a href="../../1_2/pojoguide.html">POJO Guide</a></li><li class="none"
><a href="../../1_2/spring.html">Spring Guide</a></li><li class="none"><a href="../../1_2/webadminguide.html">Web Administrator's Guide</a></li><li class="none"><a href="../../1_2/migration.html">Migration Guide (from Axis1)</a></li></ul></li><li class="none"><a href="../../1_1_1/contents.html">Version 1.1.1</a></li><li class="none"><a href="../../1_1/contents.html">Version 1.1</a></li><li class="none"><a href="../../1_0/index.html">Version 1.0</a></li><li class="none"><a href="../../0_95/index.html">Version 0.95</a></li><li class="none"><a href="../../0_94/index.html">Version 0.94</a></li><li class="none"><a href="../../0_93/index.html">Version 0.93</a></li></ul></div><div id="menuResources"><h5>Resources</h5><ul><li class="none"><a href="../../faq.html">FAQ</a></li><li class="none"><a href="../../articles.html">Articles</a></li><li class="none"><a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink" title="External Link">Wiki</a></li><li class="none"><a h
ref="../../refLib.html">Reference Library</a></li><li class="none"><a href="http://ws.apache.org/axis2/1_2/api/index.html" class="externalLink" title="External Link">Online Java Docs</a></li></ul></div><div id="menuGet_Involved"><h5>Get Involved</h5><ul><li class="none"><a href="../../overview.html">Overview</a></li><li class="none"><a href="../../svn.html">Checkout the Source</a></li><li class="none"><a href="../../mail-lists.html">Mailing Lists</a></li><li class="none"><a href="../../guidelines.html">Developer Guidelines</a></li><li class="none"><a href="../../siteHowTo.html">Build the Site</a></li></ul></div><div id="menuProject_Information"><h5>Project Information</h5><ul><li class="none"><a href="../../team-list.html">Project Team</a></li><li class="none"><a href="../../issue-tracking.html">Issue Tracking</a></li><li class="none"><a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink" title="External Link">Source Code</a
></li><li class="none"><a href="../../thanks.html">Acknowledgements</a></li><li class="none"><a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="External Link">License</a></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="../../images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><a name="ADB_Integration_With_Axis2"></a><h2>ADB Integration With Axis2</h2><p>This document will assist you to write an extension using the
+ </div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuAxis2_Java"><h5>Axis2/Java</h5><ul><li class="none"><a href="../../index.html">Home</a></li></ul></div><div id="menuDownloads"><h5>Downloads</h5><ul><li class="none"><a href="../../download.cgi">Releases</a></li><li class="none"><a href="../../modules/index.html">Modules</a></li><li class="none"><a href="../../tools/index.html">Tools</a></li></ul></div><div id="menuDocumentation"><h5>Documentation</h5><ul><li class="expanded"><a href="../../1_2/contents.html">Version 1.2</a><ul><li class="none"><a href="../../1_2/toc.html">Table of Contents</a></li><li class="none"><a href="../../1_2/installationguide.html">Installation Guide</a></li><li class="none"><a href="../../1_2/quickstartguide.html">QuickStart Guide</a></li><li class="none"><a href="../../1_2/userguide.html">User Guide</a></li><li class="none"><a href="../../1_2/pojoguide.html">POJO Guide</a></li><li class="none"
><a href="../../1_2/spring.html">Spring Guide</a></li><li class="none"><a href="../../1_2/webadminguide.html">Web Administrator's Guide</a></li><li class="none"><a href="../../1_2/migration.html">Migration Guide (from Axis1)</a></li></ul></li><li class="none"><a href="../../1_1_1/contents.html">Version 1.1.1</a></li><li class="none"><a href="../../1_1/contents.html">Version 1.1</a></li><li class="none"><a href="../../1_0/index.html">Version 1.0</a></li><li class="none"><a href="../../0_95/index.html">Version 0.95</a></li><li class="none"><a href="../../0_94/index.html">Version 0.94</a></li><li class="none"><a href="../../0_93/index.html">Version 0.93</a></li></ul></div><div id="menuResources"><h5>Resources</h5><ul><li class="none"><a href="../../faq.html">FAQ</a></li><li class="none"><a href="../../articles.html">Articles</a></li><li class="none"><a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink" title="External Link">Wiki</a></li><li class="none"><a h
ref="../../refLib.html">Reference Library</a></li><li class="none"><a href="http://ws.apache.org/axis2/1_2/api/index.html" class="externalLink" title="External Link">Online Java Docs</a></li></ul></div><div id="menuGet_Involved"><h5>Get Involved</h5><ul><li class="none"><a href="../../overview.html">Overview</a></li><li class="none"><a href="../../svn.html">Checkout the Source</a></li><li class="none"><a href="../../mail-lists.html">Mailing Lists</a></li><li class="none"><a href="../../guidelines.html">Developer Guidelines</a></li><li class="none"><a href="../../siteHowTo.html">Build the Site</a></li></ul></div><div id="menuProject_Information"><h5>Project Information</h5><ul><li class="none"><a href="../../team-list.html">Project Team</a></li><li class="none"><a href="../../issue-tracking.html">Issue Tracking</a></li><li class="none"><a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink" title="External Link">Source Code</a
></li><li class="none"><a href="../../thanks.html">Acknowledgements</a></li><li class="none"><a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="External Link">License</a></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="../../images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><a name="ADB_Integration_With_Axis2"></a><h2>ADB Integration With Axis2</h2><p>This document will assist you in writing an extension using the
integrator in order to integrate ADB with Axis2.</p><div class="subsection"><a name="Content"></a><h3>Content</h3><ul>
<li><a href="#intro">Introduction</a></li>
<li><a href="#select_modes">Selection of Generation Modes for
@@ -40,31 +40,30 @@
(<strong>org.apache.axis2.wsdl.codegen.extension.SimpleDBExtension</strong>)
and can be found in the extensions list of the
codegen-config.properties file.</p><p><a name="select_modes" id="select_modes"></a></p></div><div class="subsection"><a name="Selection_of_Generation_Modes_for_ADB"></a><h3>Selection of Generation Modes for ADB</h3><p>The extension sets the options for the code generator via the
-CompilerOptions, depending on the users settings. The following
-table summarizes the use of options. Please refer the <a href="adb-howto.html" class="newWindow" title="New Window" target="_blank">ADB-How to document</a> for the
+CompilerOptions, depending on the user's settings. The following
+table summarizes the use of options. Please refer to the <a href="adb-howto.html" class="newWindow" title="New Window" target="_blank">ADB-How to document</a> for the
different generation modes and their descriptions.</p><table class="bodyTable"><tbody>
<tr class="a"><td><strong>User parameters</strong></td><td><strong>Selected code generation parameters</strong></td></tr>
-<tr class="b"><td>None (no other parameter than the mandatory ones)</td><td>wrapClasses=false,writeClasses=false</td></tr>
+<tr class="b"><td>None (no parameter other than mandatory ones)</td><td>wrapClasses=false,writeClasses=false</td></tr>
<tr class="a"><td>-ss (server side)</td><td>wrapClasses=false,writeClasses=true</td></tr>
<tr class="b"><td>-u (unwrap classes)</td><td>wrapClasses=false,writeClasses=true</td></tr>
-</tbody></table><p>If the users want to override these settings manually, they need
-to use the following parameters in the command line (prefixed with
--E)</p><table class="bodyTable"><tbody>
+</tbody></table><p>The following parameters (prefixed with -E) can be used to
+override these settings manually:</p><table class="bodyTable"><tbody>
<tr class="a"><td><strong>Parameter Name</strong></td><td><strong>Allowed values</strong></td><td><strong>Description</strong></td></tr>
<tr class="b"><td>r</td><td>true, false</td><td>Sets the write flag. If set to true the classes will be written
by ADB</td></tr>
-<tr class="a"><td>w</td><td>true, false</td><td>Sets the packing flag. if true the classes will be packed.</td></tr>
-</tbody></table><p>Note that these parameters have no relevant long names and MUST
+<tr class="a"><td>w</td><td>true, false</td><td>Sets the wrapping flag. if true the classes will be wrapped.</td></tr>
+</tbody></table><p>Note that these parameters have no corresponding long names and MUST
be prefixed with a -E to be processed by the code generator. For
-example</p>
+example:</p>
<div class="source"><pre>
WSDL2Java .... -Er true
</pre></div>
<p><a name="remember" id="remember"></a></p></div><div class="subsection"><a name="Things_to_Remember"></a><h3>Things to Remember</h3><ol>
-<li>SimpleDBExtension is made to process requests only when the
-databinding framework is specified as ADB (using the switch -d adb
-). In the most recent release, the default has been set as ADB and
-hence if the -d option is missing then the databinding framework
-will be ADB.</li>
+<li>SimpleDBExtension is for the ADB databinding framework only and
+will process requests only when this framework is specified during
+code generation (using the switch -d adb). In the most recent
+release, the default has been set as ADB and hence if the -d option
+is missing then the databinding framework will be ADB.</li>
</ol></div></div><div class="section"></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2004-2007, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
Modified: webservices/axis2/site/1_2/adb/adb-howto.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/1_2/adb/adb-howto.html?view=diff&rev=535120&r1=535119&r2=535120
==============================================================================
--- webservices/axis2/site/1_2/adb/adb-howto.html (original)
+++ webservices/axis2/site/1_2/adb/adb-howto.html Fri May 4 00:23:23 2007
@@ -27,7 +27,7 @@
<a href="http://www.apache.org" class="externalLink" title="External Link">Apache </a>
- </div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuAxis2_Java"><h5>Axis2/Java</h5><ul><li class="none"><a href="../../index.html">Home</a></li></ul></div><div id="menuDownloads"><h5>Downloads</h5><ul><li class="none"><a href="../../download.cgi">Releases</a></li><li class="none"><a href="../../modules/index.html">Modules</a></li><li class="none"><a href="../../tools/index.html">Tools</a></li></ul></div><div id="menuDocumentation"><h5>Documentation</h5><ul><li class="expanded"><a href="../../1_2/contents.html">Version 1.2</a><ul><li class="none"><a href="../../1_2/toc.html">Table of Contents</a></li><li class="none"><a href="../../1_2/installationguide.html">Installation Guide</a></li><li class="none"><a href="../../1_2/quickstartguide.html">QuickStart Guide</a></li><li class="none"><a href="../../1_2/userguide.html">User Guide</a></li><li class="none"><a href="../../1_2/pojoguide.html">POJO Guide</a></li><li class="none"
><a href="../../1_2/spring.html">Spring Guide</a></li><li class="none"><a href="../../1_2/webadminguide.html">Web Administrator's Guide</a></li><li class="none"><a href="../../1_2/migration.html">Migration Guide (from Axis1)</a></li></ul></li><li class="none"><a href="../../1_1_1/contents.html">Version 1.1.1</a></li><li class="none"><a href="../../1_1/contents.html">Version 1.1</a></li><li class="none"><a href="../../1_0/index.html">Version 1.0</a></li><li class="none"><a href="../../0_95/index.html">Version 0.95</a></li><li class="none"><a href="../../0_94/index.html">Version 0.94</a></li><li class="none"><a href="../../0_93/index.html">Version 0.93</a></li></ul></div><div id="menuResources"><h5>Resources</h5><ul><li class="none"><a href="../../faq.html">FAQ</a></li><li class="none"><a href="../../articles.html">Articles</a></li><li class="none"><a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink" title="External Link">Wiki</a></li><li class="none"><a h
ref="../../refLib.html">Reference Library</a></li><li class="none"><a href="http://ws.apache.org/axis2/1_2/api/index.html" class="externalLink" title="External Link">Online Java Docs</a></li></ul></div><div id="menuGet_Involved"><h5>Get Involved</h5><ul><li class="none"><a href="../../overview.html">Overview</a></li><li class="none"><a href="../../svn.html">Checkout the Source</a></li><li class="none"><a href="../../mail-lists.html">Mailing Lists</a></li><li class="none"><a href="../../guidelines.html">Developer Guidelines</a></li><li class="none"><a href="../../siteHowTo.html">Build the Site</a></li></ul></div><div id="menuProject_Information"><h5>Project Information</h5><ul><li class="none"><a href="../../team-list.html">Project Team</a></li><li class="none"><a href="../../issue-tracking.html">Issue Tracking</a></li><li class="none"><a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink" title="External Link">Source Code</a
></li><li class="none"><a href="../../thanks.html">Acknowledgements</a></li><li class="none"><a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="External Link">License</a></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="../../images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><a name="Axis2_Databinding_Framework"></a><h2>Axis2 Databinding Framework</h2><p>This document aims to provide the architectural overview of the
+ </div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuAxis2_Java"><h5>Axis2/Java</h5><ul><li class="none"><a href="../../index.html">Home</a></li></ul></div><div id="menuDownloads"><h5>Downloads</h5><ul><li class="none"><a href="../../download.cgi">Releases</a></li><li class="none"><a href="../../modules/index.html">Modules</a></li><li class="none"><a href="../../tools/index.html">Tools</a></li></ul></div><div id="menuDocumentation"><h5>Documentation</h5><ul><li class="expanded"><a href="../../1_2/contents.html">Version 1.2</a><ul><li class="none"><a href="../../1_2/toc.html">Table of Contents</a></li><li class="none"><a href="../../1_2/installationguide.html">Installation Guide</a></li><li class="none"><a href="../../1_2/quickstartguide.html">QuickStart Guide</a></li><li class="none"><a href="../../1_2/userguide.html">User Guide</a></li><li class="none"><a href="../../1_2/pojoguide.html">POJO Guide</a></li><li class="none"
><a href="../../1_2/spring.html">Spring Guide</a></li><li class="none"><a href="../../1_2/webadminguide.html">Web Administrator's Guide</a></li><li class="none"><a href="../../1_2/migration.html">Migration Guide (from Axis1)</a></li></ul></li><li class="none"><a href="../../1_1_1/contents.html">Version 1.1.1</a></li><li class="none"><a href="../../1_1/contents.html">Version 1.1</a></li><li class="none"><a href="../../1_0/index.html">Version 1.0</a></li><li class="none"><a href="../../0_95/index.html">Version 0.95</a></li><li class="none"><a href="../../0_94/index.html">Version 0.94</a></li><li class="none"><a href="../../0_93/index.html">Version 0.93</a></li></ul></div><div id="menuResources"><h5>Resources</h5><ul><li class="none"><a href="../../faq.html">FAQ</a></li><li class="none"><a href="../../articles.html">Articles</a></li><li class="none"><a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink" title="External Link">Wiki</a></li><li class="none"><a h
ref="../../refLib.html">Reference Library</a></li><li class="none"><a href="http://ws.apache.org/axis2/1_2/api/index.html" class="externalLink" title="External Link">Online Java Docs</a></li></ul></div><div id="menuGet_Involved"><h5>Get Involved</h5><ul><li class="none"><a href="../../overview.html">Overview</a></li><li class="none"><a href="../../svn.html">Checkout the Source</a></li><li class="none"><a href="../../mail-lists.html">Mailing Lists</a></li><li class="none"><a href="../../guidelines.html">Developer Guidelines</a></li><li class="none"><a href="../../siteHowTo.html">Build the Site</a></li></ul></div><div id="menuProject_Information"><h5>Project Information</h5><ul><li class="none"><a href="../../team-list.html">Project Team</a></li><li class="none"><a href="../../issue-tracking.html">Issue Tracking</a></li><li class="none"><a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink" title="External Link">Source Code</a
></li><li class="none"><a href="../../thanks.html">Acknowledgements</a></li><li class="none"><a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="External Link">License</a></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="../../images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><a name="Axis2_Databinding_Framework"></a><h2>Axis2 Databinding Framework</h2><p>This document aims to provide an architectural overview of the
Axis2 Databinding Framework (referred to as ADB from here onwards)
and be a guide to anyone who wants to use and modify ADB. The
information is presented under the following topics.</p><div class="subsection"><a name="Content"></a><h3>Content</h3><ul>
@@ -50,41 +50,42 @@
<li><a href="#limitation">Known Limitations</a></li>
<li><a href="#more">Want to Learn More?</a></li>
</ul><p><a name="intro" id="intro"></a></p></div><div class="subsection"><a name="Introduction"></a><h3>Introduction</h3><p>The objective of the Axis2 Databinding framework is to provide a
-lightweight and simple schema compiler/ Java bean generator for
-Axis2. By no means it's to be a fully functional schema compiler
+lightweight and simple schema compiler/Java bean generator for
+Axis2. By no means is it intended to be a fully functional schema compiler
like XMLBeans. Note that ADB is written in a fashion that allows it
to be used as a stand-alone schema compiler and also to be extended
to generate code for other languages.</p><p><a name="archi" id="archi"></a></p></div><div class="subsection"><a name="Architectural_Overview"></a><h3>Architectural Overview</h3><p>ADB is built on a modular architecture that allows it to utilize
-a pre configured writer depending on the configuration.The 'big
+a pre-configured writer depending on the configuration. The 'big
block diagram' for the code generator architecture is depicted
-below</p><p><img src="images/ADB.jpg" alt="ADB architecture"></img></p><p>ADB utilizes the WS-commons XmlSchema library for reading the
-Schema. The object model for the schema comes in the form of an
+below.</p><p><img src="images/ADB.jpg" alt="ADB architecture"></img></p><p>ADB utilizes the WS-Commons <a href="http://ws.apache.org/commons/XmlSchema/index.html" class="externalLink" title="External Link">
+XmlSchema library</a> for reading the Schema. The object
+model for the schema comes in the form of an
XmlSchema object. The schema compiler keeps an instance of the
writer (in the default case it's the JavaBeanWriter) which actually
writes the classes. The writers may use whatever technique they
prefer, in the case of the JavaBeanWriter, it uses an XSLT
template. The SchemaCompiler also uses a typemapper object that
-tells it what classnames to be used for the QNames that it
+tells it what classnames to use for the QNames that it
encounters. This type mapper is also part of the configuration and
the users can override the default type mapper by overriding the
property setting.</p><p><a name="code_depend" id="code_depend"></a></p></div><div class="subsection"><a name="Code_and_Dependencies"></a><h3>Code and Dependencies</h3><p>As explained in the previous section, the schema compiler
depends on the WS-Commons XmlSchema library. The XSLT
-transformations are dependent on the JVM's DOMimplementation
-(either crimson or xerces) which means that the underlying JVM
+transformations are dependent on the JVM's DOM implementation
+(either Crimson or Xerces) which means that the underlying JVM
should be 1.4 or higher. Apart from that ADB has no dependencies on
any other special jar files. The code for the schema compiler is
completely in the <strong>org.apache.axis2.schema.*</strong>
package. This package resides in the codegen module of the Axis2
-source tree.</p><p>Following are the important classes and files:</p><ol>
+source tree.</p><p>The following are the important classes and files of ADB:</p><ol>
<li><strong>SchemaCompiler</strong> - The work horse that really
compiles the schema into classes.</li>
-<li><strong>BeanWriter</strong> - BeanWriter represents the kind of
-interface the SchemaCompiler accepts as a writer. The writer needs
-to handle the actual writing of the clasess</li>
+<li><strong>BeanWriter</strong> - BeanWriters handle the the actual
+rendering of the classes. BeanWriter is the interface that
+writers need to implement in order to be used by the SchemaCompiler. </li>
<li><strong>JavaBeanWriter</strong> - The default implementation of
the BeanWriter interface.</li>
<li><strong>TypeMap</strong> - represents the interface that the
-schema compiler looks towards to find classes</li>
+schema compiler uses to find class names for a given QName.</li>
<li><strong>JavaTypeMap</strong> - the default implementation of
the TypeMap</li>
<li><strong>ADBBeanTemplate.xsl</strong> - the XSLtemplate the
@@ -95,21 +96,21 @@
build for the Axis2 adb-codegen module. This will generate the
<strong>axis2-adb-codegen-{$version}.jar</strong> inside the target
folder which is directly usable when the ADB schema compiler is
-required.</p><p>The runtime dependancies for the ADB generated classes is in the
+required.</p><p>The runtime dependencies for the ADB generated classes is in the
Axis2 adb module and the kernal module. Hence to compile and work with the generated
classes the <strong>axis2-adb-{$version}.jar</strong> and <strong>axis2-kernal-{$version}.jar</strong> needs to be
-in the classpath apart from other dependancies like the StAX,
-Axiom,Commons-logging and javax.activation.</p><p><a name="code_gen" id="code_gen"></a></p></div><div class="subsection"><a name="Invoking_the_ADB_Code_Generator"></a><h3>Invoking the ADB Code Generator</h3><p><a name="schema_compiler"></a></p></div><div class="subsection"><a name="As_a_Standalone_Schema_Compiler"></a><h3>As a Standalone Schema Compiler</h3><p>ADB comes with a main class XSD2Java that allows the schemas to
-be compiled just by giving the schema file reference.This main
-class is pretty much primitive and does not provide much control
+in the classpath in addition to other dependencies such as StAX,
+Axiom, Commons-logging and javax.activation.</p><p><a name="code_gen" id="code_gen"></a></p></div><div class="subsection"><a name="Invoking_the_ADB_Code_Generator"></a><h3>Invoking the ADB Code Generator</h3><p><a name="schema_compiler"></a></p></div><div class="subsection"><a name="As_a_Standalone_Schema_Compiler"></a><h3>As a Standalone Schema Compiler</h3><p>ADB comes with a XSD2Java code generator that allows the schemas to
+be compiled just by giving the schema file reference. This main
+class is presently rather primitive and does not provide much control
over the code generation process. This is bound to improve in the
-near future.</p><p>Code generator accepts the following parameters</p><ol>
+near future.</p><p>XSD2Java accepts the following parameters:</p><ol>
<li>The Schema file name - This should be a complete file name
pointing to the local file system</li>
<li>The output folder name - This should be the name of a folder
within the local file system</li>
-</ol><p>Since the main class has no validations built in, the compiler
-is likely to cough up an unexpected error message if these
+</ol><p>Since the code generator presently has no validations built into it, the compiler
+is likely to show various error messages if these
parameters are not supplied properly.</p><p><a name="api" id="api"></a></p></div><div class="subsection"><a name="Through_the_API"></a><h3>Through the API</h3><p>This is the only way to harness the full potential of the schema
compiler. The current Axis2 integration of ADB happens through this
API. The most important classes and methods of the Schema compiler
@@ -119,7 +120,7 @@
object. This compilerOptions object is more of a holder for the
parameters that are passed to the SchemaCompiler. The only
mandatory parameter in the CompilerOptions is the output
-directory</p>
+directory.</p>
</li>
<li><strong>SchemaCompiler - Compile(XMLSchema schema)</strong>
<p>The compile method to call for a single schema. The expected
@@ -133,20 +134,21 @@
through the API, the following classes would be helpful. One would
also need an understanding of the generation modes of the ADB
schema compiler when using it through the API. Hence the following
-section includes a brief description of the generation modes .</p><ul>
+section includes a brief description of the generation modes.</p><ul>
<li><strong>org.apache.axis2.schema.XSD2Java</strong></li>
<li><strong>org.apache.axis2.schema.ExtensionUtility</strong></li>
</ul><p><a name="gen_modes" id="gen_modes"></a></p></div><div class="subsection"><a name="Generation_Modes"></a><h3>Generation Modes</h3><p>ADB extension provides several generation modes for the data
bound classes.</p><ol>
<li><strong>Integrated Mode</strong>
<p>In this mode the classes are generated as inner classes of the
-stub, message receiver or the interface. The ADB framework refrains
-from writing the classes but provides a map of DOM document objects
-that contains the model for the databinding class. The implementers
-are free to use the models for their needs. The Axis2 codegen
-engine parses these documents within its own XSLT parser to create
-the necessary code.</p>
-<p>Integrated mode is supposed to be used by the tool builders.</p>
+stub, message receiver or the interface. The ADB framework does
+not actually write the classes but instead provides a map of DOM
+document objects that contains the model for the databinding classes.
+The Axis2 codegen engine in turn parses these documents within
+its own XSLT parser to create the necessary classes.
+Implementers are free to use these models differently for their own particular needs.
+</p>
+<p>Integrated mode is intended to be used by tool builders.</p>
</li>
<li><strong>Wrapped Mode</strong>
<p>In the wrapped mode, the ADB databinder generates one class that
@@ -154,7 +156,7 @@
number of classes need to be limited.</p>
</li>
<li><strong>Expanded Mode</strong>
-<p>This is the usual mode where the codegenerator generates a class
+<p>This is the usual mode where the code generator generates a class
for each of the outer elements and the named complex types. The
command line tool (XSD2Java) always generates code in the expanded
mode.</p>
@@ -162,7 +164,7 @@
</ol><p>The rules for generating code (described in the next section)
applies regardless of the mode. Switching these modes can be done
by passing the correct options via the CompilerOptions object. The
-following is table lists the options and the consequences of using
+following table lists the options and the effects of using
them.</p><table class="bodyTable"><tbody>
<tr class="b"><td><strong>Field Name in Options</strong></td><td><strong>Description</strong></td></tr>
<tr class="a"><td>writeOutput</td><td>This determines whether to write the output or not. If the flag
@@ -172,26 +174,26 @@
flag is on then a single class (with adb added to the end of the
specified package) will be generated. The default is off.</td></tr>
<tr class="a"><td>mapperClassPackage</td><td>The package name for the mapper class. Please see the advanced
-section for details of the mapper class</td></tr>
+section for details of the mapper class.</td></tr>
<tr class="b"><td>helperMode</td><td>The switch that determines whether to switch to helper mode or
-not. Please see the advanced section for details of the helper
-mode</td></tr>
+not. Please see the advanced section for details of helper
+mode.</td></tr>
<tr class="a"><td>ns2PackageMap</td><td>A map that stores the namespace name against the package name
These details are used to override the default packages</td></tr>
</tbody></table><p><a name="deep" id="deep"></a></p></div><div class="subsection"><a name="Deep_into_Generated_Code"></a><h3>Deep into Generated Code</h3><p>When the schema compiler is invoked (one-way or another) it
-generates code depending on the following rules</p><ol>
+generates code depending on the following rules:</p><ol>
<li>All named complex types become bean classes. Any attribute or
element encapsulated in this complex type will become a field in
the generated class. Note that the support for constructs other
-than the sequence and all is not yet implemented.</li>
+than xsd:sequence and xsd:all is not yet implemented.</li>
<li>All top level elements become classes. This is a rather
-questioning feature since unless classes are generated for the top
-level elements the handling of elements become difficult and
+obvious feature since unless classes are generated for the top
+level elements the handling of elements becomes difficult and
messy!</li>
<li>SimpleType restrictions are handled by replacing the relevant
type with the basetype</li>
</ol><p>Once the code is generated according to the rules it looks like
-the following. Consider the following piece of schema</p>
+the following. Consider the following schema:</p>
<div class="source"><pre>
<schema xmlns="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:tns="http://soapinterop.org/types" targetNamespace="http://soapinterop.org/types"
@@ -211,9 +213,9 @@
<p>For comprehension let us consider the expanded mode for the code
generator. Unless specifically mentioned, the rest of this document
assumes that the expanded mode of the code generation is used. This
-particular schema generates the following two classes in the
+particular schema will generate the following two classes in the
designated package, which in this case would be
-<strong>org.soapinterop.types</strong>. This package is derived
+<strong>org.soapinterop.types</strong>. The package name is derived
from the target namespace of the schema.</p><ol>
<li>MyElement.java</li>
<li>SOAPStruct.java</li>
@@ -223,9 +225,9 @@
varString, varInt and varFloat which are String, int and float
respectively. MyElement on the other hand has a single field
representing the SOAPStruct object that it encapsulates.</p><p>The most important aspect of the generated code is that it
-encapsulates two methods for creation and serializing the beans.
+encapsulates two methods for creating and serializing the beans.
Note that to make this work, the generated beans implement the
-<strong>org.apache.axis2.databinding.ADBBean</strong> interface</p><p>The creator and serializer methods look like the following</p><ul>
+<strong>org.apache.axis2.databinding.ADBBean</strong> interface</p><p>The creator and serializer methods look like the following:</p><ul>
<li>
<pre>
public javax.xml.stream.XMLStreamReader
@@ -237,12 +239,12 @@
<ol>
<li>An element based bean class (like MyElement.java in the
example) will <strong><em>ignore the passed in QName</em></strong>.
-Instead of using the passed in QName it'll utilize it's own QName
+Instead of using the passed in QName it'll utilize its own QName
which is embedded in the class under the constant MY_QNAME, during
-the code generation. Hence it is usual to call getPullparser with a
-null for the elements.</li>
-<li>A ComplexType based bean class(like SOAPStruct.java in the
-example) will use the passed in QName to return an instance of the
+the code generation. Hence it is usual to call getPullparser() with a
+null parameter for elements.</li>
+<li>A ComplexType based bean class (like SOAPStruct.java in the
+example) will use the passed-in QName to return an instance of the
ADBpullparser. This will effectively wrap the elements inside with
an element having the passed QName</li>
</ol>
@@ -256,11 +258,10 @@
</pre>
<p>This method returns an OMElement representing the ADB bean object.</p>
<ol>
-<li>There is an annonymous ADBDataSource class has implemented, in side the getOMElement method.
-This annonymous class implements the serialize method where the serializing logic is written,
-for that pirticular bean class. Fianlly an OMSourcedElementImpl object with the
-above annonymous class type object as the data source, is
-returned.
+<li>Inside the getOMElement method an anonymous ADBDataSource class is created.
+This anonymous class implements a serialize() method where the serialization logic for that
+particular bean class is handled. Finally an OMSourcedElementImpl object with the
+above anonymous class type object as the data source is returned.
</li>
</ol>
</li>
@@ -283,9 +284,9 @@
throws java.lang.Exception
</pre>
<p>Also note that the above parse method is available in the
-<strong>Factory</strong> class generated into the relevant top
-level class.Hence one will have to get the static Factory instance
-before calling the parse methods</p>
+<strong>Factory</strong> nested class within the relevant top
+level class. Hence one will have to get the static Factory instance
+before calling the parse method.</p>
</li>
</ul><p><a name="example" id="example"></a></p></div><div class="subsection"><a name="An_Example_"></a><h3>An Example!</h3><p>Consider the following XML fragment</p>
<div class="source"><pre>
@@ -297,9 +298,9 @@
</pre></div>
<p>Enthusiastic readers might already have figured out that this
-piece of XML complies to the Schema mentioned above. The following
-piece of code shows how to build a populated instance of MyElement
-with this fragment of XML</p>
+XML fragment complies with the Schema mentioned above. The following
+code snippet shows how to build a populated instance of MyElement
+with the XML above:</p>
<div class="source"><pre>
XMLStreamReader reader = XMLInputFactory.newInstance().
createXMLStreamReader(
@@ -308,8 +309,8 @@
</pre></div>
<p>
-Optionally above xml fragment can be reproduced with the following
-code fragment
+Optionally, the above xml fragment can be reproduced with the following
+code fragment:
</p><p>
<pre>
OMElement omElement = myElement.getOMElement
@@ -317,8 +318,8 @@
String xmlString = omElement.toStringWithConsume();
</pre>
</p><p>Although this example takes on the tedious effort of creating a
-reader out of the String, inside the Axis2 environment an
-XMLStreamReader can be direclty asked from the OMElement! Hence, the
+reader out of a String, inside the Axis2 environment an
+XMLStreamReader can be directly obtained from the OMElement! Hence, the
parse method becomes a huge advantage for hassle free object
creation.</p><p>Similarly the reader obtained from the object can also be
utilized as needed. The following code fragment shows how to
@@ -331,12 +332,12 @@
<p>That's all to it! If you are interested in learning more on ADB
the following documents may also be helpful. However, be sure to
check the limitations section that follows if you are planning to
-use ADB for something serious.</p><p><a name="limitation" id="limitation"></a></p></div><div class="subsection"><a name="Known_Limitations"></a><h3>Known Limitations</h3><p>ADB is meant to be a 'Simple' databinding framework and was not meant to compile all types of schemas. The following limitations
-are the most highlighted.</p><ol>
-<li>Complex Extensions and Restrictions.</li>
+use ADB for something serious.</p><p><a name="limitation" id="limitation"></a></p></div><div class="subsection"><a name="Known_Limitations"></a><h3>Known Limitations</h3><p>ADB is meant to be a 'Simple' databinding framework and was not meant to compile all types of schemas.
+The following limitations are the most highlighted.</p><ol>
+<li>Complex Type Extensions and Restrictions.</li>
</ol><p><a name="more" id="more"></a></p></div><div class="subsection"><a name="Want_to_Learn_More_"></a><h3>Want to Learn More?</h3><ul>
<li><a href="adb-advanced.html">Advanced features of the ADB code
-generator</a> - explains xsi:type based desrialization and helper
+generator</a> - explains xsi:type based deserialization and helper
mode</li>
<li><a href="adb-tweaking.html">Tweaking the ADB Code
Generator</a> - explains available mechanisms to extend ADB and
Modified: webservices/axis2/site/1_2/adb/adb-tweaking.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/1_2/adb/adb-tweaking.html?view=diff&rev=535120&r1=535119&r2=535120
==============================================================================
--- webservices/axis2/site/1_2/adb/adb-tweaking.html (original)
+++ webservices/axis2/site/1_2/adb/adb-tweaking.html Fri May 4 00:23:23 2007
@@ -36,8 +36,8 @@
Beans</a></li>
<li><a href="#advanced_tweak">A More Advanced Tweak - Generate Code
for Another Language</a></li>
-</ul><p><a name="intro" id="intro"></a></p></div><div class="subsection"><a name="Introduction"></a><h3>Introduction</h3><p>ADB is written with future extensions in mind, with a clear and
-flexible way to extend or modify it's functionality. Available
+</ul><p><a name="intro" id="intro"></a></p></div><div class="subsection"><a name="Introduction"></a><h3>Introduction</h3><p>ADB was written with future extensibility in mind, with a clear and
+flexible way to extend or modify its functionality. Available
mechanisms to extend ADB and possibly adopt it to compile schemas
to support other languages are described below.</p><p><a name="config" id="config"></a></p></div><div class="subsection"><a name="Know_the_Configuration"></a><h3>Know the Configuration</h3><p>The configuration for the ADB framework is in the
<strong>schema-compile.properties</strong> file found in the
@@ -54,7 +54,7 @@
<p>This specifies the template to be used in the BeanWriter. The
BeanWriter author is free to use any mechanism to write the classes
but the default mechanism is to use a xsl template. This property
-may be left blank if the BeanWriter implementation does not require
+may be left blank if the BeanWriter implementation does not use
a template.</p>
</li>
<li>schema.bean.typemap
@@ -67,7 +67,7 @@
</ul><p><a name="first_tweak" id="first_tweak"></a></p></div><div class="subsection"><a name="The_First_Tweak_-_Generate_Plain_Java_Beans"></a><h3>The First Tweak - Generate Plain Java Beans</h3><p>The first, most simple tweak for the code generator could be to
switch to plain bean generation. The default behavior of the ADB
framework is to generate ADBBeans, but most users, if they want to
-use ADB as a standalone compiler, would love to have plain java
+use ADB as a standalone compiler, would prefer to have plain java
beans. This can in fact be done by simply changing the template
used.</p><p>The template for plain java beans is already available in the
<strong>org.apache.axis2.schema.template</strong> package. To make
@@ -81,13 +81,13 @@
in the source tree under the Other directory in the codegen module.
Advanced users with knowledge of XSLT can easily modify the
templates to generate code in their own formats.</p><p><a name="advanced_tweak" id="advanced_tweak"></a></p></div><div class="subsection"><a name="A_More_Advanced_Tweak_-_Generate_Code_for_Another_Language"></a><h3>A More Advanced Tweak - Generate Code for Another Language</h3><p>To generate code for another language, there are two main
-components to be written.</p><ul>
+components that need to be written.</p><ul>
<li>The BeanWriter
<p>Implement the BeanWriter interface for this class. A nice
example is the
<strong>org.apache.axis2.schema.writer.JavaBeanWriter</strong>
-which has a lot of reusable code. In fact if the language is OOP
-based (such as C# or even C++), one would even be able to extend
+which has a lot of reusable code. In fact if the target language
+is object-oriented (such as C# or even C++), one would even be able to extend
the JavaBeanWriter itself.</p>
</li>
<li>The TypeMap
@@ -98,11 +98,11 @@
fairly sufficient and only the type names would need to change to
support another language.</p>
</li>
-</ul><p>Surprisingly, this is enough to have other language support for
+</ul><p>Surprisingly, this is all that needs to be done to have other language support for
ADB. Change the configuration and you are ready to generate code
for other languages!</p><p>This tweaking guide is supposed to be a simple guideline for
anyone who wishes to dig deep into the mechanics of the ADB code
-generator. Users are free experiment with it and modify the schema
+generator. Users are free to experiment with it and modify the schema
compiler accordingly to their needs. Also note that the intention
of this section is <em>not</em> to be a step by step guide to
custom code generation. Anyone who wish to do so would need to dig
Modified: webservices/axis2/site/1_2/mail-configuration.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/1_2/mail-configuration.html?view=diff&rev=535120&r1=535119&r2=535120
==============================================================================
--- webservices/axis2/site/1_2/mail-configuration.html (original)
+++ webservices/axis2/site/1_2/mail-configuration.html Fri May 4 00:23:23 2007
@@ -148,7 +148,7 @@
servicClient.sendRobust(payload);</pre>
</pre></div>
- <p><a name="james"></a></p></div><div class="subsection"><a name="Configure_James_as_SMTP_and_POP_Server"></a><h3>Configure James as SMTP and POP Server</h3><p>Download the <a href="http://james.apache.org/" class="externalLink" title="External Link">Apache James</a> and start
+ <p><a name="james"></a></p></div><div class="subsection"><a name="Configure_James_as_SMTP_and_POP_Server"></a><h3>Configure James as SMTP and POP Server</h3><p>Download <a href="http://james.apache.org/" class="externalLink" title="External Link">Apache James</a> and start
James. Connect to the James server via Telnet as administrator James using
the following code:</p>
<div class="source"><pre><pre>$telnet 127.0.0.1 4555
@@ -171,7 +171,7 @@
Connection closed by foreign host.</pre>
</pre></div>
<p>Now James is up and running with the accounts.</p><p><a name="included"></a></p></div><div class="subsection"><a name="Using_the_Included_Mail_Server"></a><h3>Using the Included Mail Server</h3><p>The inbuilt mail server can be started from the command line using the
-following piece of code when all the necessary JARS are in the class path.</p>
+following command when all the necessary JARS are in the class path.</p>
<div class="source"><pre><pre>java org.apache.axis2.transport.mail.server.MailServer</pre>
</pre></div>
<p>The server itself does not need any configuration or tinkering to work. A
Modified: webservices/axis2/site/1_2/mail-transport.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/1_2/mail-transport.html?view=diff&rev=535120&r1=535119&r2=535120
==============================================================================
--- webservices/axis2/site/1_2/mail-transport.html (original)
+++ webservices/axis2/site/1_2/mail-transport.html Fri May 4 00:23:23 2007
@@ -1,4 +1,4 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Axis2/Java - Invoking a service using a mail</title><style type="text/css" media="all">
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Axis2/Java - Invoking a service using mail</title><style type="text/css" media="all">
@import url("../style/maven-base.css");
@import url("../style/maven-theme.css");</style><link rel="stylesheet" href="../style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta></head><body class="composite"><div id="banner"><a href="http://www.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src="http://www.apache.org/images/asf-logo.gif"></img></a><a href="http://ws.apache.org/axis2/" id="projectLogo"><img alt="Apache Axis2" src="http://ws.apache.org/axis2/images/axis.jpg"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">
@@ -46,7 +46,7 @@
updates. It is a lot like the way old businesses worked, but with a modern
touch. Similarly, the Axis2 mail transport can be used to implement
asynchronous messaging through mail.</p><p><a name="intro"></a></p></div><div class="subsection"><a name="Introduction"></a><h3>Introduction</h3><p>First, you need to go through the <a href="mail-configuration.html" class="newWindow" title="New Window" target="_blank">Mail Transport Configuration</a> document. It provides first
-hand experience in setting up the mail transports to co-exist with Axis2.</p><p>Broadly speaking, there are three ways of calling a service through
+hand experience in setting up the mail transports to operate with Axis2.</p><p>Broadly speaking, there are three ways of calling a service through
mail.</p><blockquote>
1. Using the simple mail server included in Axis2 (not recommended in
production).<br></br>
@@ -70,7 +70,7 @@
<div class="source"><pre><pre> // Start the mail server using the default configurations.
ConfigurationContext configContext = UtilsMailServer.start();
- // Start the default mail listener. It will starting poling for mail
+ // Start the default mail listener. It will starting polling for mail
// using the configuration from the XML file.
SimpleMailListener ml = new SimpleMailListener();
ml.init(configContext,
@@ -149,7 +149,7 @@
</pre></div>
<p>This will call the service that was setup on the server, and will poll the
mail server until the response is received. Please note that the serviceName
-and operationName need to be QNames.</p><p><a name="generic"></a></p></div><div class="subsection"><a name="2__Using_a_Generic_Mail_Server"></a><h3>2. Using a Generic Mail Server</h3><p>First you need two email accounts that work with POP/SMTP. One will act as
+and operationName need to be QNames.</p><p><a name="generic"></a></p></div><div class="subsection"><a name="2__Using_a_Generic_Mail_Server"></a><h3>2. Using a Generic Mail Server</h3><p>First you will need two email accounts that work with POP/SMTP. One will act as
a server and the other will act as the client. For the time being, we will
use server@somewhere.org and client@somewhere.org as the server and the
client email addresses. Now that we have the email addresses, you will have
Modified: webservices/axis2/site/1_2/tcp-transport.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/1_2/tcp-transport.html?view=diff&rev=535120&r1=535119&r2=535120
==============================================================================
--- webservices/axis2/site/1_2/tcp-transport.html (original)
+++ webservices/axis2/site/1_2/tcp-transport.html Fri May 4 00:23:23 2007
@@ -31,15 +31,16 @@
This document explains how to send and receive SOAP messages via TCP in Axis2.
</p><p><i>Send your feedback or questions to: <a href="mailto:axis-dev@ws.apache.org?subject=[Axis2]">axis-dev@ws.apache.org</a></i>.
-Prefix subject with [Axis2]. Subscription details are available on the <a href="http://ws.apache.org/axis2/mail-lists.html" class="externalLink" title="External Link">Axis2 site</a>. <a href="http://ws.apache.org/axis2/mail-lists.html" class="externalLink" title="External Link"></a></p><div class="subsection"><a name="Content"></a><h3>Content</h3><ul>
+Prefix subject with [Axis2]. Subscription details are available on the <a href="http://ws.apache.org/axis2/mail-lists.html" class="externalLink" title="External Link">Axis2 site</a>.
+</p><div class="subsection"><a name="Content"></a><h3>Content</h3><ul>
<li><a href="#intro">Introduction</a></li>
<li><a href="#start">How to Start the TCPServer</a></li>
<li><a href="#send">How to Send SOAP Messages Using TCP Transport</a></li>
<li><a href="#samples">Samples</a></li>
<li><a href="#components">Transport Components</a></li>
-</ul><p><a name="intro"></a></p></div><div class="subsection"><a name="Introduction"></a><h3>Introduction</h3><p>Axis2 supports TCP as a transport. It supports both send and receive SOAP
+</ul><p><a name="intro"></a></p></div><div class="subsection"><a name="Introduction"></a><h3>Introduction</h3><p>Axis2 supports TCP as a transport. It supports both sending and receiving SOAP
messages via TCP. A TCP transport does not have any application level headers
-and the SOAP message that is sent should be self contained. This makes the
+and the SOAP message that is sent should be self-contained. This makes the
interaction fast and simple. However, since there are no application headers,
it does not have the privilege of having a request URI, and Service
dispatching should be done by an alternative method. Thus,
@@ -53,9 +54,9 @@
either Addressing or the SOAP body base mechanism.</p><p><a name="start"></a></p></div><div class="subsection"><a name="How_to_Start_the_TCPServer"></a><h3>How to Start the TCPServer</h3><p>The TCP server can be started by running the class
org.apache.axis2.transport.tcp.TCPServer with two parameters - <a href="../faq.html#c5">repository</a> and port number, as arguments. This
class needs all the Axis dependency JARs in the classpath. New services can
-be added in the usual way by dropping the archives to the repository (See <a href="adv-userguide.html">Advance User's Guide</a> for more information)</p><p>
+be added in the usual way by dropping the archives to the repository (See <a href="adv-userguide.html">Advanced User's Guide</a> for more information)</p><p>
<a name="send"></a></p></div><div class="subsection"><a name="How_to_Send_SOAP_Messages_Using_TCP_Transport"></a><h3>How to Send SOAP Messages Using TCP Transport</h3><p>TCP transport can be enabled easily from the call API. The following code
-segment demonstrates how it can be done.</p>
+segment demonstrates how this can be done.</p>
<div class="source"><pre><pre>OMElement payload = ...
ServiceClient serviceClient = new ServiceClient();
Options options = new Options();
@@ -84,10 +85,8 @@
AXIS2_HOME/lib directory.</p><p><a name="components"></a></p></div><div class="subsection"><a name="Transport_Components"></a><h3>Transport Components</h3><p>The Axis2 TCP transport has two components, a transport Listener for
receiving the messages and a transport Sender to send the SOAP Messages. The
Axis2 installation has both the components built into itself by default. In
-the axis2.xml configuration file, the two TCP transport components would look
-as follows.</p><p>If the TCP server is started manually, this configuration does not take
-effect. In return, this affects the transport Listener's start by Axis2.
-(e.g. Listener started by the Complete Async interaction)</p><p>The following XML lines initialize the TCPTransport Receiver:</p>
+the axis2.xml configuration file, the two TCP transport components can be
+configured as shown below.</p><p>The following XML lines initialize the TCPTransport Receiver:</p>
<div class="source"><pre><pre><transportReceiver name="tcp" class="org.apache.axis2.transport.tcp.TCPServer">
<parameter name="port" locked="false">6060</parameter>
</transportReceiver></pre>
@@ -95,4 +94,6 @@
<p>The following XML lines add the TCPTransport Sender:</p>
<div class="source"><pre><pre><transportSender name="tcp" class="org.apache.axis2.transport.tcp.TCPTransportSender"/></pre>
</pre></div>
- </div></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2004-2007, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
+ <p>Note: If the TCP server is started manually, this configuration does not take
+effect. In return, this affects the transport Listener's start by Axis2.
+(e.g. Listener started by the Complete Async interaction)</p></div></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2004-2007, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
Modified: webservices/axis2/site/1_2/transport_howto.html
URL: http://svn.apache.org/viewvc/webservices/axis2/site/1_2/transport_howto.html?view=diff&rev=535120&r1=535119&r2=535120
==============================================================================
--- webservices/axis2/site/1_2/transport_howto.html (original)
+++ webservices/axis2/site/1_2/transport_howto.html Fri May 4 00:23:23 2007
@@ -30,7 +30,7 @@
</div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuAxis2_Java"><h5>Axis2/Java</h5><ul><li class="none"><a href="../index.html">Home</a></li></ul></div><div id="menuDownloads"><h5>Downloads</h5><ul><li class="none"><a href="../download.cgi">Releases</a></li><li class="none"><a href="../modules/index.html">Modules</a></li><li class="none"><a href="../tools/index.html">Tools</a></li></ul></div><div id="menuDocumentation"><h5>Documentation</h5><ul><li class="expanded"><a href="../1_2/contents.html">Version 1.2</a><ul><li class="none"><a href="../1_2/toc.html">Table of Contents</a></li><li class="none"><a href="../1_2/installationguide.html">Installation Guide</a></li><li class="none"><a href="../1_2/quickstartguide.html">QuickStart Guide</a></li><li class="none"><a href="../1_2/userguide.html">User Guide</a></li><li class="none"><a href="../1_2/pojoguide.html">POJO Guide</a></li><li class="none"><a href="../1_2/spring.html">
Spring Guide</a></li><li class="none"><a href="../1_2/webadminguide.html">Web Administrator's Guide</a></li><li class="none"><a href="../1_2/migration.html">Migration Guide (from Axis1)</a></li></ul></li><li class="none"><a href="../1_1_1/contents.html">Version 1.1.1</a></li><li class="none"><a href="../1_1/contents.html">Version 1.1</a></li><li class="none"><a href="../1_0/index.html">Version 1.0</a></li><li class="none"><a href="../0_95/index.html">Version 0.95</a></li><li class="none"><a href="../0_94/index.html">Version 0.94</a></li><li class="none"><a href="../0_93/index.html">Version 0.93</a></li></ul></div><div id="menuResources"><h5>Resources</h5><ul><li class="none"><a href="../faq.html">FAQ</a></li><li class="none"><a href="../articles.html">Articles</a></li><li class="none"><a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink" title="External Link">Wiki</a></li><li class="none"><a href="../refLib.html">Reference Library</a></li><li class="none"
><a href="http://ws.apache.org/axis2/1_2/api/index.html" class="externalLink" title="External Link">Online Java Docs</a></li></ul></div><div id="menuGet_Involved"><h5>Get Involved</h5><ul><li class="none"><a href="../overview.html">Overview</a></li><li class="none"><a href="../svn.html">Checkout the Source</a></li><li class="none"><a href="../mail-lists.html">Mailing Lists</a></li><li class="none"><a href="../guidelines.html">Developer Guidelines</a></li><li class="none"><a href="../siteHowTo.html">Build the Site</a></li></ul></div><div id="menuProject_Information"><h5>Project Information</h5><ul><li class="none"><a href="../team-list.html">Project Team</a></li><li class="none"><a href="../issue-tracking.html">Issue Tracking</a></li><li class="none"><a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/?root=Apache-SVN" class="externalLink" title="External Link">Source Code</a></li><li class="none"><a href="../thanks.html">Acknowledgements</a></li><li class="non
e"><a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink" title="External Link">License</a></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="../images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><a name="How_to_Write_Your_Own_Axis2_Transport"></a><h2>How to Write Your Own Axis2 Transport</h2><div class="subsection"><a name="Prologue"></a><h3>Prologue</h3><p>To stop you from re-inventing the wheel, before we get started, I will
quickly list the transports that are already supported in Axis2 with a small
description.</p><p></p><ul>
- <li><b>HTTP</b> - In the HTTP transport, the transport Listener is a
+ <li><b>HTTP</b> - In the HTTP transport, the transport Listener is either a
Servlet or a Simple HTTP server provided by Axis2. The transport Sender
uses sockets to connect and send the SOAP message. Currently we have the
commons-httpclient based HTTP Transport sender as the default
@@ -48,19 +48,18 @@
core of Axis2 is transport independent. All data that is transport specific
is stripped out of the incoming message and inserted into the MessageContext.
In the outgoing message, all transport specific information, like headers,
-are added and sent.</p><p>To write your own transport, you will need to primarily write two classes:
+are added and sent.</p><p>To write your own transport, you will primarily need to write two classes:
one is the TransportSender and the other is the TransportReceiver. To
-register a transport with Axis2 you will need to put two entries in the
-axis2.xml file. One for the transport receiver and the other for the
-transport sender. I will take you through the process of adding the entries
-in the relevent sections.</p></div><div class="subsection"><a name="Transport_Receiver"></a><h3>Transport Receiver</h3><p>Any message that is coming into Axis2 needs to go through a transport
+register a transport with Axis2 you will need to put entries corresponding
+to these two classes in the axis2.xml file. I will take you through the
+process of adding the entries in the relevant sections.</p></div><div class="subsection"><a name="Transport_Receiver"></a><h3>Transport Receiver</h3><p>Any message that is coming into Axis2 needs to go through a transport
receiver. All information about how the message is received at the Axis2
-server from the wire (or via an e-mail ) is isolated inside the transport
+server from the wire (or via an e-mail) is isolated inside the transport
receiver. It extracts the data that is coming on the wire and transforms it
into a state that the Axis2 server understands.</p><p>So now that we have some background information about how transports work
inside Axis2, without further delay, lets dive into some coding and start
building our own transport.</p><p></p><p>To get things stared, you will first need to extend from the
-org.apache.Axis2.transport.TransportListener class and write you own
+org.apache.Axis2.transport.TransportListener class and write your own
transport listener. To create an engine to process the MessageContext, we
need a configuration context. The following code fragment will do this. This
should ideally be only done once for the lifetime of the Transport
@@ -158,12 +157,12 @@
</pre></div>
<p>By using a code fragment like
<code>Utils.getParameterValue(transportOut.getParameter(MailSrvConstants.SMTP_USER))</code>
-we can extract the parameters that we insert into the axis2.xml file.</p><p>As you can see, getting a new transport receiver up and running is a task
+we can extract the parameters that we inserted into the axis2.xml file.</p><p>As you can see, getting a new transport receiver up and running is a task
that requires very little effort.</p></div><div class="subsection"><a name="Transport_Sender"></a><h3>Transport Sender</h3><p>Any message that is to be sent out of Axis2, is sent through the Transport
Sender. The Transport Sender needs to be extended from the
org.apache.Axis2.transport.AbstractTransportSender class.</p><p>The following bit of code from the abstract transport sender will call the
Transport Sender that you wrote.</p>
- <div class="source"><pre><pre>// If an EPR is present then the message is going on a diffrent channel.
+ <div class="source"><pre><pre>// If an EPR is present then the message is going on a different channel.
if (epr != null) {
out = openTheConnection(epr, msgContext);
OutputStream newOut = startSendWithToAddress(msgContext, out);
@@ -188,7 +187,7 @@
to send the response or using a different channel, you will need to implement
a sub-set of the methods from the abstract class.</p><p>After implementing the necessary methods, you can let Axis2 know about
your new transport sender by adding an entry to the axis2.xml file, like you
-did for the Transport Receiver.</p>
+did for the transport receiver.</p>
<div class="source"><pre><pre> <transportSender name="TRANSPORT_NAME" class="org.apache.Axis2.transport.TRANSPORT_NAME.TRANSPORT_SENDER_CLASS">
<parameter name="PROPERTY_NAME" locked="false">PROPERTY_VALUE</parameter>
<parameter name="PROPERTY_NAME_2" locked="false">PROPERTY_VALUE_2</parameter>
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org