[jboss-remoting-commits] JBoss Remoting SVN: r6454 - remoting2/branches/2.x/docs/guide/en.

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

Author: ron.sigal at jboss.com
Date: 2012-07-18 22:24:31 -0400 (Wed, 18 Jul 2012)
New Revision: 6454

Modified:
   remoting2/branches/2.x/docs/guide/en/chap5.xml
Log:
JBREM-1306: Add discussion of new parameter "useDefaultSslSocketFactory".

Modified: remoting2/branches/2.x/docs/guide/en/chap5.xml
===================================================================
--- remoting2/branches/2.x/docs/guide/en/chap5.xml	2012-07-18 22:34:18 UTC (rev 6453)
+++ remoting2/branches/2.x/docs/guide/en/chap5.xml	2012-07-19 02:24:31 UTC (rev 6454)
@@ -2,7 +2,7 @@
 <chapter id="chapter-configuration" xreflabel="Configuration">
   <title>Configuration</title>
 
-  <para>This covers the configuration for JBoss Remoting discovery, connectors,
+  <para>This chapter covers the configuration for JBoss Remoting discovery, connectors,
   marshallers, and transports. All the configuration properties specified can be
   set either via calls to the object itself, including via JMX (so can be done
   via the JMX or Web console), via a JBoss AS service xml file. Examples of
@@ -1950,7 +1950,6 @@
       Invoker uses an <classname>SSLServerSocket</classname> by default,
       created by an <classname>SSLServerSocketFactory</classname>. See section
       <xref linkend="section-socket-factories" /> for more information.</para>
-    </section>
 
     <section>
       <title>HTTP(S) Client Invoker - proxy and basic authentication</title>
@@ -2071,9 +2070,25 @@
       <classname>SocketFactory</classname> configuration.
       
       </para>
-
+      </section>
+      
+      <section>
+         <title>HTTPS client socket factory configuration</title>
+         
+         <para>If a socket factory is not passed into the HTTPS client invoker, it will use 
+         <classname>org.jboss.remoting.security.SSLSocketBuilder</classname> to create one.
+         However, it might be desirable to allow it to fall back to a default socket factory
+         passed into HttpsURLConnection. As of release 2.5.4.SP4, a configuration parameter is
+         available to allow that to happen.
+         </para>
+         
+        <para><emphasis role="bold">useDefaultSslSocketFactory</emphasis> - If the parameter is
+        set to "true", <methodname>HTTPSClientInvoker.createSocketFactory()</methodname>
+        will call <methodname>HttpsURLConnection.getDefaultSSLSocketFactory()</methodname>
+        instead of trying to build a socket factory.</para>
+      </section>
     </section>
-
+    
     <section>
       <title>Servlet transport</title>
 
@@ -6816,7 +6831,11 @@
     used by the http client invoker. The value should be the fully qualified
     classname of class that implements javax.net.ssl.HostnameVerifier and has
     a void constructor.</para>
-
+    
+    <para><emphasis role="bold">USE_DEFAULT_SSL_SOCKET_FACTORY</emphasis> (actual value is
+    'useDefaultSslSocketFactory') - if set to true, then HTTPSClientInvoker.createSocketFactory()
+    will call HttpsURLConnection.getDefaultSSLSocketFactory() instead of trying to build a SocketFactory.
+    </para>
     </section>
 
     <section>