You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by de...@apache.org on 2005/07/05 05:27:01 UTC
svn commit: r209197 - in /webservices/axis/trunk/java/xdocs:
mail-transport.html navigation.xml rest-ws.html tcp-transport.html
userguide.html
Author: deepal
Date: Mon Jul 4 20:27:00 2005
New Revision: 209197
URL: http://svn.apache.org/viewcvs?rev=209197&view=rev
Log:
fix some problems which occure when XDocs are generated
Modified:
webservices/axis/trunk/java/xdocs/mail-transport.html
webservices/axis/trunk/java/xdocs/navigation.xml
webservices/axis/trunk/java/xdocs/rest-ws.html
webservices/axis/trunk/java/xdocs/tcp-transport.html
webservices/axis/trunk/java/xdocs/userguide.html
Modified: webservices/axis/trunk/java/xdocs/mail-transport.html
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/xdocs/mail-transport.html?rev=209197&r1=209196&r2=209197&view=diff
==============================================================================
--- webservices/axis/trunk/java/xdocs/mail-transport.html (original)
+++ webservices/axis/trunk/java/xdocs/mail-transport.html Mon Jul 4 20:27:00 2005
@@ -16,7 +16,7 @@
<h2>Transport Sender</h2>
<p>You need a mail account in a SMTP server, and Mail transport sender can be activated by adding following entry to the axis2.xml file.</p>
- <code>
+ <source>
<pre>
<transportSender name="mail" class="org.apache.axis2.transport.mail.MailTransportSender">
<parameter name="transport.mail.smtp.host" locked="xsd:false">smtp server host</parameter>
@@ -25,13 +25,13 @@
<parameter name="transport.mail.smtp.port" locked="xsd:false">Port on the server for pop</parameter>
</transportSender>
</pre>
- </code>
+ </source>
<h2>Transport Receiver</h2>
<p>You need a mail address that has pop access, the mail Listener can be activated by adding following entry to the axis2.xml file.</p>
- <code><pre>
+ <source><pre>
<transportReceiver name="mail" class="org.apache.axis2.transport.mail.SimpleMailListener">
<parameter name="transport.mail.pop3.host" locked="xsd:false">pop server host</parameter>
<parameter name="transport.mail.pop3.user" locked="xsd:false">user name</parameter>
@@ -39,18 +39,18 @@
<parameter name="transport.mail.pop3.port" locked="xsd:false">Port on the server for smtp</parameter>
<parameter name="transport.mail.replyToAddress" locked="xsd:false">email address</parameter>
</transportReceiver>
- </pre></code>
+ </pre></source>
<p>At the Client side if the Mail Listener is needed it is automatically started by Axis2.</p>
<h2>Using Mail transport in the Server Side</h2>
<p> If the Mail Listener is need to be started as the server it can be done with following command with the all the axis2 jars and the mail dependency jars in the classpath.</p>
- <code>java org.apache.axis2.transport.mail.SimpleMailListener repository-directory</code>
+ <source><pre>java org.apache.axis2.transport.mail.SimpleMailListener repository-directory</pre></source>
<h2>Using Mail transport in the Client Side</h2>
<p>Following code segment shows how to send a oneway SOAP message using the mail transport, this need the Transport Sender configured.</p>
+<source>
<pre>
-<code>
OMElement payload = ....
MessageSender sender = new MessageSender(serviceContext);
@@ -58,15 +58,15 @@
sender.setSenderTransport(Constants.TRANSPORT_MAIL);
sender.send(operationName.getLocalPart(), payload);
-</code>
</pre>
+</source>
<h2>Configure James as SMTP and POP server</h2>
<p>Download the <a href="http://james.apache.org/">Apache James</a> and start James, connect to the James via telnet for administrator James with following code
</p>
+<source>
<pre>
-<code>
$telnet 127.0.0.1 4555
Trying 127.0.0.1...
Connected to localhost.localdomain (127.0.0.1).
@@ -78,19 +78,19 @@
Password:
root
Welcome root. HELP for a list of commands
-</code>
</pre>
+</source>
<p>Add users to James</p>
+<source>
<pre>
-<code>
adduser axis2-server axis2
User axis2-server added
adduser axis2-client axis2
User axis2-client added
Connection closed by foreign host.
-</code>
</pre>
+</source>
<p>Now James is up and running with the accounts</p>
Modified: webservices/axis/trunk/java/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/xdocs/navigation.xml?rev=209197&r1=209196&r2=209197&view=diff
==============================================================================
--- webservices/axis/trunk/java/xdocs/navigation.xml (original)
+++ webservices/axis/trunk/java/xdocs/navigation.xml Mon Jul 4 20:27:00 2005
@@ -1,54 +1,54 @@
-<!-- Created By Eran Chinthaka -->
-<project name="Axis2.0">
- <title>Axis 2.0</title>
- <body>
-
- <menu name="Axis 2.0">
- <item name="Home" href="index.html"/>
- <item name="Get Invloved" href="svn.html">
- <item name="Overview" href="overview.html"/>
- <item name="Setting Up" href="svn.html"/>
- <item name="Guide Lines" href="guidelines.html"/>
- <item name="Reference Library" href="refLib.html"/>
- <item name="Mailing Lists" href="mail-lists.html"/>
- <item name="How to build site" href="siteHowTo.html"/>
- </item>
-
- <item name="References">
- <item name="Documentation" href="docs.html" />
- <item name="Wiki" href="http://wiki.apache.org/ws/FrontPage/Axis2"/>
- <item name="Architecture Guide" href="Axis2ArchitectureGuide.html" />
- <item name="User Guide" href="userguide.html" />
- <item name="Installation Guide" href="installationguide.html" />
- <item name="Web Administration Guide" href="webadminguide.html" />
- <item name="AXIOM Tutorial" href="OMTutorial.html" />
- <item name="Code Generation Tutorial" href="CodegenToolReference.html" />
- <item name="REST Support" href="rest-ws.html" />
- <item name="REST Support" href="mtom-guide.html" />
- <item name="M1 Documents" href="m1.html" />
- </item>
-
- <item name="Downloads">
- <item name="Releases" href="releases.html" />
- <item name="Source Code" href="http://svn.apache.org/viewcvs.cgi/webservices/axis/trunk/?root=Apache-SVN" />
- <item name="Tools" href="axis2tools.html" />
- </item>
- <item name="Modules">
- <item name="Core" href="multiproject/axis2-core/index.html" />
- <item name="XML" href="multiproject/axis2-xml/index.html" />
- <item name="WSDL" href="multiproject/axis2-wsdl/index.html" />
- <item name="Tools" href="multiproject/axis2-tools/index.html" />
- <item name="Samples" href="multiproject/axis2-samples/index.html" />
- </item>
- <item name="Project Information">
- <item name="Mailing Lists" href="mail-lists.html" />
- <item name="Project Team" href="team-list.html" />
- <item name="Issue Tracking" href="issue-tracking.html" />
- </item>
-
- </menu>
-
-
-
- </body>
+<!-- Created By Eran Chinthaka -->
+<project name="Axis2.0">
+ <title>Axis 2.0</title>
+ <body>
+
+ <menu name="Axis 2.0">
+ <item name="Home" href="index.html"/>
+ <item name="Get Invloved" href="svn.html">
+ <item name="Overview" href="overview.html"/>
+ <item name="Setting Up" href="svn.html"/>
+ <item name="Guide Lines" href="guidelines.html"/>
+ <item name="Reference Library" href="refLib.html"/>
+ <item name="Mailing Lists" href="mail-lists.html"/>
+ <item name="How to build site" href="siteHowTo.html"/>
+ </item>
+
+ <item name="References">
+ <item name="Documentation" href="docs.html" />
+ <item name="Wiki" href="http://wiki.apache.org/ws/FrontPage/Axis2"/>
+ <item name="Architecture Guide" href="Axis2ArchitectureGuide.html" />
+ <item name="User Guide" href="userguide.html" />
+ <item name="Installation Guide" href="installationguide.html" />
+ <item name="Web Administration Guide" href="webadminguide.html" />
+ <item name="AXIOM Tutorial" href="OMTutorial.html" />
+ <item name="Code Generation Tutorial" href="CodegenToolReference.html" />
+ <item name="REST Support" href="rest-ws.html" />
+ <item name="MTOM with Axis2" href="mtom-guide.html" />
+ <item name="M1 Documents" href="m1.html" />
+ </item>
+
+ <item name="Downloads">
+ <item name="Releases" href="releases.html" />
+ <item name="Source Code" href="http://svn.apache.org/viewcvs.cgi/webservices/axis/trunk/?root=Apache-SVN" />
+ <item name="Tools" href="axis2tools.html" />
+ </item>
+ <item name="Modules">
+ <item name="Core" href="multiproject/axis2-core/index.html" />
+ <item name="XML" href="multiproject/axis2-xml/index.html" />
+ <item name="WSDL" href="multiproject/axis2-wsdl/index.html" />
+ <item name="Tools" href="multiproject/axis2-tools/index.html" />
+ <item name="Samples" href="multiproject/axis2-samples/index.html" />
+ </item>
+ <item name="Project Information">
+ <item name="Mailing Lists" href="mail-lists.html" />
+ <item name="Project Team" href="team-list.html" />
+ <item name="Issue Tracking" href="issue-tracking.html" />
+ </item>
+
+ </menu>
+
+
+
+ </body>
</project>
Modified: webservices/axis/trunk/java/xdocs/rest-ws.html
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/xdocs/rest-ws.html?rev=209197&r1=209196&r2=209197&view=diff
==============================================================================
--- webservices/axis/trunk/java/xdocs/rest-ws.html (original)
+++ webservices/axis/trunk/java/xdocs/rest-ws.html Mon Jul 4 20:27:00 2005
@@ -26,15 +26,15 @@
from the client API or by deployment descriptor of the client.</p>
<ol>
<li> By adding an entry in the client.xml file similar to that of the axis.xml.</li>
-<li>Through client API e.g. <code>call.setDoREST(true);</code>;</li>
+<li>Through client API e.g. <source><pre>call.setDoREST(true);</pre></source>;</li>
</ol>
<h3>Sample REST - HTTP POST Client</h3>
<p>There's a userguide.clients.RESTClient.java which demonstrates the usage of the above, using
-the <code>echo</code> operation of the <code>userguide.example1.MyService</code> of the samples.
+the <source><pre>echo</pre></source> operation of the <source><pre>userguide.example1.MyService</pre></source> of the samples.
And the class source will be as follows
+<source>
<pre>
-<code>
public class MyServiceClient {
private static String toEpr = "http://localhost:8080/axis2/services/MyService";
public static void main(String[] args) throws AxisFault {
@@ -49,24 +49,26 @@
call.close();
}
}
-</code>
</pre>
+</source>
<h2>Access a REST Web Service Via HTTP GET</h2>
<p>Axis2 let the users access Web Service that has simple type parameters via the HTTP GET.
For example following URL requests the version service Via HTTP GET. But the Web Services
arrived via GET assumes REST . Other parameter are converted in to the XML and put them in to the SOAP Body.</p>
- <code>http://127.0.0.1:8080/axis2/services/Version/getVersion</code>
+ <source><pre>http://127.0.0.1:8080/axis2/services/Version/getVersion</pre></source>
<p>Result can be shown in the browser as follows.</p>
<img src="images/userguide/http-get-ws.png"/>
- <p>For an example request <code>http://127.0.0.1:8080/axis2/services/Version/getVersion/code>
+ <p>For an example request <source><pre>http://127.0.0.1:8080/axis2/services/Version/getVersion</pre></source>
will be converted to the following SOAP Message for processing by Axis2</p>
- <pre>
+<source>
+<pre>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<axis2:getVersion xmlns:axis2="http://ws.apache.org/goGetWithREST" />
</soapenv:Body>
</soapenv:Envelope>
</pre>
+</source>
</body></html>
Modified: webservices/axis/trunk/java/xdocs/tcp-transport.html
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/xdocs/tcp-transport.html?rev=209197&r1=209196&r2=209197&view=diff
==============================================================================
--- webservices/axis/trunk/java/xdocs/tcp-transport.html (original)
+++ webservices/axis/trunk/java/xdocs/tcp-transport.html Mon Jul 4 20:27:00 2005
@@ -27,8 +27,7 @@
<h2>How send SOAP Messages with TCP transport</h2>
<p>The TCP transport can be enabled very easily from the call API, following code segment demonstrate how it can be done.</p>
-<code>
-<pre>
+<source><pre>
OMElement payload = ...
org.apache.axis2.clientapi.Call call = new org.apache.axis2.clientapi.Call(serviceContext);
@@ -40,7 +39,7 @@
(OMElement) call.invokeBlocking("echo", payload);
call.close();
</pre>
-</code>
+</source>
<p>The method to note is setTransportInfo that accepts sender transport, Listener transport and should the return path of the TCP Channel need to be used. It is good Idea to engage the addressing module to make the SOAP Message self contained. Only other option I can think of is to use the URI of the first child of the SOAP Body to dispatch the service. The
Parameter is of the type <a href="faq.html#a2">OMElement</a>, the XML represntation of Axis2.</p>
@@ -55,17 +54,14 @@
In the axis2.xml configuration file the two would look like follows. </p>
<p>If the TCP server is started manually this configuration does not take effect, this affect the transport
Listeners starts by Axis2. (e.g. Listener started by the Complete Async interaction)</p>
-<code>
-<pre>
+<source><pre>
<transportReceiver name="tcp" class="org.apache.axis2.transport.tcp.TCPServer">
<parameter name="port" locked="xsd:false">:6060</parameter>
</transportReceiver>
</pre>
-</code>
-
+</source>
<p>Following add the TCPtransport Sender</p>
-<code>
-<transportSender name="tcp" class="org.apache.axis2.transport.tcp.TCPTransportSender"/>
-</code>
+<source><pre><transportSender name="tcp" class="org.apache.axis2.transport.tcp.TCPTransportSender"/>
+</pre></source>
</body>
</html>
Modified: webservices/axis/trunk/java/xdocs/userguide.html
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/xdocs/userguide.html?rev=209197&r1=209196&r2=209197&view=diff
==============================================================================
--- webservices/axis/trunk/java/xdocs/userguide.html (original)
+++ webservices/axis/trunk/java/xdocs/userguide.html Mon Jul 4 20:27:00 2005
@@ -1072,7 +1072,9 @@
<a href="mail-transport.html">Mail Transport</a></li>
<li>
<a href="http-transport.html">HTTP Transports</a></li>
- </ul>
+ <li>
+ <a href="mtom-guide.html">MTOM with Axis2</a></li>
+</ul>