From jboss-remoting-commits at lists.jboss.org Fri May  6 00:56:10 2011
Content-Type: multipart/mixed; boundary="===============1948004562427653271=="
MIME-Version: 1.0
From: jboss-remoting-commits at lists.jboss.org
To: jboss-remoting-commits at lists.jboss.org
Subject: [jboss-remoting-commits] JBoss Remoting SVN: r6365 -
 remoting2/branches/2.x/docs/userguide/en.
Date: Fri, 06 May 2011 00:56:10 -0400
Message-ID: <201105060456.p464uArR021426@svn01.web.mwc.hst.phx2.redhat.com>

--===============1948004562427653271==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: ron.sigal(a)jboss.com
Date: 2011-05-06 00:56:09 -0400 (Fri, 06 May 2011)
New Revision: 6365

Modified:
   remoting2/branches/2.x/docs/userguide/en/chap7.xml
Log:
JBREM-1283: Added discusssion of configurable parameters.

Modified: remoting2/branches/2.x/docs/userguide/en/chap7.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- remoting2/branches/2.x/docs/userguide/en/chap7.xml	2011-05-06 03:20:46 =
UTC (rev 6364)
+++ remoting2/branches/2.x/docs/userguide/en/chap7.xml	2011-05-06 04:56:09 =
UTC (rev 6365)
@@ -35,9 +35,8 @@
    <classname>javax.net.ssl.SSLSocket</classname>s and <classname>javax.ne=
t.ssl.SSLServerSocket</classname>s
    instead of <classname>Socket</classname>s and <classname>ServerSocket</=
classname>s.
    </para>
+   </section>
    =

-   </section>
-
    <section>
    <title>servlet and sslservlet transports</title>
    <para>
@@ -82,10 +81,95 @@
 =

    &lt;/web-app&gt;
    </programlisting>
+   </section>
    =

+   <section>
+   <title>Server side parameters: http and https transports</title>
+   =

+   <para>In general, parameters passed to a <classname>CoyoteInvoker</clas=
sname> are
+   passed to the underlying Tomcat implementation. For example, the Tomcat=
 attribute "maxThreads"
+   can be used to set the maximum number of threads to be used to accept i=
ncoming http requests.
+   However, the Remoting attributes "serverBindAddress" and "serverBindPor=
t" should be used instead
+   of the Tomcat attributes "address" and "port". For more information on =
the configuration attributes
+   available for the Tomcat connectors, please refer to <ulink
+   url=3D"http://tomcat.apache.org/tomcat-6.0-doc/config/http.html">http:/=
/tomcat.apache.org/tomcat-6.0-doc/config/http.html</ulink>.
+   </para>
+   =

+   <para><classname>CoyoteInvoker</classname> can also configure an instan=
ce of
+   <classname>org.apache.catalina.Executor</classname>, an interface which=
 extends
+   <classname>java.util.concurrent.Executor</classname>.  If the parameter=
 "executor" is
+   associated with a comma separated list of key=3Dvalue pairs, <classname=
>CoyoteInvoker</classname>
+   will parse the list, use the resulting <classname>Map</classname> to co=
nfigure an instance of
+   <classname>org.apache.catalina.core.StandardThreadExecutor</classname>,=
 and inject it into the
+   underlying Tomcat implementation. For example, JBoss Messaging's <code>=
remoting-http-service.xml</code>
+   configuration file could contain</para>
+       =

+   <programlisting>&lt;attribute name=3D"executor"&gt;minSpareThreads=3D20=
,maxThreads=3D100&lt;/attribute&gt;</programlisting>       =

+   =

+   <para>Note that if an executor is injected, the other threadpool related
+   attributes such as "maxThreads", which would otherwise be applied to a =
threadpool created by Tomcat, are ignored.
+   The configurable attributes of the <classname>StandardThreadExecutor</c=
lassname> are described in <ulink
+   url=3D"http://tomcat.apache.org/tomcat-6.0-doc/config/executor.html">ht=
tp://tomcat.apache.org/tomcat-6.0-doc/config/executor.html</ulink>. =

+   </para>
+   </section> =

+   =

+   <section>
+   <title>Server side parameters: servlet and sslservlet transports</title>
+   =

+   <para>The following parameter may be used to configure
+   an instance of <classname></classname>ServletServerInvoker:</para>
+   =

+   <para><emphasis role=3D"bold">unwrapSingletonArrays</emphasis> - key in=
dicating if, when
+   <methodname>javax.servlet.http.HttpServletRequest.getParameterMap()</me=
thodname> returns a
+   map containing pairs of the form (key, value) where value has the form
+   <classname>java.lang.String[]</classname> with length 1, the pair shoul=
d be replaced with a =

+   pair (key, ((String[] value)[0]).  The default value is "false".</para>
    </section>
+   =

+   <section>
+   <title>Client side parameters: http, https, servlet, sslservlet transpo=
rts</title>
+   =

+   <para>The following parameters may be used to configure
+   an instance of <classname>org.jboss.remoting.transport.http.HTTPClientI=
nvoker</classname>:</para>
+   =

+   <para><emphasis role=3D"bold">disconnectAfterUse</emphasis> - key indic=
ating if the
+   <classname>java.net.HttpURLConnection</classname> should be disconnecte=
d after the invocation.
+   The default value is "false".</para>
+  =

+   <para><emphasis role=3D"bold">ignoreErrorResponseMessage</emphasis> - k=
ey indicating
+   if <classname>HTTPClientInvoker</classname>
+   should try to get a response message and response code in the event of =
an exception.
+   The default value is "false".</para>
+   =

+   <para> <emphasis role=3D"bold">numberOfCallAttempts</emphasis> - This p=
arameter is relevant only on the
+   client side, where it determines the maximum number of attempts that
+   will be made to complete an invocation. The default value is 1.</para>
 =

+   <para><emphasis role=3D"bold">unmarshalNullStream</emphasis> - key indi=
cating if
+   <classname>HTTPClientInvoker</classname>
+   should make the call to <methodname>UnMarshaller.read()</methodname> wh=
en
+   the <classname>InputStream</classname> is null. The default value is "t=
rue".</para>
+   </section>
+
    <section>
+   <title>Client side parameters: https and sslservlet transports</title>
+   =

+   <para>The following parameters may be used to configure
+   an instance of <classname>HTTPSClientInvoker</classname>:</para>
+
+   <para><emphasis role=3D"bold">org.jboss.security.ignoreHttpsHost</empha=
sis> - key indicating if =

+   <classname>HTTPSClientInvoker</classname> should ignore host name
+   verification, i.e., it will not check for a mismatch between the URL's =
hostname and the server's
+   hostname during handshaking. By default, standard hostname
+   verification will be performed.</para>
+
+   <para><emphasis role=3D"bold">hostnameVerifier</emphasis> - key indicat=
ing the hostname verifier that should be
+   used by <classname>HTTPSClientInvoker</classname>. The value should be =
the fully qualified
+   classname of a class that implements <classname>javax.net.ssl.HostnameV=
erifier</classname> and has
+   a void constructor.</para>
+   </section>
+
+   <section>
    <title>JBoss Messaging, http transports, and callbacks</title>
    =

    <para>Unlike the bisocket transport, which was designed especially to a=
llow push callbacks without


--===============1948004562427653271==--