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 10:27:52 UTC
svn commit: r397476 - in /webservices/axis2/trunk/java/xdocs/latest:
http-transport.html index.html soapmonitor-module.html tcp-transport.html
Author: chatra
Date: Thu Apr 27 01:27:37 2006
New Revision: 397476
URL: http://svn.apache.org/viewcvs?rev=397476&view=rev
Log:
made upgredes and corrections
Modified:
webservices/axis2/trunk/java/xdocs/latest/http-transport.html
webservices/axis2/trunk/java/xdocs/latest/index.html
webservices/axis2/trunk/java/xdocs/latest/soapmonitor-module.html
webservices/axis2/trunk/java/xdocs/latest/tcp-transport.html
Modified: webservices/axis2/trunk/java/xdocs/latest/http-transport.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/latest/http-transport.html?rev=397476&r1=397475&r2=397476&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/http-transport.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/http-transport.html Thu Apr 27 01:27:37 2006
@@ -1,149 +1,165 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
- <meta http-equiv="content-type" content="">
- <title>HTTP transports</title>
-</head>
-
-<body lang="en">
-<a name="configTransport"/>
-<h1>HTTP transports</h1>
-
-<h3>CommonsHTTPTransportSender</h3>
-
-<p>This is the default transport sender that is used in Server API as well as
-Client API. As the name implies it is based on commons-httpclient-3.0-rc3. In
-order to acquire the maximum flexibility, this sender has implemented POST
-interface and GET interface. GET interface is provided to help axis2 support
-REST.</p>
-
-<p>Chunking support and KeepAlive support is also integrated via the
-facilities provided by commons-httpclient along with HTTP 1.1 support.</p>
-
-<p><transportSender/> element is used to define transport senders in
-the axis2.xml as follows:</p>
-<pre><transportSender name="http" class="org.apache.axis2.transport.http.CommonsHTTPTransportSender"><br/> <parameter name="PROTOCOL" locked="false">HTTP/1.1</parameter><br/> <parameter name="Transfer-Encoding">chunked</parameter><br/></transportSender><br/></pre>
-
-<p>Above code snippet shows the complete configuration of the transport
-sender. <parameter/> element introduces the additional parameters that
-should be compliant with the sender. HTTP PROTOCOL version sets as HTTP/1.0
-or HTTP/1.1. Default version is HTTP/1.1. It should be noted that chunking
-support is available only for HTTP/1.1. Thus, the user should be careful in
-setting the "chunked" property and use it only with version 1.1. KeepAlive
-property is default in version 1.1.</p>
-
-<p>These are the only parameters that are available from deployment. Other
-parameters such as character encoding style (UTF-8, UTF-16 etc) etc, are
-provided via MessageContext.</p>
-
-<h4>HTTPS support</h4>
-It should be noted that CommonsHTTPTransportSender can be used to communicate
-over https. <code></code>
-<pre><transportSender name="<b>https</b>" class="org.apache.axis2.transport.http.CommonsHTTPTransportSender"><br/> <parameter name="PROTOCOL" locked="false">HTTP/1.1</parameter><br/> <parameter name="Transfer-Encoding">chunked</parameter><br/></transportSender><br/></pre>
-Please note that https works only when the server does not expect to
-authenticate the clients and where the server has the clients' public keys in
-its trust store.
-
-<h2>Timeout Configuration</h2>
-
-<p>There are two timeout exists in transport level. They are called, Socket
-timeout and Connection timeout. This can be configured in deployment time or
-in run time. In deployment time, user has to add the following lines in
-axis2.xml.</p>
-
-<p>For Socket timeout:</p>
-<pre><parameter name="SO_TIMEOUT" locked="false">some_int_value</parameter></pre>
-
-<p>For Connection timeout:</p>
-<pre> <parameter name="CONNECTION_TIMEOUT" locked="false">some_int_value</parameter></pre>
-<br/>
-In runtime it's set as follows in the Stub. <source>
-<pre>...
-Options options = new Options();
-options.setProperty(HTTPConstants.SO_TIMEOUT,new Integer(some_int_value));
-options.setProperty(HTTPConstants.CONNECTION_TIMEOUT,new Integer(some_int_value));
-...</pre>
-</source>
-<p></p>
-
-<h2>HTTP Version Configuration</h2>
-<p>The default HTTP version is 1.1. There are two methods in which user can change HTTP version to 1.0</p>
-<ol>
-<li>By defining version in Axis2.xml as shown below.</li>
-<pre> <parameter name="PROTOCOL" locked="false">HTTP/1.0</parameter></pre>
-
-<li>Or user can change version at runtime by doing the following</li>
-<pre>...
-options.setProperty(org.apache.axis2.context.MessageContextConstants.HTTP_PROTOCOL_VERSION,org.apache.axis2.transport.http.HTTPConstants.HEADER_PROTOCOL_10);
-...</pre>
-</ol>
-
-<h2>Proxy and NTLM Authentication</h2>
-
-<p>HttpClient support "Basic, Digest and NTLM" authentication schemes. These
-are used to authenticate with http servers and proxies.</p>
-
-<p>Axis2 uses deployment time and runtime mechanisms to authenticate proxies.
-In deployment time, user has to change the Axis2.xml as follows. This
-authentication will be available in http and https.</p>
-<pre><transportSender name="<b>http</b>" class="org.apache.axis2.transport.http.CommonsHTTPTransportSender">
- <parameter name="PROTOCOL" locked="false">HTTP/1.1</parameter>
- <parameter name="PROXY" proxy_host="proxy_host_name" proxy_port="proxy_host_port" locked="true>userName:domain:passWord</parameter>
-</transportSender><br/></pre>
-
-<p>For a particular proxy, if authentication is not available fill
-"userName:domain:passWord"as "anonymous:anonymous:anonymous".</p>
-
-<p>At runtime user can override the PROXY settings with an Object of
-HttpTransportProperties.ProxyProperties. On the stub initiate an object of
-prior and set it to the MessageContext's property bag via
-HttpConstants.PROXY. On the stub, it depicts as follows,</p>
-<pre>...
-Options options = new Options();
-....
-
-HttpTransportProperties.ProxyProperties proxyProperties = new HttpTransportProperties.new ProxyProperties();
-proxyProperties.setProxyHostName(....);
-proxyProperties.setProxyPort(...);
-...
-options.setProperty(HttpConstants.PROXY, proxyProperties);
-....</pre>
-
-<p>The above code would eventually override the deployment proxy
-configuration settings.</p>
-
-<p>NTLM is the most complex of the authentication protocols supported by
-HttpClient. It requires an instance of NTCredentials be available for the
-domain name of the server or the default credentials. Note that since NTLM
-does not use the notion of realms HttpClient uses the domain name of the
-server as the name of the realm. Also note that the username provided to the
-NTCredentials should not be prefixed with the domain - ie: "axis2" is correct
-whereas "DOMAIN\axis2" is not correct.</p>
-
-<p>There are some significant differences in the way that NTLM works compared
-with basic and digest authentication. These differences are generally handled
-by HttpClient, however having an understanding of these differences can help
-avoid problems when using NTLM authentication.</p>
-<ol>
- <li>NTLM authentication works almost exactly the same as any other form of
- authentication in terms of the HttpClient API. The only difference is
- that you need to supply 'NTCredentials' instead of
- 'UsernamePasswordCredentials' (NTCredentials actually extends
- UsernamePasswordCredentials so you can use NTCredentials right throughout
- your application if need be).</li>
- <li>The realm for NTLM authentication is the domain name of the computer
- being connected to, this can be troublesome as servers often have
- multiple domain names that refer to them. Only the domain name that
- HttpClient connects to (as specified by the HostConfiguration) is used to
- look up the credentials. It is generally advised that while initially
- testing NTLM authentication, you pass the realm in as null which is used
- as the default.</li>
- <li>NTLM authenticates a connection and not a request, so you need to
- authenticate every time a new connection is made and keeping the
- connection open during authentication is vital. Due to this, NTLM cannot
- be used to authenticate with both a proxy and the server, nor can NTLM be
- used with HTTP 1.0 connections or servers that do not support HTTP
- keep-alives.</li>
-</ol>
-</body>
-</html>
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+ <meta http-equiv="content-type" content="">
+ <title>HTTP transports</title>
+</head>
+
+<body lang="en">
+<h1><a name="configTransport">HTTP Transports</a></h1>
+
+<h2>Content</h2>
+<ul>
+ <li><a href="#CommonsHTTPTransportSender">CommonsHTTPTransportSender</a>
+ <ul>
+ <li><a href="#httpsupport">HTTPS support</a></li>
+ </ul>
+ </li>
+ <li><a href="#timeout_config">Timeout Configuration</a></li>
+ <li><a href="#version_config">HTTP Version Configuration</a></li>
+ <li><a href="#auth">Proxy and NTLM Authentication</a></li>
+</ul>
+<a name="CommonsHTTPTransportSender"></a>
+
+<h2>CommonsHTTPTransportSender</h2>
+
+<p>This is the default transport sender that is used in Server API as well as
+Client API. As the name implies it is based on commons-httpclient-3.0-rc3. In
+order to acquire the maximum flexibility, this sender has implemented POST
+interface and GET interface. GET interface is provided to help axis2 support
+REST.</p>
+
+<p>Chunking support and KeepAlive support is also integrated via the
+facilities provided by commons-httpclient along with HTTP 1.1 support.</p>
+
+<p><transportSender/> element is used to define transport senders in
+the axis2.xml as follows:</p>
+<pre><transportSender name="http" class="org.apache.axis2.transport.http.CommonsHTTPTransportSender"><br> <parameter name="PROTOCOL" locked="false">HTTP/1.1</parameter><br> <parameter name="Transfer-Encoding">chunked</parameter><br></transportSender><br></pre>
+
+<p>Above code snippet shows the complete configuration of the transport
+sender. <parameter/> element introduces the additional parameters that
+should be compliant with the sender. HTTP PROTOCOL version sets as HTTP/1.0
+or HTTP/1.1. Default version is HTTP/1.1. It should be noted that chunking
+support is available only for HTTP/1.1. Thus, the user should be careful in
+setting the "chunked" property and use it only with version 1.1. KeepAlive
+property is default in version 1.1.</p>
+
+<p>These are the only parameters that are available from deployment. Other
+parameters such as character encoding style (UTF-8, UTF-16 etc) etc, are
+provided via MessageContext.</p>
+<a name="httpsupport"></a>
+
+<h3>HTTPS support</h3>
+It should be noted that CommonsHTTPTransportSender can be used to communicate
+over https. <code></code>
+<pre><transportSender name="<b>https</b>" class="org.apache.axis2.transport.http.CommonsHTTPTransportSender"><br> <parameter name="PROTOCOL" locked="false">HTTP/1.1</parameter><br> <parameter name="Transfer-Encoding">chunked</parameter><br></transportSender><br></pre>
+
+<p>Please note that https works only when the server does not expect to
+authenticate the clients and where the server has the clients' public keys in
+its trust store.</p>
+<a name="timeout_config"></a>
+
+<h2>Timeout Configuration</h2>
+
+<p>There are two timeout exists in transport level. They are called, Socket
+timeout and Connection timeout. This can be configured in deployment time or
+in run time. In deployment time, user has to add the following lines in
+axis2.xml.</p>
+
+<p>For Socket timeout:</p>
+<pre><parameter name="SO_TIMEOUT" locked="false">some_int_value</parameter></pre>
+
+<p>For Connection timeout:</p>
+<pre> <parameter name="CONNECTION_TIMEOUT" locked="false">some_int_value</parameter></pre>
+<br>
+In runtime it's set as follows in the Stub. <source>
+<pre>...
+Options options = new Options();
+options.setProperty(HTTPConstants.SO_TIMEOUT,new Integer(some_int_value));
+options.setProperty(HTTPConstants.CONNECTION_TIMEOUT,new Integer(some_int_value));
+...</pre>
+</source><a name="version_config"></a>
+
+<h2>HTTP Version Configuration</h2>
+
+<p>The default HTTP version is 1.1. There are two methods in which user can
+change HTTP version to 1.0</p>
+<ol>
+ <li>By defining version in Axis2.xml as shown below.</li>
+ <pre> <parameter name="PROTOCOL" locked="false">HTTP/1.0</parameter></pre>
+ <li>Or user can change version at runtime by doing the following</li>
+ <pre>...
+options.setProperty(org.apache.axis2.context.MessageContextConstants.HTTP_PROTOCOL_VERSION,org.apache.axis2.transport.http.HTTPConstants.HEADER_PROTOCOL_10);
+...</pre>
+</ol>
+<a name="auth"></a>
+
+<h2>Proxy and NTLM Authentication</h2>
+
+<p>HttpClient support "Basic, Digest and NTLM" authentication schemes. These
+are used to authenticate with http servers and proxies.</p>
+
+<p>Axis2 uses deployment time and runtime mechanisms to authenticate proxies.
+In deployment time, user has to change the Axis2.xml as follows. This
+authentication will be available in http and https.</p>
+<pre><transportSender name="<b>http</b>" class="org.apache.axis2.transport.http.CommonsHTTPTransportSender">
+ <parameter name="PROTOCOL" locked="false">HTTP/1.1</parameter>
+ <parameter name="PROXY" proxy_host="proxy_host_name" proxy_port="proxy_host_port" locked="true>userName:domain:passWord</parameter>
+</transportSender><br></pre>
+
+<p>For a particular proxy, if authentication is not available fill
+"userName:domain:passWord"as "anonymous:anonymous:anonymous".</p>
+
+<p>At runtime user can override the PROXY settings with an Object of
+HttpTransportProperties.ProxyProperties. On the stub initiate an object of
+prior and set it to the MessageContext's property bag via
+HttpConstants.PROXY. On the stub, it depicts as follows,</p>
+<pre>...
+Options options = new Options();
+....
+
+HttpTransportProperties.ProxyProperties proxyProperties = new HttpTransportProperties.new ProxyProperties();
+proxyProperties.setProxyHostName(....);
+proxyProperties.setProxyPort(...);
+...
+options.setProperty(HttpConstants.PROXY, proxyProperties);
+....</pre>
+
+<p>The above code would eventually override the deployment proxy
+configuration settings.</p>
+
+<p>NTLM is the most complex of the authentication protocols supported by
+HttpClient. It requires an instance of NTCredentials be available for the
+domain name of the server or the default credentials. Note that since NTLM
+does not use the notion of realms HttpClient uses the domain name of the
+server as the name of the realm. Also note that the username provided to the
+NTCredentials should not be prefixed with the domain - ie: "axis2" is correct
+whereas "DOMAIN\axis2" is not correct.</p>
+
+<p>There are some significant differences in the way that NTLM works compared
+with basic and digest authentication. These differences are generally handled
+by HttpClient, however having an understanding of these differences can help
+avoid problems when using NTLM authentication.</p>
+<ol>
+ <li>NTLM authentication works almost exactly the same as any other form of
+ authentication in terms of the HttpClient API. The only difference is
+ that you need to supply 'NTCredentials' instead of
+ 'UsernamePasswordCredentials' (NTCredentials actually extends
+ UsernamePasswordCredentials so you can use NTCredentials right throughout
+ your application if need be).</li>
+ <li>The realm for NTLM authentication is the domain name of the computer
+ being connected to, this can be troublesome as servers often have
+ multiple domain names that refer to them. Only the domain name that
+ HttpClient connects to (as specified by the HostConfiguration) is used to
+ look up the credentials. It is generally advised that while initially
+ testing NTLM authentication, you pass the realm in as null which is used
+ as the default.</li>
+ <li>NTLM authenticates a connection and not a request, so you need to
+ authenticate every time a new connection is made and keeping the
+ connection open during authentication is vital. Due to this, NTLM cannot
+ be used to authenticate with both a proxy and the server, nor can NTLM be
+ used with HTTP 1.0 connections or servers that do not support HTTP
+ keep-alives.</li>
+</ol>
+</body>
+</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=397476&r1=397475&r2=397476&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/index.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/index.html Thu Apr 27 01:27:37 2006
@@ -63,7 +63,9 @@
engaging and configuring WSS4J security module</li>
<li><a href="WS_policy.html">Web Services Policy Support In Axis2</a>
-Introdcution to the role of Web services policy in Axis2</li>
- <li><a href="soapmonitor-module.html">SOAP Monitor How-to</a></li>
+ <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>
Modified: webservices/axis2/trunk/java/xdocs/latest/soapmonitor-module.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/latest/soapmonitor-module.html?rev=397476&r1=397475&r2=397476&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/soapmonitor-module.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/soapmonitor-module.html Thu Apr 27 01:27:37 2006
@@ -12,19 +12,21 @@
used to invoke Web services along with the results of those messages. The
goal of the SOAP Monitor utility is to provide a way for these developers to
monitor the SOAP messages being used without requiring any special
-configuration or restarting of the server. In this utility, a handler has
-been written and added to the global handler chain. As SOAP requests and
-responses are received, the SOAP message information is forwarded to a SOAP
-monitor service where it can be displayed using a Web browser interface. The
-SOAP message information is accessed with a Web browser by going to
-http://localhost:<port>/axis2/SOAPMonitor (where <port>is the port number
-where the application server is running). The SOAP message information is
-displayed through a Web browser by using an applet that opens a socket
-connection to the SOAP monitor service. This applet requires a Java plug-in
-1.3 or higher to be installed in your browser. If you do not have a correct
-plug-in, the browser should prompt you to install one. The port used by the
-SOAP monitor service to comminicate with applets is configurable. Edit the
-web.xml file for the Axis Web application to change the port to be used.</p>
+configuration or restarting of the server. </p>
+
+<p>In this utility, a handler has been written and added to the global
+handler chain. As SOAP requests and responses are received, the SOAP message
+information is forwarded to a SOAP monitor service where it can be displayed
+using a Web browser interface. The SOAP message information is accessed with
+a Web browser by going to http://localhost:<port>/axis2/SOAPMonitor (where
+<port>is the port number where the application server is running). The SOAP
+message information is displayed through a Web browser by using an applet
+that opens a socket connection to the SOAP monitor service. This applet
+requires a Java plug-in 1.3 or higher to be installed in your browser. If you
+do not have a correct plug-in, the browser should prompt you to install one.
+The port used by the SOAP monitor service to comminicate with applets is
+configurable. Edit the web.xml file for the Axis Web application to change
+the port to be used.</p>
<p>The soap monitor module (soapmonitor.mar) is available in the axis2.war
but it is not engaged by default. The SOAP Monitor is NOT enabled by default
Modified: webservices/axis2/trunk/java/xdocs/latest/tcp-transport.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/java/xdocs/latest/tcp-transport.html?rev=397476&r1=397475&r2=397476&view=diff
==============================================================================
--- webservices/axis2/trunk/java/xdocs/latest/tcp-transport.html (original)
+++ webservices/axis2/trunk/java/xdocs/latest/tcp-transport.html Thu Apr 27 01:27:37 2006
@@ -1,96 +1,112 @@
-<html>
-<head>
- <meta content="">
- <meta content="">
- <meta content="">
- <meta http-equiv="content-type" content="">
- <title>TCP transport</title>
-</head>
-
-<body lang="en">
-<h1>TCP transport</h1>
-
-<p>Axis2 supports TCP as a transport. Axis2 has support for both send and
-receive SOAP Messages via TCP. TCP transport does not have any application
-level headers and the SOAP Message that is send should be self contained.
-This makes the interaction fast and simple. Since there are no application
-headers, it does not have the privilege of having request URI, and Service
-dispatching should be done with a alternative method. Thus,
-RequestURIBasedDispatcher can not be used. Following are the two main
-alternatives available in dispatching in Axis2 Environment.</p>
-<ol>
- <li>Use the name space URI of the first child element of SOAPBody.
- (SOAPMessageBodyBasedDispatcher)</li>
- <li>Enable the WS-Addressing. In the case of 1.0 release addressing is
- default (SOAPActionBasedDispatcher)</li>
-</ol>
-
-<p>When TCP request is sent it's user's responsibility to use either
-addressing or SOAP body base mechanism.</p>
-
-<h2>How to start the TCPServer</h2>
-
-<p>The TCP server can be started by running the class
-org.apache.axis2.transport.tcp.TCPServer with two parameters <a
-href="faq.html#b5">repository</a> and port number as argument. This class
-needs all the axis dependency jars in the classpath. New Services can be
-added in the usual way by dropping the archives to repository (See <a
-href="userguide.html">User Guide</a> for more information)</p>
-
-<p>Alternatively the TCP Server can run with tcp-server.bat/ tcp-server.sh
-file in the bin directory of the Binary distribution of TCP Server.</p>
-
-<h2>How to send SOAP Messages using TCP transport</h2>
-
-<p>The TCP transport can be enabled easily from the call API. Following code
-segment demonstrate how it can be done.</p>
-<source><pre>OMElement payload = ...
-
-ServiceClient serviceClient = new ServiceClient();
-Options options = new Options();
-options.setTo(targetEPR);
-options.useSeperateListener(false);
-serviceClient.setOptions(options);
-
-OMElement response =
- serviceClient.sendReceive(payload);</pre>
-</source>
-<p>The transport that should be invoked is inferred from the targetEPR
-(tcp://...). In this case it is TCP and the listener, also TCP . SOAP Message
-has to be self contained in order to use addressing. Only other option one
-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 representation of Axis2.</p>
-
-<h2>Sample</h2>
-
-<p>Sample for a TCP Client can be found from the
-samples/userguide/src/userguide/clients/TCPClient.java in the binary
-distribution. This access the same web service explained in the <a
-href="userguide.html">Axis2 userguide</a>. The client first starts the
-TCPServer with the same repository used for the <a
-href="userguide.html#samples">Axis2 userguide samples</a>. Since sample is
-already deployed in the repository while trying the userguide it will be
-automatically available.</p>
-
-<h2>Transport Components</h2>
-
-<p>Axis2 TCP transport has two components, a transport Listener for receiving
-the Messages and transport Sender to send the SOAP Messages. Axis2
-installation has both the components built in to itself by default. In the
-axis2.xml configuration file the two TCP transport components would look like
-as follows.</p>
-
-<p>If the TCP server is started manually this configuration does not take
-effect. In return this effects the transport Listener's start by Axis2. (e.g.
-Listener started by the Complete Async interaction)</p>
-
-<p>Following xml lines initializes the TCPTransport Receiver:</p>
-<source><pre><transportReceiver name="tcp" class="org.apache.axis2.transport.tcp.TCPServer">
- <parameter name="port" locked="false">6060</parameter>
-</transportReceiver></pre>
-</source>
-<p>Following xml lines adds the TCPTransport Sender:</p>
-<source><pre><transportSender name="tcp" class="org.apache.axis2.transport.tcp.TCPTransportSender"/></pre>
-</source></body>
-</html>
+<html>
+<head>
+ <meta content="">
+ <meta content="">
+ <meta content="">
+ <meta http-equiv="content-type" content="">
+ <title>TCP transport</title>
+</head>
+
+<body lang="en">
+<h1>TCP Transport</h1>
+
+<h2>Content</h2>
+<ul>
+ <li><a href="#intro">Introduction</a></li>
+ <li><a href="#start">How to Start the TCPServer</a></li>
+ <li><a href="#send">How to Send SOAP Messages Using TCP Transport</a></li>
+ <li><a href="#samples">Samples</a></li>
+ <li><a href="#components">Transport Components </a></li>
+</ul>
+<a name="intro"></a>
+
+<h2>Introduction</h2>
+
+<p>Axis2 supports TCP as a transport. Axis2 has support for both send and
+receive SOAP Messages via TCP. TCP transport does not have any application
+level headers and the SOAP Message that is send should be self contained.
+This makes the interaction fast and simple. Since there are no application
+headers, it does not have the privilege of having request URI, and Service
+dispatching should be done with a alternative method. Thus,
+RequestURIBasedDispatcher can not be used. Following are the two main
+alternatives available in dispatching in Axis2 Environment.</p>
+<ol>
+ <li>Use the name space URI of the first child element of SOAPBody.
+ (SOAPMessageBodyBasedDispatcher)</li>
+ <li>Enable the WS-Addressing. In the case of 1.0 release addressing is
+ default (SOAPActionBasedDispatcher)</li>
+</ol>
+
+<p>When TCP request is sent it's user's responsibility to use either
+addressing or SOAP body base mechanism.</p>
+<a name="start"></a>
+
+<h2>How to Start the TCPServer</h2>
+
+<p>The TCP server can be started by running the class
+org.apache.axis2.transport.tcp.TCPServer with two parameters <a
+href="faq.html#b5">repository</a> and port number as argument. This class
+needs all the axis dependency jars in the classpath. New Services can be
+added in the usual way by dropping the archives to repository (See <a
+href="userguide.html">User Guide</a> for more information)</p>
+
+<p>Alternatively the TCP Server can run with tcp-server.bat/ tcp-server.sh
+file in the bin directory of the Binary distribution of TCP Server.</p>
+<a name="send"></a>
+
+<h2>How to Send SOAP Messages Using TCP Transport</h2>
+
+<p>The TCP transport can be enabled easily from the call API. Following code
+segment demonstrate how it can be done.</p>
+<source><pre>OMElement payload = ...
+
+ServiceClient serviceClient = new ServiceClient();
+Options options = new Options();
+options.setTo(targetEPR);
+options.useSeperateListener(false);
+serviceClient.setOptions(options);
+
+OMElement response =
+ serviceClient.sendReceive(payload);</pre>
+</source>
+<p>The transport that should be invoked is inferred from the targetEPR
+(tcp://...). In this case it is TCP and the listener, also TCP . SOAP Message
+has to be self contained in order to use addressing. Only other option one
+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 representation of Axis2.</p>
+<a name="sample"></a>
+
+<h2>Sample</h2>
+
+<p>Sample for a TCP Client can be found from the
+samples/userguide/src/userguide/clients/TCPClient.java in the binary
+distribution. This access the same web service explained in the <a
+href="userguide.html">Axis2 userguide</a>. The client first starts the
+TCPServer with the same repository used for the <a
+href="userguide.html#samples">Axis2 userguide samples</a>. Since sample is
+already deployed in the repository while trying the userguide it will be
+automatically available.</p>
+<a name="components"></a>
+
+<h2>Transport Components</h2>
+
+<p>Axis2 TCP transport has two components, a transport Listener for receiving
+the Messages and transport Sender to send the SOAP Messages. Axis2
+installation has both the components built in to itself by default. In the
+axis2.xml configuration file the two TCP transport components would look like
+as follows.</p>
+
+<p>If the TCP server is started manually this configuration does not take
+effect. In return this effects the transport Listener's start by Axis2. (e.g.
+Listener started by the Complete Async interaction)</p>
+
+<p>Following xml lines initializes the TCPTransport Receiver:</p>
+<source><pre><transportReceiver name="tcp" class="org.apache.axis2.transport.tcp.TCPServer">
+ <parameter name="port" locked="false">6060</parameter>
+</transportReceiver></pre>
+</source>
+<p>Following xml lines adds the TCPTransport Sender:</p>
+<source><pre><transportSender name="tcp" class="org.apache.axis2.transport.tcp.TCPTransportSender"/></pre>
+</source></body>
+</html>