[riftsaw-commits] riftsaw SVN: r1425 - trunk/docs/docbook/userguide/src/main/en-US/module.

Author: kurtstam Date: 2011-07-11 16:01:37 -0400 (Mon, 11 Jul 2011) New Revision: 1425 Modified: trunk/docs/docbook/userguide/src/main/en-US/module/uddi.xml Log: RIFTSAW-368 updating docs for jUDDI-3.1.0 Modified: trunk/docs/docbook/userguide/src/main/en-US/module/uddi.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/en-US/module/uddi.xml 2011-07-11 09:43:29 UTC (rev 1424) +++ trunk/docs/docbook/userguide/src/main/en-US/module/uddi.xml 2011-07-11 20:01:37 UTC (rev 1425) @@ -76,17 +76,17 @@ <entry>String (not used by default)</entry> <entry> Defines the path to the <filename>bpel.uddi.client.xml</filename> config file. This can be left commented out if - you want to use the <filename>jbossesb.sar/esb.uddi.client.xml</filename>. However in that case a + you want to use the <filename>riftsaw.sar/META-INF/riftsaw.uddi.xml</filename>. However in that case a <filename>bpel.uddi.clerk.manager</filename> needs to be defined. </entry> </row> <row> <entry>bpel.uddi.clerk.manager</entry> - <entry>String (esb-registry)</entry> + <entry>String (riftsaw-manager)</entry> <entry> Defines the ClerkManager name that will be used if the <emphasis>bpel.uddi.clerk.config</emphasis> is left commented out. - This value should correspond to the name of the manager - in the <filename>esb.juddi.client.xml</filename>. Note that if the <emphasis>bpel.uddi.clerk.config</emphasis> is defined, the + This value should correspond to the name of the manager + in the <filename>riftsaw.uddi.xml</filename>. Note that if the <emphasis>bpel.uddi.clerk.config</emphasis> is defined, the setting of the <emphasis>bpel.uddi.clerk.manager</emphasis> is ignored. </entry> </row> @@ -95,7 +95,7 @@ <entry>String (BPEL_clerk)</entry> <entry> Defines the Clerk name that will be used. This value should correspond to the name of the clerk - in the <filename>esb.juddi.client.xml</filename>. By default this is set to 'BPEL_clerk'. + in the <filename>riftsaw.uddi.xml</filename>. By default this is set to 'BPEL_clerk'. </entry> </row> <row> @@ -103,9 +103,10 @@ <entry>boolean (true)</entry> <entry> If set to true, the creating process of the partner channel will do a lookup by serviceName in the - UDDI, and a WSDL Endpoint is retrieved. This WSDL Endpoint is then used to obtain the WSDL. This - process makes it easier to move Endpoints around within your deployment, without having to update - the partnerlink WSDL files in your bpel deployments. Note that an it is still a requirement to + UDDI, and Endpoint(s) is retrieved. This process makes it easier to move process deployment around within your server farm, without having to update + the partnerlink WSDL files in your BPEL process deployments. If more then one EndPoint (BindingTemplate) is found default + policy the ServiceLocator uses a 'PolicyLocalFirst'. Please see the jUDDI v3 documentation for more + details and on how to switch to the 'PolicyRoundRobin' or a custom Policy. Note that it is still a requirement to deploy the initial partnerlink WSDL file for each partnerLink. </entry> </row> @@ -116,52 +117,66 @@ </section> <section> - <title>Default configurations</title> - <para>When RiftSaw is deployed to JBossAS-5.1.0, jUDDI v3 is not installed, and therefore + <title>Default UDDI integration configurations</title> + <para>When RiftSaw is deployed to JBossAS-5.1.0, jUDDI v3 is <emphasis>not</emphasis> installed, and therefore the UDDI integration is turned off (bpel.uddi.registration=false).</para> - <para>When RiftSaw is deployed to SOA-P-5.0.0 (or JBossESB 4.8 or higher) UDDI integration is + <para>When RiftSaw is deployed to SOA-P-5.1.0 (or JBossESB 4.10 or higher) UDDI integration is turned on and the <emphasis>bpel.uddi.client.impl</emphasis> is set to <emphasis>org.jboss.soa.bpel.uddi.UDDIRegistrationImpl</emphasis>. - The <filename>jbossesb.sar/esb.uddi.client.xml</filename> is used, with manager name 'esb.registry'. + The <filename>riftsaw.sar/META-INF/riftsaw.uddi.xml</filename> is used, with manager name 'riftsaw-manager'. </para> </section> <section> + <title>UDDI Registry Entities and UDDI Seed Data</title> + + <para>The jUDDI registry is seeded with initial setup data. The riftsaw install process adds 3 + seed files to the <filename>jbossesb-registry.sar/juddi_custom_install_data</filename> directory. The + files are <filename>riftsaw_Publisher.xml, riftsaw_BusinessEntity and riftsaw_tModels</filename>. + The seed data is loaded only if the registry is empty. Thus if you had already started jboss-esb before + installing riftsaw, you will need to clean the jUDDI database to trigger the loading of the newly added + seed data, or you can add the entities manually before starting riftsaw. Alternatively, in SOA-P-5.x, the + <filename>jbossesb-registry.sar/esb.juddi.xml</filename> contains a property + <emphasis>juddi.seed.always</emphasis> which can be set to "true". This means that that it + is always trying to load the root seed data on startup of the server. It is recommended + to turn this value to "false" once you are content with the UDDI Seed Data. + </para> + + </section> + + <section> + <title>UDDI Registration</title> + + <para>Upon deployment of a BPEL process, the process information is registered to the UDDI registry according + to the BPEL4WS OASIS technote (<ulink url="http://www.oasis-open.org/committees/uddi-spec/doc/tn/uddi-spec... BPEL4WS in a UDDI registry Technote</ulink>). + For more details please see the <ulink url="http://juddi.apache.org/docs/3.0/userguide/html/index.html"... v3 documentation</ulink>. + </para> + </section> + + <section> + <title>UDDI EndPoint Lookup</title> + + <para>If a BPEL service invokes another BPEL service or WebService EndPoint in general, Riftsaw performs + a lookup by serviceQName and portName (obtained from the WSDL). The result is stored in a client-side + ServiceCache. This ensures that the lookup is nice and fast. To prevent the client-side cache to return + stale information, the cache is automatically invalidated by the UDDI registry using the Subscription API + whenever changes occur in the registry. For more details please see the <ulink url="http://juddi.apache.org/docs/3.0/userguide/html/index.html"... v3 documentation</ulink>. + </para> + </section> + + <section> <title>Other UDDI v3 Registries</title> - <para>Other UDDI v3 compliant registries can be used, however the UDDIv3 spec only requires - communication using the UDDI WebServices. To set up SOAP based communication specify the JAXWS-Transport. - At this point it makes sense to no longer use the the esb.uddi.client.xml, but rather use your - own <emphasis>bpel.uddi.client.xml</emphasis>. For more details please see the jUDDI v3 documentation. + <para>Other UDDI v3 compliant registries can be used. The UDDIv3 spec requires + communication using the UDDI WebServices (rather than the InVM Transport used by default). + To set up SOAP based communication specify the JAXWS-Transport, + in the <filename>riftsaw.sar/META-INF/riftsaw.uddi.xml</filename> configuration + file. Note that when using JAXWS-Transport the UDDI server should be hosted out-of-process, as it must + be up during server startup and shutdown. For more details please see the <ulink url="http://juddi.apache.org/docs/3.0/userguide/html/index.html"... v3 documentation</ulink>. </para> </section> - <section> - <title>UDDI Registry Entities and UDDI Seed Data</title> - - <para>In the <filename>esb.uddi.client.xml</filename> a few properties are defined that are used by the Clerk at - registration time. These settings of these values can be customized, however they must - correspond to the UDDI seed data specified for the jbossesb publisher, in the - <filename>jbossesb-registry.sar/juddi_custom_install_data</filename>. So you will need to change it there as well. - </para> - - <para>The clerk is configured to use the jbossesb publisher and the <emphasis>keyDomain - </emphasis> is set to "esb.jboss.org". - </para> - - <para>The <emphasis>businessKey</emphasis> is set to "redhat-jboss".</para> - - <para>The <emphasis>serviceDescription</emphasis> is set to "BPEL Service deployed by Riftsaw".</para> - - <para>The <emphasis>bindingDescription</emphasis> is set to "BPEL Endpoint deployed by Riftsaw".</para> - - <para>Note that in SOA-P-5 the <filename>jbossesb-registry.sar/esb.uddi.xml</filename> contains a property - <emphasis>juddi.seed.always</emphasis> which is set to "true". This means that that it - is always trying to load the root seed data on startup of the server. It is recommended - to turn this value to "false" once you are content with the UDDI Seed Data. - </para> - - </section> - + + </chapter>