Author: dasarath
Date: Fri Feb 24 12:29:31 2006
New Revision: 380808
URL: http://svn.apache.org/viewcvs?rev=380808&view=rev
Log:
fixed some HTML tags
Modified:
webservices/kandula/site/user-guide.html
Modified: webservices/kandula/site/user-guide.html
URL:
http://svn.apache.org/viewcvs/webservices/kandula/site/user-guide.html?rev=380808&r1=380807&r2=380808&view=diff
==============================================================================
--- webservices/kandula/site/user-guide.html (original)
+++ webservices/kandula/site/user-guide.html Fri Feb 24 12:29:31 2006
@@ -1,57 +1,86 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";><html><head><title>Kandula
- User Guide for Apache Kandula</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>Kandula
- Kandula - Apache Kandula</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://ws.apache.org/"; id="organizationLogo"><img alt="Apache Web
Services" src="http://ws.apache.org/images/project-logo.jpg";></img></a><a
href="http://ws.apache.org/ws-fx/kandula/"; id="projectLogo"><span>Apache
Kandula</span></a><div class="clear"><hr></hr></div></div><div
id="breadcrumbs"><div class="xleft">
- Last published: 18 August 2005
- | Doc for 0.1-SNAPSHOT</div><div class="xright"></div><div
class="clear"><hr></hr></div
- div><div id="leftColumn"><div id="navcolumn"><div
id="menuKandula"><h5>Kandula</h5><ul>
- <li class="none"><a href="user-guide.html">User
Guide</a></li>
- <li class="none"><a
href="architecture-guide.html">Architecture Guide</a></li></ul></div>
- <div id="menuProject_Documentation"><h5>Project
Documentation</h5><ul><li class="none">
- <a href="index.html">About Apache Kandula</a></li><li
class="collapsed">
- <a href="project-info.html">Project Info</a></li><li
class="collapsed">
- <a href="maven-reports.html">Project Reports</a></li><li
class="none">
- <a href="http://maven.apache.org/development-process.html";
class="externalLink" title="External Link">
- Development Process</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="User_Guide_for_Apache_Kandula"></a>
+ @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://ws.apache.org/";
+ id="organizationLogo"><img alt="Apache Web Services"
+
src="http://ws.apache.org/images/project-logo.jpg";></img>
+ </a><a href="http://ws.apache.org/ws-fx/kandula/";
id="projectLogo">
+ <span>Apache Kandula</span></a>
+ <div class="clear"><hr></hr></div></div>
+ <div id="breadcrumbs"><div class="xleft">
+ Last published: 14 June 2005
+ | Doc for 0.1-SNAPSHOT</div>
+ <div class="xright"></div><div class="clear"><hr></hr>
+ </div></div><div id="leftColumn"><div id="navcolumn">
+ <div id="menuKandula"><h5>Kandula</h5><ul><li class="none">
+ <a href="user-guide.html">User Guide</a></li><li
class="none">
+ <a href="architecture-guide.html">Architecture
Guide</a></li></ul></div>
+ <div id="menuProject_Documentation"><h5>Project
Documentation</h5><ul>
+ <li class="none"><strong><a href="index.html">About Apache
Kandula</a></strong>
+ </li><li class="collapsed"><a
href="project-info.html">Project Info</a></li>
+ <li class="collapsed"><a href="maven-reports.html">Project
Reports</a></li>
+ <li class="none"><a
href="http://maven.apache.org/development-process.html";
+ class="externalLink" title="External Link">Development
Process</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="User_Guide_for_Apache_Kandula"></a>
<H1>User Guide for Apache Kandula</H1>
<H2>Purpose</H2>
<P>Describe how to deploy Apache Kandula and run the provided sample
applications.</P>
<H2>Introduction</H2>
-<p>Presently Apache Kandula has 2 branches. The svn trunk named "Kandula2"
runs on Apache Axis2. Kandula_1 branch
+<p>Presently Apache Kandula has 2 branches. The svn trunk named "Kandula2"
runs on Apache Axis2. Kandula1 branch
runs on "Axis 1.x" (henceforth referred to as Apache Axis). Both branches now
support the nightly builds of their respective Axis flavours.</p>
<H2>Kandula2 branch</H2>
-<H2>Kandula_1 branch</H2>
+<H2>Kandula1 branch</H2>
<H3>How to download and build</H3>
<ol>
-<LI>Checkout Kandula_1 from the svn repository using an svn client at the
following URL:
-<a
href="https://svn.apache.org/repos/asf/webservices/kandula/branches/Kandula_1/";>https://svn.apache.org/repos/asf/webservices/kandula/branches/Kandula_1/</a>.
-Let us call the directory to which you checked out Kandula_1,
<tt>KANDULA_HOME</tt>.</LI>
-<li>Download and install Apache Tomcat. (5.0 or later required).</li>
-<li>Download and install Apache Axis (1.3 or later required). It is better to
use the
- same version of Axis on both ends (client/server) </li><li>Download
and install Apache Maven 1.x (2.0 not supported).</li>
-<li>Download and install Apache Ant (1.6.5 or later).</li>
-<li>Set the kandula.context property in
<tt>%KANDULA_HOME%/src/conf/kandula.properties</tt>, to the context under which
-services are deployed in Axis. Normally this is:
<tt>http://localhost:8080/axis/services/</tt></li>
-<li>Build Kandula using Maven. Use the command <tt>maven</tt> in
<tt>%KANDULA_HOME%</tt>. This will create the directory
+<li><p><p>Checkout Kandula1 from the svn repository using an svn client at the
following URL:
+<a
href="https://svn.apache.org/repos/asf/webservices/kandula/branches/Kandula1/";>https://svn.apache.org/repos/asf/webservices/kandula/branches/Kandula1/</a>.
+Let us call the directory to which you checked out Kandula1,
<tt>KANDULA_HOME</tt>.</p></p></li>
+<li><p>Download and install Apache Tomcat. (5.0 or later required).</p></li>
+<li><p>Download and install Apache Axis (1.3 or later required). Do NOT deploy
Kandula
+on a version of Axis different from the version on which it was built. Rebuild
Kandula
+if this is required on the required version by modifying the build files.
However,
+you may use different Axis versions on client/server
ends.</p></li><li><p>Download and install Apache Maven 1.x (2.0 not
supported).</p></li>
+<li><p>Download and install Apache Ant (1.6.5 or later).</p></li>
+<li><p>Set the kandula.context property in
<tt>%KANDULA_HOME%/src/conf/kandula.properties</tt>, to the context under which
+services are deployed in Axis. Normally this is:
<tt>http://localhost:8080/axis/services/</tt></p></li>
+<li><p>Build Kandula using Maven. Use the command <tt>maven</tt> in
<tt>%KANDULA_HOME%</tt>. This will create the directory
<tt>%KANDULA_HOME%/target</tt>. You will find the
<tt>kandula-0.2-SNAPSHOT.jar</tt> along with all other required <tt>*.jar</tt>
-files in the directory <tt>%KANDULA_HOME%/target/lib</tt>.</li>
-<li>To build the sample applications, move to each of the sample directories
in <tt>%KANDULA_HOME%/src/samples/</tt>
-and use the command <tt>ant dist</tt>.</li>
+files in the directory <tt>%KANDULA_HOME%/target/lib</tt>.</p></li>
+<li><p>To build the sample applications, move to each of the sample
directories in <tt>%KANDULA_HOME%/src/samples/</tt>
+and use the command <tt>ant dist</tt>.</p></li>
</ol>
<h3>How to deploy</h3>
<ol>
-<li>Move all Apache Axis jars from <tt>%AXIS_DEPLOY%/WEB-INF/lib</tt> to
<tt>%TOMCAT_HOME%/shared/lib</tt>.</li>
-<li>Move all <tt>geronimo-*.jar</tt> files, <tt>addressing-SNAPSHOT.jar</tt>
and <tt>kandula-0.2-SNAPSHOT.jar</tt> to <tt>%TOMCAT_HOME%/shared/lib</tt>.</li>
-<li>Copy the <tt>*.jar</tt> file in the <tt>build</tt> directory of each
sample application to <tt>%AXIS_DEPLOY%/WEB-INF/lib</tt>.</li>
-<li>Copy the <tt>server-config.wsdd</tt> file in
<tt>%KANDULA_HOME%/src/conf/</tt> to <tt>%AXIS_DEPLOY%/WEB-INF/</tt>.</li>
-<li>Copy the <tt>client-config.wsdd</tt> file in
<tt>%KANDULA_HOME%/src/conf/</tt> to
<tt>%AXIS_DEPLOY%/WEB-INF/classes</tt>.</li>
-<li>Start Tomcat. To assure that Kandula has been properly deployed, first
list all deployed services
-in Axis from the "Happy Axis" page and then verify that you can view the WSDL
of each service.</li>
+<li><p>Move all Apache Axis jars from <tt>%AXIS_DEPLOY%/WEB-INF/lib</tt> to
<tt>%TOMCAT_HOME%/shared/lib</tt>.</p></li>
+<li><p>Move all <tt>geronimo-*.jar</tt> files,
<tt>addressing-SNAPSHOT.jar</tt> and <tt>kandula-0.2-SNAPSHOT.jar</tt> to
<tt>%TOMCAT_HOME%/shared/lib</tt>.</p></li>
+<li><p>Copy the <tt>*.jar</tt> file in the <tt>build</tt> directory of each
sample application to <tt>%AXIS_DEPLOY%/WEB-INF/lib</tt>.</p></li>
+<li><p>Copy the <tt>server-config.wsdd</tt> file in
<tt>%KANDULA_HOME%/src/conf/</tt> to <tt>%AXIS_DEPLOY%/WEB-INF/</tt>.</p></li>
+<li><p>Copy the <tt>client-config.wsdd</tt> file in
<tt>%KANDULA_HOME%/src/conf/</tt> to
<tt>%AXIS_DEPLOY%/WEB-INF/classes</tt>.</p></li>
+<li><p>Start Tomcat. To assure that Kandula has been properly deployed, first
list all deployed services
+in Axis from the "Happy Axis" page and then verify that you can view the WSDL
of each service.</p></li>
</ol>
<h3>How to run the sample applications</h3>
@@ -84,19 +113,20 @@
<p>The most important aspect of this sample application is that it demostrates
how Kandula
can be used to expose transactional resources in a J2EE environment via the
web services transaction management
-framework. After the revision of code in December 2005, Kandula_1 now supports
ONLY the "Geronimo" Transaction Manager.
+framework. After the revision of code in December 2005, Kandula1 now supports
ONLY the "Geronimo" Transaction Manager.
The required jars are automatically downloaded by Maven during the build
process.</p>
<p>To run the sample, do the following.</p>
-<ol><li>First ensure that the transaction handler used in your
<tt>%AXIS_DEPLOY%/WEB-INF/classes/client-config.wsdd</tt>
+<ol><li><p>First ensure that the transaction handler used in your
<tt>%AXIS_DEPLOY%/WEB-INF/classes/client-config.wsdd</tt>
is <tt>org.apache.kandula.geronimo.TxHandler</tt>.
-</li>
-<li>Next open up the JUnit test case provided in the <tt>src</tt> directory
+</p></li>
+<li><p>Next open up the JUnit test case provided in the <tt>src</tt> directory
in your favourite IDE. This file contains a number of test cases. Each test
case should be run on its own. If you run
a number of test cases this would result in a whole lot of messages which
would be rather difficult to interpret.
Also note that some of the test scenarios are positive tests while some others
are negative. A short description of
-the success criteria of most of the test cases can be found in the
<tt>success-criteria.txt</tt> file in
<tt>%KANDULA_HOME%/src/samples/test-suite1/</tt>.
-<li>To run the test cases use the standard JUnit test harness of your IDE.</li>
+the success criteria of most of the test cases can be found in the
<tt>success-criteria.txt</tt>
+ file in <tt>%KANDULA_HOME%/src/samples/test-suite1/</tt>.</p></li>
+<li><p>To run the test cases use the standard JUnit test harness of your
IDE.</p></li>
</ol>
<h4>InteropIBM</h4>
@@ -114,24 +144,24 @@
in this case you must set the <tt>kandula.context</tt> property to the
externally visible URL. If neither option is available, you may still run the
sample using Kandula in both IA and PA configurations simultaniously. The
resulting
message exchanges SHOULD still comply with the documented success criteria.</p>
-<p>Further, in this particular scenario, the Kandula Stubs are pre-configured
to forward any messages addressed to
+<p>Further, in this particular scenario, the Kandula1 Stubs are pre-configured
to forward any messages addressed to
<tt>http://wsi.alphaworks.ibm.com:8080/</tt> to
<tt>http://localhost:8082/</tt>. This allows you to monitor all outgoing
traffic. So before you run the sample forward the port 8082 of your local
machine to <tt>http://wsi.alphaworks.ibm.com:8080/</tt></p>
<p>To test Kandula in PA role follow the steps below.</p>
<ol>
-<li>Deploy the sample and start Tomcat. Ensure that InteropService is listed
(along with its operations) under deployed
-services in Axis and that you are able to view the WSDL.</li>
-<li>Open the page <a
href="http://wsi.alphaworks.ibm.com:8080/wstx/interop.jsp";>http://wsi.alphaworks.ibm.com:8080/wstx/interop.jsp</a>
in your web browser.</li>
-<li>Enter the URL of your "InteropService" as the participant destination.
Here, if you want to monitor incoming traffic,
-change the port from 8080 to 8081 when entering the URL and forward port 8081
to 8080 as before.</li>
-<li>Select the test scenario you want to run. Do not select scenarios from
Sections 5.0 or later since these have not
-been tested yet under this setting.</li>
-<li>Select run test.</li>
+<li><p>Deploy the sample and start Tomcat. Ensure that InteropService is
listed (along with its operations) under deployed
+services in Axis and that you are able to view the WSDL.</p></li>
+<li><p>Open the page <a
href="http://wsi.alphaworks.ibm.com:8080/wstx/interop.jsp";>http://wsi.alphaworks.ibm.com:8080/wstx/interop.jsp</a>
in your web browser.</p></li>
+<li><p>Enter the URL of your "InteropService" as the participant destination.
Here, if you want to monitor incoming traffic,
+change the port from 8080 to 8081 when entering the URL and forward port 8081
to 8080 as before.</p></li>
+<li><p>Select the test scenario you want to run. Do not select scenarios from
Sections 5.0 or later since these have not
+been tested yet under this setting.</p></li>
+<li><p>Select run test.</p></li>
</ol>
<p>To test Kandula in IA role, deploy the sample application and setup the TCP
sniffer as before.
-Thne open up the sample application in your favourite IDE. The code for
exercising test scenarios is in <tt>InitiatorApp.java</tt>. You also need a
test orchetrator
+Then open up the sample application in your favourite IDE. The code for
exercising test scenarios is in <tt>InitiatorApp.java</tt>. You also need a
test orchetrator
for some of the scenarios. The test orchestrator that we used can be found in
<tt>ManInTheMiddle.java</tt>. Note that when using the test orchestrator you
need to setup the TCP monitor differently.
Due to the relative complexity of the process involved we do not document
these steps any further. However, things can be
figured out rather quickly by examining the source code. If you run into
trouble, please shoot your questions to [EMAIL PROTECTED]</p>
@@ -143,4 +173,18 @@
- </div></div></div><div class="clear"><hr></hr></div><div
id="footer"><div class="xright">© 2004-2005, Apache Web Services</div><div
class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
+ </div>
+
+
+
+
+
+
+
+
+
+
+ <!--
+ -->
+
+ </div></div><div class="clear"><hr></hr></div><div id="footer"><div
class="xright">© 2004-2005, Apache Web Services</div><div
class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
![http://ws.apache.org/images/project-logo.jpg"](http://ws.apache.org/images/project-logo.jpg"){kind=link}