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

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

Author: ron.sigal at jboss.com
Date: 2010-02-17 18:01:23 -0500 (Wed, 17 Feb 2010)
New Revision: 5723

Modified:
   remoting2/branches/2.2/docs/guide/en/chap3.xml
   remoting2/branches/2.2/docs/guide/en/chap5.xml
Log:
JBREM-1180: Added note about InvokerLocator system property suppressHostWarning.

Modified: remoting2/branches/2.2/docs/guide/en/chap3.xml
===================================================================
--- remoting2/branches/2.2/docs/guide/en/chap3.xml	2010-02-17 22:41:28 UTC (rev 5722)
+++ remoting2/branches/2.2/docs/guide/en/chap3.xml	2010-02-17 23:01:23 UTC (rev 5723)
@@ -50,6 +50,26 @@
 
   <para><code>new InvokerLocator("http://localhost:1234/services/uri:Test").isSameEndpoint(new InvokerLocator("http://127.0.0.1:1234"))</code> returns false</para>
 
+  <para><emphasis role="bold">N.B.</emphasis> As of version 2.2.2.SP4,
+  <classname>InvokerLocator</classname> uses the class
+  <classname>java.net.URI</classname>, rather than its original ad hoc parsing
+  code, to parse the String passed to its constructor. If, for some reason, the
+  new algorithm causes problems for legacy code, it is possible to configure
+  <classname>InvokerLocator</classname> to use the original parsing code by
+  calling the static method
+  <methodname>org.jboss.remoting.InvokerLocator.setUseLegacyParsing()</methodname>.
+  </para>
+  
+  <para><emphasis role="bold">N.B.</emphasis>The syntax of URIs is defined in 
+  <ulink url="http://www.ietf.org/rfc/rfc2396.txt">http://www.ietf.org/rfc/rfc2396.txt</ulink>.
+  A not unknown error is to give a hostname with the illegal underscore character "_", which
+  confuses the <classname>java.net.URI</classname> parsing algorithm, leading to the hostname
+  being set to null.  As of release 2.2.3.SP2, <classname>org.jboss.remoting.InvokerLocator</classname>
+  will log a warning if the hostname is set to null. This warning can be disabled by setting
+  the system property <code>InvokerLocator.SUPPRESS_HOST_WARNING</code> (actual value
+  "suppressHostWarning") to "true".
+  </para>
+  
   <para><emphasis
   role="bold">org.jboss.remoting.transport.Connector</emphasis> - is an MBean
   that loads a particular ServerInvoker implementation for a given transport

Modified: remoting2/branches/2.2/docs/guide/en/chap5.xml
===================================================================
--- remoting2/branches/2.2/docs/guide/en/chap5.xml	2010-02-17 22:41:28 UTC (rev 5722)
+++ remoting2/branches/2.2/docs/guide/en/chap5.xml	2010-02-17 23:01:23 UTC (rev 5723)
@@ -6164,6 +6164,11 @@
     renewal and must be greater than zero in order to be recognized. If this
     property is not set (and CLIENT_LEASE is), will use the lease period as
     specified by the server.</para>
+    
+    <para><emphasis role="bold">SUPPRESS_HOST_WARNING</emphasis> (actual value is
+    'suppressHostWarning') - the boolean valued system property that determines if 
+    <classname>InvokerLocator</classname> should log a warning that the hostname is
+    null.  The default value is "false", i.e., the warning is logged by default.</para>
 
     <para></para>