[wsas-java-dev] svn commit r37 - in wsas/java/trunk:
modules/samples/Trader/xdocs xdocs xdocs/tools/cmd
svn at wso2.com
svn at wso2.com
Thu Nov 30 19:50:21 PST 2006
Author: hasmin
Date: Thu Nov 30 19:50:19 2006
New Revision: 37
Modified:
wsas/java/trunk/modules/samples/Trader/xdocs/trader_sample.html
wsas/java/trunk/xdocs/installationguide.html
wsas/java/trunk/xdocs/tools/cmd/code_gen.html
Log:
reviewed docs
Modified: wsas/java/trunk/modules/samples/Trader/xdocs/trader_sample.html
==============================================================================
--- wsas/java/trunk/modules/samples/Trader/xdocs/trader_sample.html (original)
+++ wsas/java/trunk/modules/samples/Trader/xdocs/trader_sample.html Thu Nov 30 19:50:19 2006
@@ -5,13 +5,15 @@
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta content="text/html; charset=UTF-8" />
- <title>Trader Sample Guide for WSO2 Web Services Application Server @wso2wsas_version@</title>
+ <title>Trader Sample Guide for WSO2 Web Services Application Server
+ @wso2wsas_version@</title>
<link href="css/wsas-dist-doc.css" rel="stylesheet" type="text/css"
media="all" />
</head>
<body>
-<h1>Trader Sample Guide for WSO2 Web Services Application Server(WSO2 WSAS) @wso2wsas_version@</h1>
+<h1>Trader Sample Guide for WSO2 Web Services Application Server (WSO2 WSAS)
+ at wso2wsas_version@</h1>
<p><img alt="Figure:1" src="images/cse.jpg" /><br />
</p>
@@ -20,41 +22,43 @@
<p>We will use this sample to demonstrate the capabilities of WSO2 WSAS,
highlighting the ease of integration of QoS modules. In the context of this
-trading scenario, the use of security and reliable messaging is emphasized
-on.</p>
+trading scenario, this emphasizes the use of security and reliable
+messaging.</p>
-<p>In a nutshell, trading sample takes place in a scenario where there are
-interactions taking place between a stock exchange, trader (stock broker)
+<p>In a nutshell, the trading sample takes place in a scenario where there
+are interactions taking place between a stock exchange, trader (stock broker)
& client (shareholder). A shareholder who buys and sells shares on the
stock market needs to do so through a stock broker or trader, in which case
he would first need to become a client of that particular trader. The
-shareholder uses his Central Depository System (CDS) account which registers him
-with the stock exchange to sell & buy shares on the stock market. A
-trader can register his client(the shareholder) with the stock exchange.</p>
+shareholder uses his Central Depository System (CDS) account which registers
+him with the stock exchange to sell & buy shares on the stock market. A
+trader can register his client (the shareholder) with the stock exchange.</p>
-<p>The following section describes the services offered by each of the parties
-involved in this scenario.</p>
+<p>The following section describes the services offered by each of the
+parties involved in this scenario.</p>
<h2>SCENARIO</h2>
-<p>Client creates an account with a trader by which the client receives a user
-ID. The Trader in return, registers the client with the stock exchange using client
-information. The Client obtains CDS account at this registration through which he
-is allowed to trade on the stock market. The Client can only buy & sell
-shares on the market through the Trader. The Trader places these buy & sell
-orders of the client on the stock exchange.</p>
+<p>Client creates an account with a trader by which the Client receives an
+user ID. The Trader in return, registers the Client with the stock exchange
+using client information. The Client obtains a CDS account at this
+registration through which he is allowed to trade on the stock market. The
+Client can only buy & sell shares on the market through the Trader. The
+Trader places these buy & sell orders of the Client on the stock
+exchange.</p>
-<p>The Trader also registers feed targets to the exchange.</p>
+<p>The Trader also registers feed targets to the Exchange.</p>
<p>To access any of the services from the stock exchange, The Trader needs to
first login to the Exchange using the Trader's username & password.</p>
-<p>The Clients get stock quotes (company name, symbol, selling price, high, low),
-and portfolio information from the Trader.
-He also deposits money in his account through the Trader.</p>
-
-<p>The user(shareholder) can directly gain market information such as total traded shares,
-average price, and average size of trade from The stock exchange.</p>
+<p>The Clients get stock quotes (company name, symbol, selling price, high,
+low), and portfolio information from the Trader. He also deposits money in
+his account through the Trader.</p>
+
+<p>The User (shareholder) can directly gain market information such as total
+traded shares, average price, and average size of trade from The stock
+exchange.</p>
<p>Trader provides market data updates to stock exchange</p>
@@ -67,11 +71,11 @@
<ul>
<li>Registering clients</li>
<li>Logging in to Stock Exchange</li>
- <li>Buying and selling shares for clients</li>
+ <li>Buying and selling shares for Clients</li>
<li>Registering feed targets</li>
</ul>
</li>
- <li><strong>Services offered by Stock Exchange to client</strong>
+ <li><strong>Services offered by Stock Exchange to Client</strong>
<ul>
<li>Provide market information such as total traded shares, average
price, average size of trade</li>
@@ -103,7 +107,7 @@
<p>To build the samples you need the <a href="http://ant.apache.org/">Apache
Ant</a> build tool.</p>
-<h3>Now follow the simple instructions:</h3>
+<h3>Now follow these simple instructions:</h3>
<ol>
<li>Install and start WSO2 WSAS. See <a
href="../../../docs/installationguide.html">Installation Guide</a> for
@@ -136,8 +140,8 @@
<p>The build automatically copies the .aar files containing the necessary
services into the repository.</p>
- <li>If you select the Services page in the Management Console you
- should now see the ExchangeTrader, ExchangeClient, TraderClient and
+ <li>If you select the Services page in the Management Console you should
+ now see the ExchangeTrader, ExchangeClient, TraderClient and
TraderExchange services deployed. If you still don't see it, try
restarting the system from the System page.</li>
@@ -161,19 +165,18 @@
<p><strong>Terms used:</strong></p>
<ul>
<li>TraderService URL is the End Point Reference (EPR) of the
- TraderClient. This can be obtained from the Management
- Console: The relevant service EPR can be found at Manage Services >
- Available services > service. For this sample the URL is
+ TraderClient. This can be obtained from the Management Console: The
+ relevant service EPR can be found at Manage Services > Available
+ services > service. For this sample the URL is
"http://127.0.0.1:9762/soap/TraderClient".</li>
<li>ExchangeService URL is the EPR of the ExchangeClient. This can be
- obtained from the Management Console: The relevant service EPR
- can be found at Manage Services > Available services > service.
- For this example it is
- "http://127.0.0.1:9762/soap/ExchangeClient".</li>
- <li>If rm, secure or securerm is to be used the following modules
- should be engaged. This can be done by selecting the Engage Module
- option from the Service Information page for the services listed in the
- management console.
+ obtained from the Management Console: The relevant service EPR can be
+ found at Manage Services > Available services > service. For this
+ example it is "http://127.0.0.1:9762/soap/ExchangeClient".</li>
+ <li>If rm, secure or securerm is to be used the following modules should
+ be engaged. This can be done by selecting the Engage Module option from
+ the Service Information page for the services listed in the management
+ console.
<ul>
<li>rm - Sandesha (Sandesha2)</li>
<li>secure - Security (Rampart)</li>
Modified: wsas/java/trunk/xdocs/installationguide.html
==============================================================================
--- wsas/java/trunk/xdocs/installationguide.html (original)
+++ wsas/java/trunk/xdocs/installationguide.html Thu Nov 30 19:50:19 2006
@@ -17,16 +17,16 @@
v at wso2wsas_version@ - Installation Guide</h1>
<p>This installation guide provides information on the prerequisites of WSO2
-WSAS and installation instructions including on how to start WSO2 WSAS &
-access its Management Console.</p>
+WSAS and installation instructions including how to start WSO2 WSAS and
+access the Management Console.</p>
<p>One of the two main sections of this document will explain the
installation of <strong>WSO2 WSAS Standalone Edition for Java</strong>, while
the other will explain the installation process of <strong>WSO2 WSAS Servlet
Edition</strong> or in other words, installing WSO2 WSAS into a J2EE
-compliant servlet container</p>
+compliant servlet container.</p>
-<p>For those more adventurous users WSO2 WSAS can also be built using the
+<p>For the more adventurous user WSO2 WSAS can also be built using the
<strong>source distribution</strong> provided with this release. The third
section of this installation guide will explain how to build WSO2 WSAS using
this source distribution.</p>
@@ -69,13 +69,13 @@
Management Console</a></li>
</ul>
</li>
- <li><a href="installation_servlet.html">WSO2 WSAS Servlet Edition Installation
- Guide</a>
+ <li><a href="installation_servlet.html">WSO2 WSAS Servlet Edition
+ Installation Guide</a>
<ul>
<li><a href="installation_servlet.html#intro">Introduction</a>
<ul>
- <li><a href="installation_servlet.html#app_servers">J2EE Application
- Servers</a></li>
+ <li><a href="installation_servlet.html#app_servers">J2EE
+ Application Servers</a></li>
</ul>
</li>
<li><a href="installation_servlet.html#req">System Requirements</a></li>
@@ -89,18 +89,20 @@
Configuration Instructions</a>
<ul>
<li><a href="installation_servlet.html#tom">Apache Tomcat
- Server</a></li>
+ Server</a></li>
<li><a href="installation_servlet.html#boss">JBoss AS</a></li>
- <li><a href="installation_servlet.html#Geronimo">Apache Geronimo
- AS</a></li>
+ <li><a href="installation_servlet.html#Geronimo">Apache
+ Geronimo AS</a></li>
</ul>
</li>
<li><a href="installation_servlet.html#note">Issues to Note</a></li>
</ul>
</li>
- <li><a href="installation_servlet.html#gen">Generic Application Server</a>
+ <li><a href="installation_servlet.html#gen">Generic Application
+ Server</a>
<ul>
- <li><a href="installation_servlet.html#gen_installations">Installation
+ <li><a
+ href="installation_servlet.html#gen_installations">Installation
Instructions</a></li>
<li><a href="installation_servlet.html#gen_config">Advanced
Configurations</a></li>
@@ -108,8 +110,8 @@
</li>
<li><a href="installation_servlet.html#post">Post Installation
Modifications</a></li>
- <li><a href="installation_servlet.html#mgtconsole">Accessing the Management
- Console</a></li>
+ <li><a href="installation_servlet.html#mgtconsole">Accessing the
+ Management Console</a></li>
</ul>
</li>
<li><a href="installation_src.html">WSO2 WSAS Source Distribution</a>
@@ -131,11 +133,12 @@
<h2>Introduction</h2>
-<p>WSO2 WSAS is a lightweight application server for Web services built on
-Apache Axis2 framework that incorporates leading Open Source components into
-a simple, easy-to-use and highly performant package. The Web services support
-include WS-Addressing, WS-Policy, WS-Reliable Messaging,WS-Security and more,
-giving a full secure, transactional and reliable infrastructure.</p>
+<p>WSO2 WSAS is a lightweight application server for Web services. It is
+built on the Apache Axis2 framework which incorporates leading open source
+components into a simple, easy-to-use and highly performant package. Web
+services support include WS-Addressing, WS-Policy,
+WS-ReliableMessaging,WS-Security and more, giving a full secure,
+transactional and reliable infrastructure.</p>
<p>WSO2 WSAS is distributed in several convenient distribution packages and
can be installed either as a standalone server or as part of a J2EE compliant
Modified: wsas/java/trunk/xdocs/tools/cmd/code_gen.html
==============================================================================
--- wsas/java/trunk/xdocs/tools/cmd/code_gen.html (original)
+++ wsas/java/trunk/xdocs/tools/cmd/code_gen.html Thu Nov 30 19:50:19 2006
@@ -12,28 +12,34 @@
<body>
<h1>Code Generator Command Line Tool Guide</h1>
-<p>For those of you who are more comfortable with command line, these tools
-will be of great use. This guide will contain instructions on generating a
-WSDL file from a java class (Java2WSDL) and/or a set of java class file from
-a WSDL (WSDL2Java) using this command line code generator tools.</p>
+<p>For those of you who are more comfortable with the command line, these
+tools will be of great use. This guide contains instructions on generating a
+WSDL file from a Java class (Java2WSDL) and/or a set of Java class files from
+a WSDL (WSDL2Java) using these command line code generator tools.</p>
<h2>Introduction</h2>
<h3>WSDL2Java:</h3>
-<p>This basic tool is implemented by the WSDL2Code class and just for the
-convenience in the case of java (which would be the majority) there is
+<p>This basic tool is implemented by the WSDL2Code class and for the
+convenience in the case of Java (which would be the majority) there is
another WSDL2Java class. One can choose to run the main classes directly or
use one of the scripts to run the WSDL2Code and WSDL2Java appropriately. The
scripts are found in the bin directory of the WSO2 WSAS installation.</p>
-<p>This script file to run this tool is located in WSO2WSAS_HOME/bin</p>
+<p>The script file to run this tool is located in WSO2WSAS_HOME/bin</p>
-<p><strong>Example : </strong> This example will cover the default scenario of generating the client stub using the wsdl to the specified output locatin. You can add other options listed on the Option References for WSDL2Java</p>
-
-<p><strong>Windows : </strong> wsdl2java -uri %WSO2WSAS_HOME%\samples\CommodityQuote\wsdl\CommodityQuote.wsdl -o %WSO2WSAS_HOME%\output</p>
-
-<p><strong>Linux : </strong> sh wsdl2java.sh -uri $WSO2WSAS_HOME/samples/CommodityQuote/wsdl/CommodityQuote.wsdl -o $WSO2WSAS_HOME/output</p>
+<p><strong>Example :</strong> This example will cover the default scenario of
+generating the client stub using the wsdl to the specified output location.
+You can add other options listed on the Option References for WSDL2Java.</p>
+
+<p><strong>Windows :</strong> wsdl2java -uri
+%WSO2WSAS_HOME%\samples\CommodityQuote\wsdl\CommodityQuote.wsdl -o
+%WSO2WSAS_HOME%\output</p>
+
+<p><strong>Linux :</strong> sh wsdl2java.sh -uri
+$WSO2WSAS_HOME/samples/CommodityQuote/wsdl/CommodityQuote.wsdl -o
+$WSO2WSAS_HOME/output</p>
<h3>Java2WSDL:</h3>
@@ -41,14 +47,20 @@
a Java class file. Scripts for this tool are also included in the bin
directory of the WSO2 WSAS installation.</p>
-<p>This script file to run this tool is located in WSO2WSAS_HOME/bin</p>
+<p>The script file to run this tool is located in WSO2WSAS_HOME/bin</p>
+
+<p><strong>Example :</strong> This example will assume that you have set the
+SAMPLE_HOME environment variable as the base directory of the Java class.
+Under that we have test directory and inside that we have Math.class that we
+going to refer to, to generate the WSDL. You can add other options listed on
+the Option References for Java2WSDL</p>
-<p><strong>Example : </strong> This example will assume that you have set the SAMPLE_HOME environment variable as the base directory of the java class and under that we have test directory and inside that we have Math.class that we going to refer to generate the wsdl. You can add other options listed on the Option References for Java2WSDL</p>
+<p><strong>Windows :</strong> java2wsdl -cn test.Math -cp %SAMPLE_HOME% -o
+%WSO2WSAS_HOME%\output</p>
-<p><strong>Windows : </strong> java2wsdl -cn test.Math -cp %SAMPLE_HOME% -o %WSO2WSAS_HOME%\output </p>
+<p><strong>Linux :</strong> sh java2wsdl.sh -cn test.Math -cp $SAMPLE_HOME -o
+$WSO2WSAS_HOME/output</p>
-<p><strong>Linux : </strong> sh java2wsdl.sh -cn test.Math -cp $SAMPLE_HOME -o $WSO2WSAS_HOME/output </p>
-
<h2>Option References for WSDL2Java</h2>
<table border="1" cellpadding="0" cellspacing="0"
@@ -63,12 +75,12 @@
<td>-uri <Location of WSDL></td>
<td>None</td>
<td>WSDL file location. This should point to a WSDL file in the local
- file system</td>
+ file system.</td>
</tr>
<tr>
<td>-o <output Location> :</td>
<td>--output</td>
- <td>output file location. This is where the files would be copied once
+ <td>Output file location. This is where the files would be copied once
the code generation is done. If this option is omitted the generated
files would be copied to the working directory.</td>
</tr>
@@ -77,7 +89,7 @@
<td>--language</td>
<td>Output language. Currently the code generator can generate code in
Java but it has the ability to be extended to support other
- languages</td>
+ languages.</td>
</tr>
<tr>
<td>-p <package name></td>
@@ -88,16 +100,16 @@
<tr>
<td>-a</td>
<td>--async</td>
- <td>Generate code only for async style . when this option is used the
+ <td>Generate code only for async style . When this option is used the
generated stubs will have only the asynchronous invocation methods.
- Switched off by default.</td>
+ It is switched off by default.</td>
</tr>
<tr>
<td>-s</td>
<td>--sync</td>
<td>Generate code only for sync style . When this option is used the
- generated stubs will have only the synchronous invocation methods.
- Switched off by default. When used with the -a option, this takes
+ generated stubs will have only the synchronous invocation methods. It
+ is switched off by default. When used with the -a option, this takes
precedence.</td>
</tr>
<tr>
@@ -109,18 +121,18 @@
<tr>
<td>-ss</td>
<td>--server-side</td>
- <td>Generates server side code (i.e. skeletons). Default is off</td>
+ <td>Generates server side code (i.e. skeletons). Default is off.</td>
</tr>
<tr>
<td>-sd</td>
<td>--service-description</td>
<td>Generates the service descriptor (i.e. server.xml). Default is off.
- only valid with -ss, the server side code generation option</td>
+ only valid with -ss, the server side code generation option.</td>
</tr>
<tr>
<td>-d</td>
<td>--databinding-method</td>
- <td>Specifies the Databinding framework. valid values are xmlbeans,
+ <td>Specifies the Databinding framework. Valid values are xmlbeans,
adb, jibx, and none. Default is adb.</td>
</tr>
<tr>
@@ -140,35 +152,35 @@
<td>-sn</td>
<td>--service-name</td>
<td>Specifies the service name to be code generated. If the service
- name is is not specified, then the first service will be picked</td>
+ name is is not specified, then the first service will be picked.</td>
</tr>
<tr>
<td>-pn</td>
<td>--port-name</td>
<td>Specifies the port name to be code generated. If the port name is
is not specified, then the first port (of the selected service) will
- be picked</td>
+ be picked.</td>
</tr>
<tr>
<td>-ns2p</td>
<td>--namespace2package</td>
<td>Specifies a comma seperated list of namespaces and packages where
the given package will be used in the place of the auto generated
- package for the relevant namespace. The list will be the format of
+ package for the relevant namespace. The list will be in the format of
ns1=pkg1,ns2=pkg2.</td>
</tr>
<tr>
<td>-ssi</td>
<td>--serverside-interface</td>
- <td>Generate an interface for the service skeleton</td>
+ <td>Generate an interface for the service skeleton.</td>
</tr>
</tbody>
</table>
-<p>Apart from these mentioned options one can pass extra option by prefixing
-them with -E (uppercase). These extra options will be processed by the
-extensions. The extra options that can be passed are documented separately
-with the extensions documentation (For example with ADB)</p>
+<p>Apart from the above mentioned options one can pass extra options by
+prefixing them with -E (uppercase). These extra options will be processed by
+the extensions. The extra options that can be passed are documented
+separately with the extensions documentation (For example with ADB)</p>
<h2>Option References for Java2WSDL</h2>
@@ -189,28 +201,28 @@
<tr>
<td>-o <output Location> :</td>
<td>--output</td>
- <td>output file location. This is where the generated WSDL file would
+ <td>Output file location. This is where the generated WSDL file would
be placed.</td>
</tr>
<tr>
<td>-cp <classpath uri></td>
<td>--classPath</td>
- <td>comma seperated list of URI's representing the classpath</td>
+ <td>Comma seperated list of URI's representing the classpath.</td>
</tr>
<tr>
<td>-tn <target namespace></td>
<td>--targetNamespace</td>
- <td>The target namespace for the WSDL</td>
+ <td>The target namespace for the WSDL.</td>
</tr>
<tr>
<td>-tp <target namespace prefix></td>
<td>--targetNamespacePrefix</td>
- <td>The target namespace prefix for the WSDL</td>
+ <td>The target namespace prefix for the WSDL.</td>
</tr>
<tr>
<td>-sn <serviceName></td>
<td>--serviceName</td>
- <td>The service name to be put in the WSDL service section</td>
+ <td>The service name to be put in the WSDL service section.</td>
</tr>
<tr>
<td>-of <output file name></td>
@@ -220,28 +232,28 @@
<tr>
<td>-stn <schema target namespace></td>
<td>--server-side</td>
- <td>Target namespace for the schema</td>
+ <td>Target namespace for the schema.</td>
</tr>
<tr>
<td>-stp <schema target namespace prefix></td>
<td>--service-description</td>
- <td>target namespace prefix for the schema</td>
+ <td>Target namespace prefix for the schema.</td>
</tr>
<tr>
<td>-st <binding style> :</td>
<td>--databinding-method</td>
- <td>Style to be used for the binding - rpc or document</td>
+ <td>Style to be used for the binding - rpc or document.</td>
</tr>
<tr>
<td>-l <location></td>
<td>--location</td>
- <td>The value to be used in the address field</td>
+ <td>The value to be used in the address field.</td>
</tr>
<tr>
<td>-u <use></td>
<td>--use</td>
<td>The value of the 'use' attribute to be used in the binding, literal
- or encoded</td>
+ or encoded.</td>
</tr>
</tbody>
</table>
More information about the Wsas-java-dev
mailing list