[jboss-remoting-commits] JBoss Remoting SVN: r5210 - remoting2/branches/2.2/docs/guide/en.

[jboss-remoting-commits at lists.jboss.org]

Author: ron.sigal at jboss.com
Date: 2009-05-13 01:29:47 -0400 (Wed, 13 May 2009)
New Revision: 5210

Modified:
   remoting2/branches/2.2/docs/guide/en/chap5.xml
Log:
JBREM-1121: Added section about configuring socket factories by the InvokerLocator.

Modified: remoting2/branches/2.2/docs/guide/en/chap5.xml
===================================================================
--- remoting2/branches/2.2/docs/guide/en/chap5.xml	2009-05-13 04:23:39 UTC (rev 5209)
+++ remoting2/branches/2.2/docs/guide/en/chap5.xml	2009-05-13 05:29:47 UTC (rev 5210)
@@ -186,7 +186,7 @@
         <classname>org.jboss.test.remoting.configuration.SocketClientConfigurationTestCase</classname>.</para>
       </section>
 
-      <section>
+      <section id="section-declarative-configuration" xreflabel="Declarative configuration">
         <title>Declarative configuration</title>
 
         <para>The configuration option discussed at the end of the previous
@@ -4842,6 +4842,28 @@
     </section>
     
     <section>
+      <title>Client side configuration from the JBoss Application Server</title>
+      
+      <para>As described in section <xref linkend="section-declarative-configuration"/>
+      the declarative xml files used by the Application Server can be used to configure the 
+      client by way of the parameters included in the <classname>InvokerLocator</classname>.
+      However, a peculiarity in the way socket factories are created on the client 
+      restricts the parameters taken into consideration to those passed in the 
+      configuration map passed to the <classname>org.jboss.remoting.Client</classname>
+      constructor.  The following two parameters, introduced in releases 2.2.2.SP9 and
+      2.2.3, respectively, eliminate that restriction.</para>
+      
+      <para><emphasis role="bold">org.jboss.remoting.Remoting.SOCKET_FACTORY_NAME</emphasis> (actual value
+      is 'socketFactory') - key for giving the name of the socket factory class to be used
+      by clients.</para>
+
+      <para><emphasis role="bold">org.jboss.remoting.Remoting.USE_ALL_SOCKET_FACTORY_PARAMS</emphasis> (actual value
+      is 'useAllSocketFactoryParams') - key for indicating that all socket factory parameters
+      in the <classname>InvokerLocator</classname> should be used by clients.</para>        
+        
+    </section>
+    
+    <section>
       <title>Socket creation listeners</title>
       
       <para>