stevel 2002/12/16 16:14:45
Modified: java/docs index.html reading.html reference.html
java/docs/ant axis-java2wsdl.html axis-wsdl2java.html
Log:
1. added config info to reference manual. More needed!
2. rebuilt ant task docs
3. tweaks to the reading page
4. more stuff (and slightly different look) on the index
Revision Changes Path
1.10 +15 -4 xml-axis/java/docs/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/xml-axis/java/docs/index.html,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- index.html 22 Nov 2002 20:52:06 -0000 1.9
+++ index.html 17 Dec 2002 00:14:45 -0000 1.10
@@ -12,8 +12,13 @@
<h1>
<img SRC="images/axis.jpg" height=96 width=176></h1></center>
-<h1>
-Documentation</h1>
+<h1>Documentation</h1>
+
+This is the documentation for <a href="http://xml.apache.org/axis/";>Apache Axis
1.1</a>
+If the version of Axis you are using is older or newer than this version, then this
+is the wrong documentation to be using. Read the version that came with your copy
of Axis.
+
+<h2>Documentation for Axis Users</h2>
<ul>
<li>
@@ -26,7 +31,14 @@
<a href="reading.html">Further Reading</a></li>
<li>
-Development Documention</li>
+<a href="ant/ant.html">Axis Ant Tasks</a></li>
+
+<li>
+<a href="reference.html">Reference Material</a></li>
+
+</ul>
+
+<h2>Documentation for Axis Developers</h2>
<ul>
<li>
@@ -47,7 +59,6 @@
<li>
<a href="architecture-guide.html">Architecture Guide</a> - Axis design concepts and
rationale.</li>
-</ul>
</ul>
</body>
1.12 +17 -11 xml-axis/java/docs/reading.html
Index: reading.html
===================================================================
RCS file: /home/cvs/xml-axis/java/docs/reading.html,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- reading.html 9 Nov 2002 05:34:30 -0000 1.11
+++ reading.html 17 Dec 2002 00:14:45 -0000 1.12
@@ -28,7 +28,7 @@
by Pankaj Kumar.
Starting with a 10000 ft. view of Web Services, prior technologies, current and
emerging
standards, it quickly gets into the nitty-gritties of using JAX-RPC and Apache
Axis
- for writing and executing programs. Has a nice coverage of different invocation
styles --
+ for writing and executing programs. Has a nice coverage of different invocation
styles -
generated stubs, dynamic proxy and dynamic invocation interface. A good place
to start
if you are new to Web Services and Axis.
<br/>
@@ -43,8 +43,8 @@
<li><a href="http://www.sosnoski.com/presents/java-xml/axis/axis-monitor.html";>
Enabling SOAPMonitor in Axis 1.0</a>.<br>
- How to turn the SOAP monitor on and off, and use it to log your
- Soap application.
+ Dennis Sosnoski on how to turn the SOAP monitor on and off, and use it to log
your
+ application.
</ol>
<a name="specifications">
@@ -215,8 +215,8 @@
<li><i><a href="http://www.wrox.com/books/1861007531.htm";>
Beginning Java Web Services</a></i>
Meeraj Kunnumpurath et al, Wrox Press, September 2002.<br>
- An introductory book, with the early chapters focusing on Axis. The
- <a
href="http://www.wrox.com/books/sample-chapters/SampleChapter_1861007531.pdf";>
+ An introductory book, with the early chapters focusing on Axis. <br>
+ The <a
href="http://www.wrox.com/books/sample-chapters/SampleChapter_1861007531.pdf";>
sample chapter</a> shows how to install Axis with Tomcat 4.0: we do not believe
that their approach is the best. It is easier to drop jaxrpc.jar and
saaj.jar into the CATALINA_HOME/common/lib dir than it is to add all
@@ -224,14 +224,14 @@
<li>
<a href="http://manning.com/antbook";>
- <i>Java development with Ant</i>i>
+ <i>Java development with Ant</i>
</a><br>
by Erik Hatcher and Steve Loughran, Manning Press, July 2002. <br>
A book on Ant development which covers Web Service development with Axis,
along with other topics relevant to Java developers using Ant. The Web Service
chapter, <A href="http://www.manning.com/hatcher/chap15.pdf";>
chapter 15</A>, is free to download, and was the birthplace of
- happyaxis.jar.
+ happyaxis.jar. <br>
The book is based on Axis Beta-2; the web site contains updated
documentation where appropriate.
@@ -242,8 +242,14 @@
<i>AXIS: Next Generation Java SOAP</i>
</A>
by Romin Irani and S Jeelani Bashna, Wrox Press, May 2002.<br>
- The first nothing but Axis book.
- It is based on Beta-1.
+ The first nothing-but-Axis book.<br>
+ It is based on Beta-1. This is a reasonable book, despite is apparent thinness
and
+ relative age. If it has a major weakness it believes everything works as
intended,
+ which regular Axis users will know is not quite true yet. Maybe they didn't want
+ to fault missing features and other gotchas, assuming they would be fixed by
the time
+ the product shipped, but the effective result is that you can get into minor
trouble working
+ from this book, trying to use bits that aren't there, or just don't work (yet).
+
<li>
<A
href="http://sams.com/catalog/product.asp?product_id={ABC81EE6-0D9F-4BD7-99DB-84F9C983ACF7}";>
@@ -254,10 +260,10 @@
Covering very early versions of Axis
along with other aspects of Web Service technologies. One of the
authors, Glen Daniels, is an Axis committer and active contributor, so
- the quality of the Axis is high.
+ the quality of the Axis coverage is high. Good explanations of SOAP, UDDI, and
the like.
</ol>
Authors, publishers: we welcome additions to this section of any books which
-have some explicit coverage of Axis.
+have some explicit coverage of Axis. Free paper/pdf copies and other forms of
bribery accepted.
1.16 +122 -1 xml-axis/java/docs/reference.html
Index: reference.html
===================================================================
RCS file: /home/cvs/xml-axis/java/docs/reference.html,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- reference.html 7 Nov 2002 07:43:50 -0000 1.15
+++ reference.html 17 Dec 2002 00:14:45 -0000 1.16
@@ -8,15 +8,19 @@
<body>
<h1 align="center"><IMG height=96 src="images/axis.jpg" width=176></h1>
<h1>Axis Reference Guide</h1>
-<p><i>1.0 Version</i></p>
+<p><i>1.1 Version</i></p>
<h3>Table of Contents</h3>
<ul>
<li><a href="#Tools">Tools Reference</a></li>
<ul>
<li><a href="#WSDL2Java">WSDL2Java</a></li>
<li><a href="#Java2WSDL">Java2WSDL</a></li>
+ <li><a href="#Java2WSDL">Java2WSDL</a></li>
</ul>
<li><a href="#Deployment">Deployment (WSDD) Reference</a></li>
+ <li><a href="#global_configuration">Global Axis Configuration</a></li>
+ <li><a href="#individual_service">Individual Service Configuration</a></li>
+ <li><a href="#axis_components" >Pre-Configured Axis Components Reference</a></li>
</ul>
<h2> <a name="Tools"></a>Tools Reference</h2>
<h3><a name="WSDL2Java"></a>WSDL2Java Reference</h3>
@@ -537,6 +541,123 @@
follow the JavaBean standard pattern of get/set accessors.</dd>
</dl>
<p> </p>
+
+
+
+<a name="global_configuration" />
+<h2>Global Axis Configuration</h2>
+
+The server is configured (by default) by values in the
+server-config.wsdd file, though a dedicated Axis user can write their
+own configuration handler, and so store configuration data in an LDAP
+server, database, remote web service, etc. Consult the source on details
+as to how to do that. You can also add options to the web.xml file and
+have them picked up automatically. We don't encourage that as it is nice
+to keep configuration stuff in one place.
+
+<p>
+
+In the server-config file, there is a global configuration section,
+which supports parameter name/value pairs as nested elements. Here are
+the options that we currently document, though there may be more
+(consult the source, as usual).
+
+<pre> <globalConfiguration>
+ <parameter name="adminPassword" value="admin"/>
+ <parameter name="attachments.Directory"
value="c:\temp\attachments"/>
+ <parameter name="sendMultiRefs" value="true"/>
+ <parameter name="sendXsiTypes" value="true"/>
+ <parameter name="attachments.implementation"
value="org.apache.axis.attachments.AttachmentsImpl"/>
+ <parameter name="sendXMLDeclaration" value="true"/>
+ <parameter name="enable2DArrayEncoding" value="true"/>
+ </globalConfiguration>
+</pre>
+<table>
+<tr><td><b>enable2DArrayEncoding</b></td>
+<td>Set this to "true" to turn 2D array encoding on; this encoding is incompatible
with .NET 1.0: default="false".
+</td>
+</tr>
+
+<tr><td><b>adminPassword</b></td>
+<td>Adminstrator password, as used by AdminService.
+</td>
+</tr>
+
+<tr><td><b>attachments.Directory</b></td>
+<td>The directory where attachments end up. This should be in the syntax
+appropriate for the target platform.
+</td>
+</tr>
+
+<tr><td><b>sendXsiTypes</b></td>
+<td>true/false flag to enable/disable sending the type of every value sent over the
wire.
+Defaults to true.
+</td>
+</tr>
+
+<tr><td><b>sendMultiRefs</b></td>
+<td>true/false flag to control whether multirefs are sent or not.
+</td>
+</tr>
+
+<tr><td><b>sendXMLDeclaration</b></td>
+<td>true/false flag to control whether the <?xml?> declaration is sent in
messages
+</td>
+</tr>
+
+<tr><td><b>attachments.implementation</b></td>
+<td>
+
+Name of class that implements attachments support. Default is
+<tt>org.apache.axis.attachments.AttachmentsImpl</tt>
+
+</td>
+</tr>
+
+<tr><td><b></b></td>
+<td>
+</td>
+</tr>
+
+</table>
+
+<a name="individual_service" />
+
+<h2>Individual Service Configuration</h2>
+
+<i>TODO</i>
+<p>
+
+Here are some of the per-service configuration options are available;
+these can be set in the wsdd file used to deploy a service, from where
+they will be picked up.
+<p>
+More may exist.
+
+<table>
+
+<tr><td><b>style</b></td>
+<td>whether to use RPC:enc or doc/lit encoding
+</td>
+</tr>
+
+<tr><td><b>wsdlFile</b></td>
+<td>The path to a WSDL File; can be an absolute path or
+a resource that axis.jar can load. Useful to export
+your custom WSDL file.
+
+</td>
+</tr>
+<!-- TODO: what does this mean?
+ <tr><td><b>streaming</b></td>
+<td>
+</td>
+</tr>
+ -->
+</table>
+
+<a name="axis_components" />
+
<h2>Pre-Configured Axis Components Reference</h2>
<h3>On the server:</h3>
<dl>
1.4 +0 -16 xml-axis/java/docs/ant/axis-java2wsdl.html
Index: axis-java2wsdl.html
===================================================================
RCS file: /home/cvs/xml-axis/java/docs/ant/axis-java2wsdl.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- axis-java2wsdl.html 1 Nov 2002 20:14:56 -0000 1.3
+++ axis-java2wsdl.html 17 Dec 2002 00:14:45 -0000 1.4
@@ -152,22 +152,6 @@
<!-- Attribute -->
<tr>
<td bgcolor="#eeeeee" valign="top" align="left">
- <font color="#000000" size="-1"
face="arial,helvetica,sanserif">importSchema</font>
- </td>
- <td bgcolor="#eeeeee" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Optional attribute that indicates the name of an XML Schema
- file that should be physically imported into the generated wsdl's
- types section.
- </font>
- </td>
- <td bgcolor="#eeeeee" valign="top" align="left">
- <font color="#000000" size="-1"
face="arial,helvetica,sanserif">java.io.File</font>
- </td>
- </tr>
- <!-- Attribute -->
- <tr>
- <td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1"
face="arial,helvetica,sanserif">input</font>
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
1.3 +3 -3 xml-axis/java/docs/ant/axis-wsdl2java.html
Index: axis-wsdl2java.html
===================================================================
RCS file: /home/cvs/xml-axis/java/docs/ant/axis-wsdl2java.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- axis-wsdl2java.html 25 Oct 2002 06:29:06 -0000 1.2
+++ axis-wsdl2java.html 17 Dec 2002 00:14:45 -0000 1.3
@@ -139,7 +139,7 @@
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- add scope to deploy.xml: "Application", "Request", "Session"
+ add scope to deploy.xml: "Application", "Request", "Session"
optional;
</font>
</td>
@@ -154,7 +154,7 @@
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- name of the Java2WSDLFactory class for
+ name of the Java2WSDLFactory class for
extending WSDL generation functions
</font>
</td>
@@ -243,7 +243,7 @@
</td>
<td bgcolor="#eeeeee" valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- deploy skeleton (true) or implementation (false) in deploy.wsdd.
+ deploy skeleton (true) or implementation (false) in deploy.wsdd.
Default is false. Assumes server-side="true".
</font>
</td>
