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/01/17 04:43:51 UTC
svn commit: r369661 -
/webservices/axis2/trunk/java/xdocs/latest/userguide.html
Author: chinthaka
Date: Mon Jan 16 19:43:47 2006
New Revision: 369661
URL: http://svn.apache.org/viewcvs?rev=369661&view=rev
Log:
adding the changes Chatra has done to user guide in to the latest docs.
Modified:
webservices/axis2/trunk/java/xdocs/latest/userguide.html
Modified: webservices/axis2/trunk/java/xdocs/latest/userguide.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/latest/userguide.html?rev=369661&r1=369660&r2=369661&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/userguide.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/userguide.html Mon Jan 16 19:43:47 2006
@@ -1,6 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
-<head>
+<head>
+ <meta http-equiv="content-type" content="">
<title>Axis2 User's Guide</title>
</head>
@@ -139,11 +140,12 @@
<h3><a name="Attention"></a>Attention</h3>
<ul>
- <li>
- <p style="margin-bottom: 0in">This User's Guide is written based on
- <em>Axis2 standard binary distribution</em>. (The standard binary distribution can also be
- created from the source distribution using the maven goal <code>$maven
- dist-std-bin). </code> Please refer the <a href="installationguide.html#Download">installation guide</a> for further information about the downloadable available in this release. </p>
+ <li><p style="margin-bottom: 0in">This User's Guide is written based on
+ Axis2 standard binary distribution. (The standard binary distribution can
+ be created from the source distribution using the maven goal <code>$maven
+ dist-std-bin</code>). Please refer the <a
+ href="installationguide.html#Download">installation guide</a> for further
+ information on the downloadables available in this release.</p>
</li>
<li><p>If you are new to Axis, it's highly recommended that you read <a
href="http://ws.apache.org/axis/java/user-guide.html"
@@ -198,9 +200,9 @@
into the engine for custom header processing, system management, or
<em>anything else you can imagine</em>.</p>
</li>
- <li><p style="margin-bottom: 0in"><strong>Stability</strong> - Axis2 defines
- a set of published interfaces which change relatively slowly compared to
- the rest of Axis.</p>
+ <li><p style="margin-bottom: 0in"><strong>Stability</strong> - Axis2
+ defines a set of published interfaces which change relatively slowly
+ compared to the rest of Axis.</p>
</li>
<li><p style="margin-bottom: 0in"><strong>Component-oriented
Deployment</strong> - You can easily define reusable networks of Handlers
@@ -226,14 +228,15 @@
security, <a href="http://ws.apache.org/sandesha/"
target="_blank">Sandesha</a> for reliable messaging, <a
href="http://ws.apache.org/kandula/" target="_blank">Kandula</a> which is
- an encapsulation of WS-Coordination, WS-AtomicTransaction and WS-BusinessActivity.</p>
+ an encapsulation of WS-Coordination, WS-AtomicTransaction and
+ WS-BusinessActivity.</p>
</li>
- <li><p style="margin-bottom: 0in"><strong>Composition and Extensibility</strong> -
- modules and phases improve support for composability and
- extensibility. Modules supports composability and is able to add support
- for new WS-* specifications in a simple and clean manner. They are
- however not <a href="#hotdeployment">hot deployable</a> as they change
- the overall behavior of the system.</p>
+ <li><p style="margin-bottom: 0in"><strong>Composition and
+ Extensibility</strong> - modules and phases improve support for
+ composability and extensibility. Modules supports composability and is
+ able to add support for new WS-* specifications in a simple and clean
+ manner. They are however not <a href="#hotdeployment">hot deployable</a>
+ as they change the overall behavior of the system.</p>
</li>
</ul>
@@ -250,44 +253,59 @@
<h3>Axis2 Complete Features List<a name="Featurelist"></a></h3>
<ol type="1">
- <li> AXIOM, an XML object model working on StAX (Streaming API for XML) parsing optimized for SOAP 1.1/1.2 Messages. This has complete XML infoset support. </li>
- <li>Support for One-Way Messaging (In-Only) and Request Response Messaging (In-Out) </li>
- <li>Module Architecture, mechanism to extend the SOAP Processing Model </li>
- <li>Module version support , can have multiple versions of the same module and use them depending on the requirement. </li>
- <li>Content hierarchy </li>
- <li>Archive based deployment Model and Directory based deployment model </li>
- <li>JWS like deployment (making Java class into Web service) </li>
- <li>WSDL Code Generation Tool for Stub and skeletons </li>
- <li>WS-Addressing, both the submission (2004/08) and final (2005/08) versions </li>
- <li>WSS4J module for security </li>
- <li>Improved and user friendly Client API </li>
+ <li>AXIOM, an XML object model working on StAX (Streaming API for XML)
+ parsing optimized for SOAP 1.1/1.2 Messages. This has complete XML
+ infoset support.</li>
+ <li>Support for One-Way Messaging (In-Only) and Request Response Messaging
+ (In-Out)</li>
+ <li>Module Architecture, mechanism to extend the SOAP Processing Model</li>
+ <li>Module version support , can have multiple versions of the same module
+ and use them depending on the requirement.</li>
+ <li>Content hierarchy</li>
+ <li>Archive based deployment Model and Directory based deployment model</li>
+ <li>JWS like deployment (making Java class into Web service)</li>
+ <li>WSDL Code Generation Tool for Stub and skeletons</li>
+ <li>WS-Addressing, both the submission (2004/08) and final (2005/08)
+ versions</li>
+ <li>WSS4J module for security</li>
+ <li>Improved and user friendly Client API</li>
<li>WSDL2Java</li>
- <li>REST (REpresentational State Transfer) Support </li>
- <li>Transports supports: HTTP, SMTP, TCP, JMS </li>
- <li>Raw XML providers </li>
- <li>Support for MTOM/ MIME/ SwA </li>
- <li>SAAJ implementation </li>
- <li>DOOM - New Feature </li>
- <li>Pack/Unpack capability for the generated code- New Feature </li>
- <li>Axis Data Binding - ADB (Framework and Schema Compiler) </li>
- <li>Numerous bug fixes since last release </li>
+ <li>REST (REpresentational State Transfer) Support</li>
+ <li>Transports supports: HTTP, SMTP, TCP, JMS</li>
+ <li>Raw XML providers</li>
+ <li>Support for MTOM/ MIME/ SwA</li>
+ <li>SAAJ implementation</li>
+ <li>DOOM - New Feature</li>
+ <li>Pack/Unpack capability for the generated code- New Feature</li>
+ <li>Axis Data Binding - ADB (Framework and Schema Compiler)</li>
+ <li>Numerous bug fixes since last release</li>
</ol>
-<h4 id="head-5bb5aa099717d1d49642f7ae2d63ce5cf94487ad">Axis2 Experimental Features List<a name="experimental"></a></h4>
+
+<h4 id="head-5bb5aa099717d1d49642f7ae2d63ce5cf94487ad">Axis2 Experimental
+Features List<a name="experimental"></a></h4>
<ol type="1">
- <li> Sessions scoping for Application, SOAP, Transport and Request levels </li>
- <li>Server side Web Service Policy support </li>
- <li>?wsdl and ?xsd support </li>
+ <li>Sessions scoping for Application, SOAP, Transport and Request
+ levels</li>
+ <li>Server side Web Service Policy support</li>
+ <li>?wsdl and ?xsd support</li>
<li>Java2WSDL</li>
- <li>Generating ServiceClient for a given WSDL and invoke the corresponding service using generated client. </li>
+ <li>Generating ServiceClient for a given WSDL and invoke the corresponding
+ service using generated client.</li>
</ol>
-<h4 id="head-7dd8e783bb9e22fb00f88748855bb6e500111e12">Major Changes Since Last Release<a name="majorchanges"></a></h4>
+
+<h4 id="head-7dd8e783bb9e22fb00f88748855bb6e500111e12">Major Changes Since
+Last Release<a name="majorchanges"></a></h4>
<ol type="1">
- <li> Fixing of memory leaks </li>
- <li>Client API changes , Introducing ServiceClient instead of MEPClient, InOnlyMEPClient, InOutMEPClient, Call. (Please note that the above classes will be deprecated in this release.) </li>
- <li>Module versioning support , can have multiple versions of the same module and use them depending on the requirement. </li>
- <li>Code generator improved to process multi-port WSDL's properly </li>
- <li>Packing and unpacking options for the code generated classes </li>
+ <li>Fixing of memory leaks</li>
+ <li>Client API changes , Introducing ServiceClient instead of MEPClient,
+ InOnlyMEPClient, InOutMEPClient, Call. (Please note that the above
+ classes will be deprecated in this release.)</li>
+ <li>Module versioning support , can have multiple versions of the same
+ module and use them depending on the requirement.</li>
+ <li>Code generator improved to process multi-port WSDL's properly</li>
+ <li>Packing and unpacking options for the code generated classes</li>
</ol>
+
<h3 id="head-83371cc3d6961295be042f584c7b74d81cca23c4">Tools Included In This
Release<a name="toolsinrelease"></a></h3>
<ol type="1">
@@ -305,17 +323,22 @@
</ol>
<a href="http://ws.apache.org/axis2/download.cgi">Download</a> above plugins
-<h3 id="head-599c5a50552f02ebdeb5f58ef8da289234812ca4">What's Still To Do?<a name="WhatsStillToDo"></a></h3>
-<p>See list of what we think needs to be done, and consider helping out if you're interested & able! </p>
+<h3 id="head-599c5a50552f02ebdeb5f58ef8da289234812ca4">What's Still To Do?<a
+name="WhatsStillToDo"></a></h3>
+
+<p>See list of what we think needs to be done, and consider helping out if
+you're interested & able!</p>
<ol type="1">
- <li> JAX-RPC 1.1 and/or JAX-WS compliance </li>
- <li>SOAP Encoding </li>
- <li>Binary serialization and de-serialization support </li>
- <li>Management Interface for Axis2 </li>
- <li>Implementation of other Transports. </li>
- <li>Resource framework implementation (WS-RF) and Enterprise web services such as JSR 109 support </li>
- <li>Completion of interop tests </li>
+ <li>JAX-RPC 1.1 and/or JAX-WS compliance</li>
+ <li>SOAP Encoding</li>
+ <li>Binary serialization and de-serialization support</li>
+ <li>Management Interface for Axis2</li>
+ <li>Implementation of other Transports.</li>
+ <li>Resource framework implementation (WS-RF) and Enterprise web services
+ such as JSR 109 support</li>
+ <li>Completion of interop tests</li>
</ol>
+
<h2><a name="samples">Samples</a></h2>
<p>In the following sections of the user's guide we will look at how to write
@@ -332,8 +355,8 @@
can select any of the following two ways of writing web services using
Axis2. </p>
<ol>
- <li><a href="#WSapi">Use Axis2's primary
- interfaces (APIs) and implement the business logic.</a></li>
+ <li><a href="#WSapi">Use Axis2's primary interfaces (APIs) and implement
+ the business logic.</a></li>
<li><p><a href="#generateskl">Start from the WSDL ->Code generate the
Skeleton ->Implement the Business Logic.</a></p>
</li>
@@ -888,9 +911,9 @@
public abstract void onError(Exception e);
public boolean isComplete() {}</pre>
-<p>The user is expected to implement the "onComplete " and "onError "
-methods of their extended call back class. Axis2 engine calls the onComplete
-method once the Web Service response is received by the Axis2 Client API
+<p>The user is expected to implement the "onComplete " and "onError " methods
+of their extended call back class. Axis2 engine calls the onComplete method
+once the Web Service response is received by the Axis2 Client API
(ServiceClient). This will eliminate the blocking nature of the Web Service
invocations and provides the user with the flexibility to use Non Blocking
API for Web Service Clients.</p>
@@ -1048,8 +1071,8 @@
deployed. In this operation, a blank SOAP body element is sent to the Web
Service and the same SOAP envelope is echoed back.</p>
<pre> try {
- //Create the stub by passing the AXIS2_HOME and target EPR.
- //We pass null to the AXIS2_HOME and hence the stub will use the current directory as the AXIS2_HOME
+ //Create the stub by passing the AXIS_HOME and target EPR.
+ //We pass null to the AXIS_HOME and hence the stub will use the current directory as the AXIS_HOME
Axis2SampleDocLitPortTypeStub stub = new Axis2SampleDocLitPortTypeStub(null,
"http://localhost:8080/axis2/services/Axis2SampleDocLitPortType");
stub.echoVoid();
@@ -1065,8 +1088,8 @@
deployed. The code is very simple to understand and the explanations are in
the form of comments.</p>
<pre>try {
- //Create the stub by passing the AXIS2_HOME and target EPR.
- //We pass null to the AXIS2_HOME and hence the stub will use the current directory as the AXIS2_HOME
+ //Create the stub by passing the AXIS_HOME and target EPR.
+ //We pass null to the AXIS_HOME and hence the stub will use the current directory as the AXIS_HOME
Axis2SampleDocLitPortTypeStub stub= new Axis2SampleDocLitPortTypeStub(null,
"http://localhost:8080/axis2/services/Axis2SampleDocLitPortType");
//Create the request document to be sent.
@@ -1086,8 +1109,8 @@
<h4><a name="clientechostringarray">Client for echoStringArray
Operation</a></h4>
<pre>try {
- //Create the stub by passing the AXIS2_HOME and target EPR.
- //We pass null to the AXIS2_HOME and hence the stub will use the current directory as the AXIS2_HOME
+ //Create the stub by passing the AXIS_HOME and target EPR.
+ //We pass null to the AXIS_HOME and hence the stub will use the current directory as the AXIS_HOME
Axis2SampleDocLitPortTypeStub stub = new Axis2SampleDocLitPortTypeStub(null,
"http://localhost:8080/axis2/services/Axis2SampleDocLitPortType");
@@ -1113,8 +1136,8 @@
<h4><a name="clientechostruct">Client for echoStruct Operation</a></h4>
<pre>try {
- //Create the stub by passing the AXIS2_HOME and target EPR.
- //We pass null to the AXIS2_HOME and hence the stub will use the current directory as the AXIS2_HOME
+ //Create the stub by passing the AXIS_HOME and target EPR.
+ //We pass null to the AXIS_HOME and hence the stub will use the current directory as the AXIS_HOME
Axis2SampleDocLitPortTypeStub stub = new Axis2SampleDocLitPortTypeStub(null,
"http://localhost:8080/axis2/services/Axis2SampleDocLitPortType");
//Create the request Document
@@ -1258,8 +1281,8 @@
<p>As it can be seen there are four phases defined in this "module.xml"</p>
<ol>
- <li>inflow - Represents the
- handler chain that will run when a message is coming in. </li>
+ <li>inflow - Represents the handler chain that will run when
+ a message is coming in. </li>
<li><p style="margin-bottom: 0in">outflow - Represents the
handler chain that will run when the message is going out. </p>
</li>
@@ -1283,7 +1306,10 @@
<pre><handler name="InFlowLogHandler" class="userguide.loggingmodule.LogHandler">
<order phase="loggingPhase" />
</handler></pre>
-<p>To learn more on Phase rules, click on <a href="http://www.developer.com/java/web/article.php/3529321" target="_blank">here</a></p>
+
+<p>To learn more on Phase rules, click on <a
+href="http://www.developer.com/java/web/article.php/3529321"
+target="_blank">here</a></p>
<h4><a name="step4loggingmodule">Step 4: Modify the "axis2.xml"</a></h4>
@@ -1334,7 +1360,7 @@
</phaseOrder>
<phaseOrder type="outflow">
<!-- user can add his own phases to this area -->
- <phase name="userphase1"/>
+ <phase name="userphase1"/>
<phase name="<font color="#33cc00">loggingPhase</font>"/>
<!--system predefined phase-->
<!--these phase will run irrespective of the service-->
@@ -1353,8 +1379,7 @@
<phase name="PolicyDetermination"/>
<phase name="MessageOut"/>
</phaseOrder>
-
-</pre>
+ </pre>
<p>Shown in green, the custom phase "loggingPhase" is placed in all the
flows, hence that phase will be called in all the message flows in the
@@ -1452,8 +1477,8 @@
<p>The alternate method is to build the samples from source. Moving to the
modules/samples and running maven will create the samples in the
target/samples directory. However if the samples need to be started using the
-shell scripts (or the batch files) then the AXIS2_HOME environment need to be
-set.( the "guessed" AXIS2_HOME would not be correct in this case)</p>
+shell scripts (or the batch files) then the AXIS_HOME environment need to be
+set.( the "guessed" AXIS_HOME would not be correct in this case)</p>
<h3><a name="googlespell">Google Spell Checker Sample</a></h3>