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 ch...@apache.org on 2006/04/27 14:10:29 UTC
svn commit: r397527 - in /webservices/axis2/trunk/java/xdocs/latest:
index.html mail-configuration.html mail-transport.html
Author: chatra
Date: Thu Apr 27 05:10:27 2006
New Revision: 397527
URL: http://svn.apache.org/viewcvs?rev=397527&view=rev
Log:
upgrading docs
Modified:
webservices/axis2/trunk/java/xdocs/latest/index.html
webservices/axis2/trunk/java/xdocs/latest/mail-configuration.html
webservices/axis2/trunk/java/xdocs/latest/mail-transport.html
Modified: webservices/axis2/trunk/java/xdocs/latest/index.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/latest/index.html?rev=397527&r1=397526&r2=397527&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/index.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/index.html Thu Apr 27 05:10:27 2006
@@ -51,7 +51,7 @@
Optimization Mechanism</li>
<li><a>Axis2 Configuration Guide</a>-Explains the three
configurations-global, service and module in Axis2</li>
- <li><a href="api/index.html">Online Java Docs</a></li>
+ <li><a>Online Java Docs</a></li>
<li><a href="adb/adb-howto.html">ADB How-to</a>-Guide on Axis2 Databinding
Framework</li>
<li><a href="adb/adb-tweaking.html">Tweaking the ADB Code
@@ -66,9 +66,13 @@
<li><a href="soapmonitor-module.html">SOAP Monitor How-to</a> -Guide on
utility used to see SOAP messages being used to invoke Web services along
with the results of those messages.</li>
- <li><a href="tcp-transport.html">TCP Transport</a></li>
- <li><a href="mail-transport.html">Mail Transport</a></li>
- <li><a href="http-transport.html">HTTP Transports</a></li>
+ <li><a href="tcp-transport.html">TCP Transport</a> -Guide to send and
+ receive SOAP Messages via TCP in Axis2</li>
+ <li><a href="mail-transport.html">Mail Transport</a> -Explains how to
+ invoke a service using a Mail transport</li>
+ <li><a href="mail-configuration.html">Mail Transport Configuration</a> -</li>
+ <li><a href="http-transport.html">HTTP Transports</a> -Description on HTTP
+ sender and HTTP receiver in Axis2</li>
</ul>
<h2>Articles & Tutorials</h2>
Modified: webservices/axis2/trunk/java/xdocs/latest/mail-configuration.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/latest/mail-configuration.html?rev=397527&r1=397526&r2=397527&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/mail-configuration.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/mail-configuration.html Thu Apr 27 05:10:27 2006
@@ -1,75 +1,118 @@
<!-- saved from url=(0022)http://internet.e-mail -->
<html>
<head>
-<title>Mail transport</title>
-
+ <meta http-equiv="content-type" content="">
+ <title>Mail transport</title>
</head>
-<body><h1>Mail transport</h1>
-<p>The inner workings of the mail transport has two parts, the transport sender and the transport listener. The transport listener is a basic email client which will be on a loop checking for new messages for a particular email address. When an email comes in it will be tunneled into the Axis engine.</p>
-<p>Mail transport can be used against a generic mail server or it can be used like a mailet. The simple mailet provided with Axis2 will direct any message that is coming to a particular address into the Axis engine. The engine will process the message and will use the Transport sender to send the reply.</p>
-<p></p>
-<p>To get started on the mail transport you need the following additional jar dependencies on the classpath.</p>
- <ol>
+<body lang="en">
+<h1>Mail Transport Configuration</h1>
+
+<p>This document provides the guidelines on how to configure Axis2 in order
+to get mail transport working.</p>
+
+<p><i>Send your feedback or questions to: <a
+href="mailto:axis-dev@ws.apache.org">axis-dev@ws.apache.org</a></i>. Prefix
+subject with [Axis2]. To subscribe to mailing list see <a
+href="http://ws.apache.org/axis2/mail-lists.html">here.</a></p>
+
+<h2>Content</h2>
+<ul>
+ <li><a href="#intro">Introduction</a></li>
+ <li><a href="#sender">Transport Sender</a></li>
+ <li><a href="#receiver">Transport Receiver</a></li>
+ <li><a href="#server">Using Mail Transport in the Server Side</a></li>
+ <li><a href="#james">Configure James as SMTP and POP Server</a></li>
+ <li><a href="#included">Using the Included Mail Server</a></li>
+</ul>
+<a name="intro"></a>
+
+<h2>Introduction</h2>
+
+<p>The inner workings of the mail transport has two parts, the transport
+sender and the transport listener. The transport listener is a basic email
+client which will be on a loop checking for new messages for a particular
+email address. When an email comes in it will be tunneled into the Axis
+engine.</p>
+
+<p>Mail transport can be used against a generic mail server or it can be used
+like a mailet. The simple mailet provided with Axis2 will direct any message
+that is coming to a particular address into the Axis engine. The engine will
+process the message and will use the Transport sender to send the reply.</p>
+
+<p>To get started on the mail transport you need the following additional jar
+dependencies on the classpath.</p>
+<ol>
<li>javamail</li>
<li>activation</li>
- </ol>
-<p>We use the Geronimo version of these jars to compile but you will need the sun version to run the code. Specificaly we are using geronimo-spec-javamail-[version].jar and geronimo-spec-activation-[version].jar. These will be downloaded by maven when you run the maven build.</p>
+</ol>
+
+<p>We use the Geronimo version of these jars to compile but you will need the
+sun version to run the code. Specifically we are using
+geronimo-spec-javamail-[version].jar and
+geronimo-spec-activation-[version].jar. These will be downloaded by maven
+when you run the maven build.</p>
+<a name="sender"></a>
<h2>Transport Sender</h2>
-<p>You need to have a mail account to activate the mail functionality. This can either be a generic mail server or you can start up a james mail server. The Mail transport sender can be activated by adding following entry to the axis2.xml file.</p>
- <source>
- <pre>
- <transportSender name="mail" class="org.apache.axis2.transport.mail.MailTransportSender">
+
+<p>You need to have a mail account to activate the mail functionality. This
+can either be a generic mail server or you can start up a James mail server.
+The Mail transport sender can be activated by adding following entry to the
+axis2.xml file.</p>
+<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>
<parameter name="transport.mail.smtp.user" locked="xsd:false">user name</parameter>
<parameter name="transport.mail.smtp.password" locked="xsd:false">password</parameter>
<parameter name="transport.mail.smtp.port" locked="xsd:false">Port on the server for pop</parameter>
</transportSender>
</pre>
- </source>
+</source><a name="receiver"></a>
- <h2>Transport Receiver</h2>
+<h2>Transport Receiver</h2>
- <p>The mail Listener can be activated by adding the following entry to the axis2.xml file.</p>
-
- <source><pre>
- <transportReceiver name="mail" class="org.apache.axis2.transport.mail.SimpleMailListener">
+<p>The mail Listener can be activated by adding the following entry to the
+axis2.xml file.</p>
+<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>
<parameter name="transport.mail.pop3.password" locked="xsd:false">password</parameter>
<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></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>
- <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>
-OMElement payload = ....
+ </pre>
+</source>
+<p>At the Client side if the Mail Listener is needed it is automatically
+started by Axis2.</p>
+<a name="server"></a>
+
+<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>
+<source><pre>java org.apache.axis2.transport.mail.SimpleMailListener repository-directory</pre>
+</source><a name="client"></a>
+
+<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>OMElement payload = ....
MessageSender sender = new MessageSender(serviceContext);
sender.setTo(targetEPR);
sender.setSenderTransport(Constants.TRANSPORT_MAIL);
-sender.send(operationName.getLocalPart(), payload);
-</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 the following code
-</p>
-
-<source>
-<pre>
-$telnet 127.0.0.1 4555
+sender.send(operationName.getLocalPart(), payload);</pre>
+</source><a name="james"></a>
+
+<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 the
+following code</p>
+<source><pre>$telnet 127.0.0.1 4555
Trying 127.0.0.1...
Connected to localhost.localdomain (127.0.0.1).
Escape character is '^]'.
@@ -79,32 +122,30 @@
root
Password:
root
-Welcome root. HELP for a list of commands
-</pre>
+Welcome root. HELP for a list of commands</pre>
</source>
-
<p>Add users to James</p>
-<source>
-<pre>
-adduser axis2-server axis2
+<source><pre>adduser axis2-server axis2
User axis2-server added
adduser axis2-client axis2
User axis2-client added
-Connection closed by foreign host.
-</pre>
+Connection closed by foreign host.</pre>
</source>
+<p>Now James is up and running with the accounts</p>
+<a name="included"></a>
- <p>Now James is up and running with the accounts</p>
-
- <h2>Using the included mail server</h2>
-
- <p>The inbuilt mail server can be started from the command line using the following piece of code when all the needed jars are in the class path.</p>
-<source><pre>java org.apache.axis2.transport.mail.server.MailServer</pre></source>
- <p>The server itself does not need any configuration or tinkering to work. A ConfigurationContext and the ports to operate on are the only details needed. The server will store the mails in memory against the recipient till the recipient pops it from the server. To facilitate the use in *nix environments as a non root user the pop and smtp ports used by default config/test cases are (1024 + 25) and (1024 + 110).</p>
-
- <hr/>
-
- <p> </p>
+<h2>Using the Included Mail Server</h2>
+<p>The inbuilt mail server can be started from the command line using the
+following piece of code when all the needed jars are in the class path.</p>
+<source><pre>java org.apache.axis2.transport.mail.server.MailServer</pre>
+</source>
+<p>The server itself does not need any configuration or tinkering to work. A
+ConfigurationContext and the ports to operate on are the only details needed.
+The server will store the mails in memory against the recipient till the
+recipient pops it from the server. To facilitate the use in *nix environments
+as a non root user the pop and smtp ports used by default config/test cases
+are (1024 + 25) and (1024 + 110).</p>
+<hr>
</body>
</html>
Modified: webservices/axis2/trunk/java/xdocs/latest/mail-transport.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/latest/mail-transport.html?rev=397527&r1=397526&r2=397527&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/mail-transport.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/mail-transport.html Thu Apr 27 05:10:27 2006
@@ -44,10 +44,10 @@
<h2>Introduction</h2>
-<p>To start you will first need to go through the Mail Transport <a
-href="mail-configuration.html" target="_blank">configuration document</a>. It
-will give you all the information you need on how to configure Axis2 to get
-mail transport working.</p>
+<p>To start you will first need to go through the <a
+href="mail-configuration.html" target="_blank">Mail Transport
+Configuration</a> document. It will give you all the information you need on
+how to configure Axis2 to get mail transport working.</p>
<p>Broadly speaking there are 3 ways of calling a service through mail.</p>