You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-commits@axis.apache.org by ve...@apache.org on 2012/01/09 13:33:07 UTC
svn commit: r1229114 - /axis/axis1/java/trunk/src/site/xdoc/reference.xml
Author: veithen
Date: Mon Jan 9 12:33:06 2012
New Revision: 1229114
URL: http://svn.apache.org/viewvc?rev=1229114&view=rev
Log:
Migrated the Reference Guide from Forrest.
Added:
axis/axis1/java/trunk/src/site/xdoc/reference.xml
- copied, changed from r1229062, webservices/axis/trunk/site/src/java/src/documentation/content/xdocs/java/reference.xml
Copied: axis/axis1/java/trunk/src/site/xdoc/reference.xml (from r1229062, webservices/axis/trunk/site/src/java/src/documentation/content/xdocs/java/reference.xml)
URL: http://svn.apache.org/viewvc/axis/axis1/java/trunk/src/site/xdoc/reference.xml?p2=axis/axis1/java/trunk/src/site/xdoc/reference.xml&p1=webservices/axis/trunk/site/src/java/src/documentation/content/xdocs/java/reference.xml&r1=1229062&r2=1229114&rev=1229114&view=diff
==============================================================================
--- webservices/axis/trunk/site/src/java/src/documentation/content/xdocs/java/reference.xml (original)
+++ axis/axis1/java/trunk/src/site/xdoc/reference.xml Mon Jan 9 12:33:06 2012
@@ -1,51 +1,39 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "./dtd/document-v12.dtd">
-<document>
- <header>
- <title>WebServices - Axis</title>
- </header>
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one
+ ~ or more contributor license agreements. See the NOTICE file
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~ with the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+ <properties>
+ <title>Reference Guide</title>
+ </properties>
<body>
-<a name="AxisReferenceGuide"/>
-<section>
-<title>Axis Reference Guide</title>
-
-<p><i>1.2 Version</i><br/>
-<i>Feedback: <a href="mailto:axis-dev@ws.apache.org">axis-dev@ws.apache.org</a></i></p>
-
-<a name="TableOfContents"/>
-<section>
-<title>Table of Contents</title>
+<section name="Table of Contents">
-<ul>
- <li><a href="#ToolsReference">Tools Reference</a></li>
- <ul>
- <li><a href="#WSDL2JavaReference">WSDL2Java Reference</a></li>
- <li><a href="#Java2WSDLReference">Java2WSDL Reference</a></li>
- </ul>
- <li><a href="#DeploymentWSDDReference">Deployment (WSDD) Reference</a></li>
- <li><a href="#GlobalAxisConfiguration">Global Axis Configuration</a></li>
- <li><a href="#IndividualServiceConfiguration">Individual Service Configuration</a></li>
- <li><a href="#AxisLoggingConfiguration">Axis Logging Configuration</a></li>
- <ul>
- <li><a href="#LogCategories">Log Categories</a></li>
- </ul>
- <li><a href="#Pre-ConfiguredAxisComponentsReference">Pre-Configured Axis Components Reference</a></li>
- <ul>
- <li><a href="#OnTheServer">On the server</a></li>
- <li><a href="#OnTheClient">On the client</a></li>
- </ul>
-</ul>
+<macro name="toc"/>
</section>
-<a name="ToolsReference"/>
-<section>
-<title>Tools Reference</title>
-
-<a name="WSDL2JavaReference"/>
-<section>
-<title>WSDL2Java Reference</title>
+<section name="Tools Reference">
+
+<subsection name="WSDL2Java Reference">
<p>Usage: java org.apache.axis.wsdl.WSDL2Java [options] WSDL-URI<br/>
Options:</p>
@@ -212,11 +200,9 @@ Note that the anchor is searched for in
</dl>
-</section>
+</subsection>
-<a name="Java2WSDLReference"/>
-<section>
-<title>Java2WSDL Reference</title>
+<subsection name="Java2WSDL Reference">
<p>Here is the help message generated from the current tool:</p>
<p>Java2WSDL emitter<br/>
@@ -385,13 +371,11 @@ Service
</dl>
-</section>
+</subsection>
</section>
-<a name="DeploymentWSDDReference"/>
-<section>
-<title>Deployment (WSDD) Reference</title>
+<section name="Deployment (WSDD) Reference">
<p>Note : all the elements referred to in this section are in the WSDD namespace, namely "http://xml.apache.org/axis/wsdd/".</p>
@@ -418,14 +402,14 @@ Service
<dt><service name="<i>name</i>" provider="<i>provider</i>" ></dt>
<dd>Deploys/undeploys an Axis Service. This is the most complex WSDD tag, so we're going to spend a little time on it.<br/><br/>
-<b>Options</b> may be specified as follows : <CODE><b><parameter name="</b>name<b>" value="</b>value<b>"/></b></CODE>, and common ones include:
+<b>Options</b> may be specified as follows : <code><b><parameter name="</b>name<b>" value="</b>value<b>"/></b></code>, and common ones include:
<ul>
<li><b>className</b> : the backend implementation class</li>
<li><b>allowedMethods</b> : Each provider can determine which methods are allowed to be exposed as web services.<br/>
To summaries for Axis supplied providers:
<p><u>Java RPC Provider</u> (provider="java:RPC") by default all public methods specified by the class in the className option, including any inherited methods are available as web services.<br/>
For more details regarding the Java Provider please see <b>WHERE???</b>.</p>
-<p><U>Java MsgProvder</U> (provider="java:MSG") <!-- Glen to provide details --></p>
+<p><u>Java MsgProvder</u> (provider="java:MSG") <!-- Glen to provide details --></p>
<p>In order to further restrict the above methods, the <b>allowedMethods</b> option may be used to specify in a space delimited list the names of only those methods which are allowed as web services. It is also possible to specify for this option the value <b>"*"</b> which is functionally equivalent to not specify the option at all. Also, it is worth mentioning that the <b>operation</b> element is used to further define the methods being offered, but it does not affect which methods are made available.</p>
<p><i>Note, while this is true for Axis supplied providers, it is implementation dependent on each individual provider. Please review your providers
documentation on how or if it supports this option.</i></p>
@@ -506,9 +490,7 @@ Example:
</section>
-<a name="GlobalAxisConfiguration"/>
-<section>
-<title>Global Axis Configuration</title>
+<section name="Global Axis Configuration">
<p>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>
@@ -629,7 +611,7 @@ alternate configuration mechanisms.</td>
encoded types when it is using SOAP encoding for a service. See JAX-RPC 1.1, section 4.2.1.
Note: You can also set this flag by setting the static property on the TypeMappingImpl class:
<p>
-<pre>TypeMappingImpl.dotnet_soapenc_bugfix = true;</pre>
+<source>TypeMappingImpl.dotnet_soapenc_bugfix = true;</source>
</p>
</td>
</tr>
@@ -639,9 +621,7 @@ alternate configuration mechanisms.</td>
</section>
-<a name="IndividualServiceConfiguration"/>
-<section>
-<title>Individual Service Configuration</title>
+<section name="Individual Service Configuration">
<p><i>TODO</i></p>
@@ -670,9 +650,7 @@ alternate configuration mechanisms.</td>
</section>
-<a name="AxisLoggingConfiguration"/>
-<section>
-<title>Axis Logging Configuration</title>
+<section name="Axis Logging Configuration">
<p>Axis uses the Jakarta Projects's <a href="http://jakarta.apache.org/commons/logging/">commons-logging API</a>, as implemented in <code>commons-logging.jar</code> to implement logging throughout the code. Normally this library routes the logging to the Log4j library, provided that an implementation of log4j is on the classpath of the server or client. The commons-logging API can also bind to Avalon, <code>System.out</code> or the Java1.4 logger. The JavaDocs for the library explain the process for selecting a logger, which can be done via a system property or a properties file in the classpath.</p>
@@ -685,9 +663,7 @@ alternate configuration mechanisms.</td>
<li>Edit this log4J properties file to your hearts content. Server side, setting up rolling logs with fancy html output is convenient, though once you start clustering the back end servers that ceases to be as usuable. Log4J power tools, such as 'chainsaw', are the secret here.</li>
</ol>
-<a name="LogCategories"/>
-<section>
-<title>Log Categories</title>
+<subsection name="Log Categories">
<p>Axis classes that log information create their own per-class log, each of which may output information at different levels. For example, the main entry point servlet has a log called <code>org.apache.axis.transport.http.AxisServlet</code>, the AxisEngine is <code>org.apache.axis.AxisEngine</code>, and so on. There are also special logs for special categories.</p>
@@ -710,17 +686,13 @@ alternate configuration mechanisms.</td>
</table>
-</section>
+</subsection>
</section>
-<a name="Pre-ConfiguredAxisComponentsReference"/>
-<section>
-<title>Pre-Configured Axis Components Reference</title>
-
-<a name="OnTheServer"/>
-<section>
-<title>On the server</title>
+<section name="Pre-Configured Axis Components Reference">
+
+<subsection name="On the server">
<dl>
@@ -778,11 +750,9 @@ alternate configuration mechanisms.</td>
</dl>
-</section>
+</subsection>
-<a name="OnTheClient"/>
-<section>
-<title>On the client</title>
+<subsection name="On the client">
<dl>
@@ -802,9 +772,7 @@ alternate configuration mechanisms.</td>
</dl>
-</section>
-
-</section>
+</subsection>
</section>