[jboss-svn-commits] JBL Code SVN: r36773 - in labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US: OOB-Actions and 1 other directories.
jboss-svn-commits at lists.jboss.org
jboss-svn-commits at lists.jboss.org
Thu Mar 3 08:56:45 EST 2011
Author: kevin.conner at jboss.com
Date: 2011-03-03 08:56:45 -0500 (Thu, 03 Mar 2011)
New Revision: 36773
Added:
labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/OOB-Actions/OOB_Actions_http_client.xml
labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/extras/OOB-Actions/httpClient_file_property_value.props
Removed:
labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/extras/OOB-Actions/webservices_SOAP-httpClient_file_property_value.props
Modified:
labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/OOB-Actions/OOB_Actions_routing.xml
labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/OOB-Actions/OOB_Actions_webservices_SOAP.xml
labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/Out-of-the-box_Actions.xml
Log:
Added documentation for Configurators: JBESB-3575
Added: labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/OOB-Actions/OOB_Actions_http_client.xml
===================================================================
--- labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/OOB-Actions/OOB_Actions_http_client.xml (rev 0)
+++ labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/OOB-Actions/OOB_Actions_http_client.xml 2011-03-03 13:56:45 UTC (rev 36773)
@@ -0,0 +1,302 @@
+<?xml version='1.0'?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Programmers_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section id="section-http-client">
+ <title>HttpClient Configuration</title>
+
+ <para>
+ The HttpClient configuration is achieved through the specification of a set of properties.
+ The following is an example of these properties when specified as a java property file:
+ </para>
+
+ <programlisting><xi:include href="../extras/OOB-Actions/httpClient_file_property_value.props" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></programlisting>
+
+ <section>
+ <title>Configurators</title>
+
+ <para>
+ The only property that the HttpClientFactory requires is the <property>configurators</property> property,
+ which specifies a comma separated list of configurator implementations. Each configurator
+ implementation configures different aspects of the HttpClient instance, extending the
+ <classname>org.jboss.soa.esb.http.Configurator</classname> class and providing a
+ <methodname>configure(HttpClient, Properties)</methodname> method.
+ </para>
+
+ <table>
+ <title>Out-of-the-box implementations</title>
+ <tgroup cols="3" colsep="1" rowsep="1">
+ <colspec colwidth="2*"/>
+ <colspec colwidth="5*"/>
+ <colspec colwidth="1*"/>
+ <thead>
+ <row><entry>Configurator</entry><entry>Description</entry><entry>Required</entry></row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><property>HttpProtocol</property></entry>
+ <entry>
+ <para>Configure the HttpClient host, port and protocol information, including the socket factory and SSL keystore information.</para>
+ </entry>
+ <entry>Yes</entry>
+ </row>
+ <row>
+ <entry><property>AuthBasic</property></entry>
+ <entry>
+ <para>Configure HTTP Basic authentication for the HttpClient.</para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ <row>
+ <entry><property>AuthNTLM</property></entry>
+ <entry>
+ <para>Configure NTLM authentication for the HttpClient.</para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>
+ Additional configurators can be created and configured by appending their class names to the list specified in the <property>configurators</property> property,
+ </para>
+
+ <section>
+ <title>HttpProtocol</title>
+ <para>Configuration of the HTTP transport properties</para>
+ <table>
+ <title>Properties</title>
+ <tgroup cols="3" colsep="1" rowsep="1">
+ <colspec colwidth="2*"/>
+ <colspec colwidth="5*"/>
+ <colspec colwidth="1*"/>
+ <thead>
+ <row><entry>Property</entry><entry>Description</entry><entry>Required</entry></row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><property>HttpProtocol</property></entry>
+ <entry>
+ <para>Configure the HttpClient host, port and protocol information, including the socket factory and SSL keystore information.</para>
+ </entry>
+ <entry>Yes</entry>
+ </row>
+ <row>
+ <entry><property>target-host-url</property></entry>
+ <entry>
+ <para>Target URL for http/https endpoint</para>
+ </entry>
+ <entry>Yes</entry>
+ </row>
+ <row>
+ <entry><property>https.proxyHost</property></entry>
+ <entry>
+ <para>Proxy Host for https connections</para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ <row>
+ <entry><property>https.proxyPort</property></entry>
+ <entry>
+ <para>Proxy Port for https connections, defaulting to port 443</para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ <row>
+ <entry><property>http.proxyHost</property></entry>
+ <entry>
+ <para>Proxy Host for http connections</para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ <row>
+ <entry><property>http.proxyPort</property></entry>
+ <entry>
+ <para>Proxy Port for http connections, defaulting to port 80</para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ <row>
+ <entry><property>protocol-socket-factory</property></entry>
+ <entry>
+ <para>
+ Override socket factory, implementing the <classname>ProtocolSocketFactory</classname>
+ or <classname>ProtocolSocketFactoryBuilder</classname> interface.
+ </para>
+ <para>
+ The default value for http is the httpclient <classname>DefaultProtocolSocketFactory</classname> whereas
+ the default value for https is the contributed <classname>StrictSSLProtocolSocketFactory</classname>.
+ </para>
+ <para>
+ There are two implementations of <classname>ProtocolSocketFactoryBuilder</classname> provided in the ESB codebase,
+ <classname>AuthSSLProtocolSocketFactoryBuilder</classname> and <classname>SelfSignedSSLProtocolSocketFactoryBuilder</classname>,
+ for configuring the <classname>AuthSSLProtocolSocketFactory</classname> factory and self signed <classname>SSLContext</classname>
+ respectively.
+ </para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ <row>
+ <entry><property>keystore</property></entry>
+ <entry>
+ <para>KeyStore location</para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ <row>
+ <entry><property>keystore-passw</property></entry>
+ <entry>
+ <para>KeyStore password or encrypted file</para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ <row>
+ <entry><property>keystore-type</property></entry>
+ <entry>
+ <para>KeyStore type, defaulting to jks</para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ <row>
+ <entry><property>truststore</property></entry>
+ <entry>
+ <para>TrustStore location</para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ <row>
+ <entry><property>truststore-passw</property></entry>
+ <entry>
+ <para>TrustStore password or encrypted file</para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ <row>
+ <entry><property>truststore-type</property></entry>
+ <entry>
+ <para>TrustStore type, defaulting to jks</para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section>
+ <title>AuthBASIC</title>
+ <para>Configuration of the HTTP Basic Authentication properties</para>
+ <table>
+ <title>Properties</title>
+ <tgroup cols="3" colsep="1" rowsep="1">
+ <colspec colwidth="2*"/>
+ <colspec colwidth="5*"/>
+ <colspec colwidth="1*"/>
+ <thead>
+ <row><entry>Property</entry><entry>Description</entry><entry>Required</entry></row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><property>auth-username</property></entry>
+ <entry>
+ <para>Authentication Username</para>
+ </entry>
+ <entry>Yes</entry>
+ </row>
+ <row>
+ <entry><property>auth-password</property></entry>
+ <entry>
+ <para>Authentication Password</para>
+ </entry>
+ <entry>Yes</entry>
+ </row>
+ <row>
+ <entry><property>authscope-host</property></entry>
+ <entry>
+ <para>Authentication Scope Host</para>
+ </entry>
+ <entry>Yes</entry>
+ </row>
+ <row>
+ <entry><property>authscope-port</property></entry>
+ <entry>
+ <para>Authentication Scope Port</para>
+ </entry>
+ <entry>Yes</entry>
+ </row>
+ <row>
+ <entry><property>authscope-domain</property></entry>
+ <entry>
+ <para>Authentication Scope Domain</para>
+ </entry>
+ <entry>Yes</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section>
+ <title>AuthNTLM</title>
+ <para>Configuration of the HTTP Basic Authentication properties</para>
+ <table>
+ <title>Properties</title>
+ <tgroup cols="3" colsep="1" rowsep="1">
+ <colspec colwidth="2*"/>
+ <colspec colwidth="5*"/>
+ <colspec colwidth="1*"/>
+ <thead>
+ <row><entry>Property</entry><entry>Description</entry><entry>Required</entry></row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><property>ntauth-username</property></entry>
+ <entry>
+ <para>Authentication Username</para>
+ </entry>
+ <entry>Yes</entry>
+ </row>
+ <row>
+ <entry><property>ntauth-password</property></entry>
+ <entry>
+ <para>Authentication Password</para>
+ </entry>
+ <entry>Yes</entry>
+ </row>
+ <row>
+ <entry><property>ntauthscope-host</property></entry>
+ <entry>
+ <para>Authentication Scope Host</para>
+ </entry>
+ <entry>Yes</entry>
+ </row>
+ <row>
+ <entry><property>ntauthscope-port</property></entry>
+ <entry>
+ <para>Authentication Scope Port</para>
+ </entry>
+ <entry>Yes</entry>
+ </row>
+ <row>
+ <entry><property>ntauthscope-domain</property></entry>
+ <entry>
+ <para>Authentication Scope Domain</para>
+ </entry>
+ <entry>Yes</entry>
+ </row>
+ <row>
+ <entry><property>ntauthscope-realm</property></entry>
+ <entry>
+ <para>Authentication Scope Realm</para>
+ </entry>
+ <entry>No</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ </section>
+</section>
Property changes on: labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/OOB-Actions/OOB_Actions_http_client.xml
___________________________________________________________________
Added: svn:mime-type
+ text/xml
Added: svn:keywords
+ Rev Date
Added: svn:eol-style
+ native
Modified: labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/OOB-Actions/OOB_Actions_routing.xml
===================================================================
--- labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/OOB-Actions/OOB_Actions_routing.xml 2011-03-02 18:06:58 UTC (rev 36772)
+++ labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/OOB-Actions/OOB_Actions_routing.xml 2011-03-03 13:56:45 UTC (rev 36773)
@@ -153,7 +153,7 @@
properties file on the local file system, classpath or URI
based. See example below to see how this is done. For more
information about the factory properties please refer to:
- <ulink url="http://www.jboss.org/community/docs/DOC-9969" />.
+ <xref linkend="section-http-client"/>.
</para>
</entry>
<entry>No</entry>
@@ -199,17 +199,6 @@
</entry>
<entry>No</entry>
</row>
- <row>
- <entry><property>http-client-property</property></entry>
- <entry>
- <para>
- The HttpRouter uses the HttpClientFactory to create and
- configure the HttpClient instance. You can specify the
- configuration of the factory by
- </para>
- </entry>
- <entry>No</entry>
- </row>
</tbody>
</tgroup>
</table>
Modified: labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/OOB-Actions/OOB_Actions_webservices_SOAP.xml
===================================================================
--- labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/OOB-Actions/OOB_Actions_webservices_SOAP.xml 2011-03-02 18:06:58 UTC (rev 36772)
+++ labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/OOB-Actions/OOB_Actions_webservices_SOAP.xml 2011-03-03 13:56:45 UTC (rev 36773)
@@ -707,24 +707,19 @@
<para>
The "file" property value will be evaluated as a filesystem, classpath
- or URI based resource (in that order).
+ or URI based resource (in that order). This resource contains the HttpClient
+ configuration in the standard java properties format.
</para>
<para>
- The following is an example of this property set:
+ These properties may also be set directly in the action configuration like so:
</para>
-
- <programlisting><xi:include href="../extras/OOB-Actions/webservices_SOAP-httpClient_file_property_value.props" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></programlisting>
- <para>
- Properties may also be set directly on in the action configuration like so:
- </para>
-
<programlisting language="XML" role="XML"><xi:include href="../extras/OOB-Actions/webservices_SOAP-httpClient_properties_set_in_action_config.xmlt" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></programlisting>
<para>
- For more information about the configuration options available please
- refer to <ulink url="https://community.jboss.org/wiki/SOAPClient" />.
+ For more information about the HtptClient configuration options please
+ refer to <xref linkend="section-http-client"/>.
</para>
</section>
Modified: labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/Out-of-the-box_Actions.xml
===================================================================
--- labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/Out-of-the-box_Actions.xml 2011-03-02 18:06:58 UTC (rev 36772)
+++ labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/Out-of-the-box_Actions.xml 2011-03-03 13:56:45 UTC (rev 36773)
@@ -21,5 +21,6 @@
<xi:include href="OOB-Actions/OOB_Actions_notifiers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="OOB-Actions/OOB_Actions_webservices_SOAP.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="OOB-Actions/OOB_Actions_misc.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="OOB-Actions/OOB_Actions_http_client.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</chapter>
Added: labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/extras/OOB-Actions/httpClient_file_property_value.props
===================================================================
--- labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/extras/OOB-Actions/httpClient_file_property_value.props (rev 0)
+++ labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/extras/OOB-Actions/httpClient_file_property_value.props 2011-03-03 13:56:45 UTC (rev 36773)
@@ -0,0 +1,16 @@
+# Configurators
+configurators=HttpProtocol,AuthBASIC
+
+# HttpProtocol config...
+protocol-socket-factory=org.apache.commons.httpclient.contrib.ssl.EasySSLProtocolSocketFactory
+keystore=/packages/jakarta-tomcat-5.0.28/conf/chap8.keystore
+keystore-passw=xxxxxx
+https.proxyHost=localhost
+https.proxyPort=443
+
+# AuthBASIC config...
+auth-username=tomcat
+auth-password=tomcat
+authscope-host=localhost
+authscope-port=18443
+authscope-realm=ActiveBPEL security realm
\ No newline at end of file
Deleted: labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/extras/OOB-Actions/webservices_SOAP-httpClient_file_property_value.props
===================================================================
--- labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/extras/OOB-Actions/webservices_SOAP-httpClient_file_property_value.props 2011-03-02 18:06:58 UTC (rev 36772)
+++ labs/jbossesb/branches/JBESB_4_9_CP/product/docs/Programmers_Guide/en-US/extras/OOB-Actions/webservices_SOAP-httpClient_file_property_value.props 2011-03-03 13:56:45 UTC (rev 36773)
@@ -1,16 +0,0 @@
-# Configurators
-configurators=HttpProtocol,AuthBASIC
-
-# HttpProtocol config...
-protocol-socket-factory=org.apache.commons.httpclient.contrib.ssl.EasySSLProtocolSocketFactory
-keystore=/packages/jakarta-tomcat-5.0.28/conf/chap8.keystore
-keystore-passw=xxxxxx
-https.proxyHost=localhost
-https.proxyPort=443
-
-# AuthBASIC config...
-auth-username=tomcat
-auth-password=tomcat
-authscope-host=localhost
-authscope-port=18443
-authscope-realm=ActiveBPEL security realm
\ No newline at end of file
More information about the jboss-svn-commits
mailing list